GoogleCloudPlatform · rsamborski · Oct 2, 2023 · Mar 3, 2023 · Mar 3, 2023 · Mar 16, 2023
@@ -0,0 +1,85 @@
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+
+# [START contentwarehouse_create_document]
+
+from typing import Optional
+
+from google.cloud import contentwarehouse
+
+
+def sample_create_document(
+    project_number: str,
+    location: str,
+    raw_document_path: str,
+    raw_document_file_type: contentwarehouse.RawDocumentFileType,
+    document_schema_id: str,
+    user_id: str,
+    reference_id: Optional[str] = None,
+) -> contentwarehouse.CreateDocumentResponse:
+    """Creates a document.
+
+    Args:
+        project_number: Google Cloud project number.
+        location: Google Cloud project location.
+        raw_document_path: Raw document file in Cloud Storage path.
+        raw_document_file_type: Document file type
+                                https://cloud.google.com/python/docs/
+                                reference/contentwarehouse/latest/
+                                google.cloud.contentwarehouse_v1.types.RawDocumentFileType.
+        document_schema_id: Unique identifier for document schema.
+        user_id: user:YOUR_SERVICE_ACCOUNT_ID or user:USER_EMAIL.
+        reference_id: Identifier, must be unique per project and location.
+    Returns:
+        Response object.
+    """
+    # Create a Document Service client
+    client = contentwarehouse.DocumentServiceClient()
+
+    # Get document schema name
+    document_schema_name = client.document_schema_path(
+        project=project_number, location=location, document_schema=document_schema_id
+    )
+
+    # Initialize request argument(s)
+    document = contentwarehouse.Document(
+        raw_document_path=raw_document_path,
+        display_name="Order Invoice",
+        plain_text="Sample Invoice Document",
+        raw_document_file_type=raw_document_file_type,
+        document_schema_name=document_schema_name,
+        reference_id=reference_id,
+    )
+
+    request_metadata = contentwarehouse.RequestMetadata(
+        user_info=contentwarehouse.UserInfo(id=user_id)
+    )
+
+    parent = client.common_location_path(project=project_number, location=location)
+
+    request = contentwarehouse.CreateDocumentRequest(
+        parent=parent,
+        request_metadata=request_metadata,
+        document=document,
+    )
+
+    # Make the request
+    response = client.create_document(request=request)
+
+    return response
+
+
+# [END contentwarehouse_create_document]
@@ -0,0 +1,134 @@
+# # Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+import os
+
+from contentwarehouse.snippets import create_document_sample
+from contentwarehouse.snippets import create_document_schema_sample
+from contentwarehouse.snippets import delete_document_sample
+from contentwarehouse.snippets import delete_document_schema_sample
+from contentwarehouse.snippets import get_document_sample
+from contentwarehouse.snippets import test_utilities
+from contentwarehouse.snippets import update_document_sample
+from google.cloud import contentwarehouse
+from google.cloud.contentwarehouse import Document
+
+import pytest
+
+project_id = os.environ["GOOGLE_CLOUD_PROJECT"]
+location = "us"
+raw_document_path = (
+    "gs://cloud-samples-data/documentai/codelabs/warehouse/order-invoice.pdf"
+)
+raw_document_file_type = contentwarehouse.RawDocumentFileType.RAW_DOCUMENT_FILE_TYPE_PDF
+user_id = os.environ["user_id"]
+reference_id = "001"
+
+
+@pytest.mark.dependency(name="create_schema")
+def test_create_document_schema(request: pytest.fixture) -> None:
+    project_number = test_utilities.get_project_number(project_id)
+
+    response = create_document_schema_sample.sample_create_document_schema(
+        project_number=project_number, location=location
+    )
+
+    assert "display_name" in response
+
+    document_schema_id = response.name.split("/")[-1]
+
+    request.config.cache.set("document_schema_id", document_schema_id)
+
+
+@pytest.mark.dependency(name="create_doc", depends=["create_schema"])
+def test_create_document(request: pytest.fixture) -> None:
+    project_number = test_utilities.get_project_number(project_id)
+
+    document_schema_id = request.config.cache.get("document_schema_id", None)
+
+    response = create_document_sample.sample_create_document(
+        project_number=project_number,
+        location=location,
+        raw_document_path=raw_document_path,
+        raw_document_file_type=raw_document_file_type,
+        document_schema_id=document_schema_id,
+        user_id=user_id,
+        reference_id=reference_id,
+    )
+
+    assert "document" in response
+
+    request.config.cache.set("document_name", response.document.name)
+
+
+@pytest.mark.dependency(name="get_doc", depends=["create_doc"])
+def test_get_document(request: pytest.fixture) -> None:
+    document_name = request.config.cache.get("document_name", None)
+
+    response = get_document_sample.sample_get_document(
+        document_name=document_name, user_id=user_id
+    )
+
+    assert "name" in response
+    request.config.cache.set(
+        "document",
+        Document.to_json(
+            response,
+            including_default_value_fields=False,
+            preserving_proto_field_name=False,
+        ),
+    )
+
+
+@pytest.mark.dependency(name="update_doc", depends=["get_doc"])
+def test_update_document(request: pytest.fixture) -> None:
+    document_name = request.config.cache.get("document_name", None)
+    document_json = request.config.cache.get("document", None)
+
+    document = Document.from_json(document_json)
+
+    response = update_document_sample.sample_update_document(
+        document_name=document_name,
+        document=document,
+        user_id=user_id,
+    )
+
+    assert "document" in response
+
+
+@pytest.mark.dependency(name="delete_doc", depends=["update_doc"])
+def test_delete_document(request: pytest.fixture) -> None:
+    document_name = request.config.cache.get("document_name", None)
+
+    response = delete_document_sample.sample_delete_document(
+        document_name=document_name, user_id=user_id
+    )
+
+    assert response is None
+
+
+@pytest.mark.dependency(name="delete_schema", depends=["delete_doc"])
+def test_delete_document_schema(request: pytest.fixture) -> None:
+    project_number = test_utilities.get_project_number(project_id)
+
+    document_schema_id = request.config.cache.get("document_schema_id", None)
+
+    response = delete_document_schema_sample.sample_delete_document_schema(
+        project_number=project_number,
+        location=location,
+        document_schema_id=document_schema_id,
+    )
+
+    assert response is None
@@ -0,0 +1,52 @@
+# # Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+
+# [START contentwarehouse_delete_document]
+
+from google.cloud import contentwarehouse
+
+
+def sample_delete_document(document_name: str, user_id: str) -> None:
+    """Deletes a document.
+
+    Args:
+        document_name: The resource name of the document.
+                    Format: 'projects/{project_number}/
+                    locations/{location}/documents/{document_id}'.
+        user_id: user:YOUR_SERVICE_ACCOUNT_ID or user:USER_EMAIL.
+    Returns:
+        None, if operation is successful.
+    """
+
+    # Create a client
+    client = contentwarehouse.DocumentServiceClient()
+
+    request_metadata = contentwarehouse.RequestMetadata(
+        user_info=contentwarehouse.UserInfo(id=user_id)
+    )
+
+    # Initialize request argument(s)
+    request = contentwarehouse.DeleteDocumentRequest(
+        name=document_name, request_metadata=request_metadata
+    )
+
+    # Make the request
+    response = client.delete_document(request=request)
+
+    return response
+
+
+# [END contentwarehouse_delete_document]
@@ -0,0 +1,51 @@
+# # Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+
+# [START contentwarehouse_get_document]
+
+from google.cloud import contentwarehouse
+
+
+def sample_get_document(document_name: str, user_id: str) -> contentwarehouse.Document:
+    """Gets a document.
+
+    Args:
+        document_name: The resource name of the document.
+                Format: 'projects/{project_number}/
+                locations/{location}/documents/{document_id}'.
+        user_id: user:YOUR_SERVICE_ACCOUNT_ID or user:USER_EMAIL.
+    Returns:
+        Response object
+    """
+    # Create a client
+    client = contentwarehouse.DocumentServiceClient()
+
+    request_metadata = contentwarehouse.RequestMetadata(
+        user_info=contentwarehouse.UserInfo(id=user_id)
+    )
+
+    # Initialize request argument(s)
+    request = contentwarehouse.GetDocumentRequest(
+        name=document_name, request_metadata=request_metadata
+    )
+
+    # Make the request
+    response = client.get_document(request=request)
+
+    return response
+
+
+# [END contentwarehouse_get_document]
@@ -0,0 +1,59 @@
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+
+# [START contentwarehouse_update_document]
+
+from google.cloud import contentwarehouse
+
+
+def sample_update_document(
+    document_name: str, document: contentwarehouse.Document, user_id: str
+) -> contentwarehouse.CreateDocumentResponse:
+    """Updates a document.
+
+    Args:
+        document_name: The resource name of the document.
+                    Format: 'projects/{project_number}/
+                    locations/{location}/documents/{document_id}'.
+        document: Document AI Warehouse Document object..
+        user_id: user_id: user:YOUR_SERVICE_ACCOUNT_ID or user:USER_EMAIL.
+    Returns:
+        Response object.
+    """
+    # Create a client
+    client = contentwarehouse.DocumentServiceClient()
+
+    # Update document fields
+    # For fields which can be updated, refer
+    # https://cloud.google.com/python/docs/reference/contentwarehouse/
+    # latest/google.cloud.contentwarehouse_v1.types.Document
+    document.display_name = "Updated Order Invoice"
+
+    request_metadata = contentwarehouse.RequestMetadata(
+        user_info=contentwarehouse.UserInfo(id=user_id)
+    )
+
+    request = contentwarehouse.UpdateDocumentRequest(
+        name=document_name, document=document, request_metadata=request_metadata
+    )
+
+    # Make the request
+    response = client.update_document(request=request)
+
+    return response
+
+
+# [END contentwarehouse_update_document]