refactor: (GenAI) Reorganized Reasoning Engine Samples (Group С) (GoogleCloudPlatform#12613)

* Created new reasoning_engine folder and new Samples

* Try to pass tests

* Renamed files for clarify and preventing conflicts

* Fix comments and dependencies

Author: Thoughtseize1

generative_ai/reasoning_engine/create_reasoning_engine_advanced_example.py

@@ -0,0 +1,101 @@
+# Copyright 2024 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
+#
+#    https://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 typing import Dict, Union
+
+from vertexai.preview import reasoning_engines
+
+PROJECT_ID = os.getenv("GOOGLE_CLOUD_PROJECT")
+
+
+def create_reasoning_engine_advanced(
+    staging_bucket: str,
+) -> reasoning_engines.ReasoningEngine:
+    # [START generativeaionvertexai_create_reasoning_engine_advanced]
+
+    from typing import List
+
+    import vertexai
+    from vertexai.preview import reasoning_engines
+
+    # TODO(developer): Update and un-comment below lines
+    # PROJECT_ID = "your-project-id"
+    # staging_bucket = "gs://YOUR_BUCKET_NAME"
+
+    vertexai.init(
+        project=PROJECT_ID, location="us-central1", staging_bucket=staging_bucket
+    )
+
+    class LangchainApp:
+        def __init__(self, project: str, location: str) -> None:
+            self.project_id = project
+            self.location = location
+
+        def set_up(self) -> None:
+            from langchain_core.prompts import ChatPromptTemplate
+            from langchain_google_vertexai import ChatVertexAI
+
+            system = (
+                "You are a helpful assistant that answers questions "
+                "about Google Cloud."
+            )
+            human = "{text}"
+            prompt = ChatPromptTemplate.from_messages(
+                [("system", system), ("human", human)]
+            )
+            chat = ChatVertexAI(project=self.project_id, location=self.location)
+            self.chain = prompt | chat
+
+        def query(self, question: str) -> Union[str, List[Union[str, Dict]]]:
+            """Query the application.
+            Args:
+                question: The user prompt.
+            Returns:
+                str: The LLM response.
+            """
+            return self.chain.invoke({"text": question}).content
+
+    # Locally test
+    app = LangchainApp(project=PROJECT_ID, location="us-central1")
+    app.set_up()
+    print(app.query("What is Vertex AI?"))
+
+    # Create a remote app with Reasoning Engine
+    # Deployment of the app should take a few minutes to complete.
+    reasoning_engine = reasoning_engines.ReasoningEngine.create(
+        LangchainApp(project=PROJECT_ID, location="us-central1"),
+        requirements=[
+            "google-cloud-aiplatform[langchain,reasoningengine]",
+            "cloudpickle==3.0.0",
+            "pydantic==2.7.4",
+        ],
+        display_name="Demo LangChain App",
+        description="This is a simple LangChain app.",
+        # sys_version="3.10",  # Optional
+        extra_packages=[],
+    )
+    # Example response:
+    # Model_name will become a required arg for VertexAIEmbeddings starting...
+    # ...
+    # Create ReasoningEngine backing LRO: projects/123456789/locations/us-central1/reasoningEngines/...
+    # ReasoningEngine created. Resource name: projects/123456789/locations/us-central1/reasoningEngines/...
+    # ...
+
+    # [END generativeaionvertexai_create_reasoning_engine_advanced]
+    return reasoning_engine
+
+
+if __name__ == "__main__":
+    create_reasoning_engine_advanced("gs://your-bucket-unique-name")

generative_ai/reasoning_engine/create_reasoning_engine_example.py

@@ -0,0 +1,72 @@
+# Copyright 2024 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
+#
+#    https://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 vertexai.preview import reasoning_engines
+
+PROJECT_ID = os.getenv("GOOGLE_CLOUD_PROJECT")
+
+
+def create_reasoning_engine_basic(
+    staging_bucket: str,
+) -> reasoning_engines.ReasoningEngine:
+    # [START generativeaionvertexai_create_reasoning_engine_basic]
+    import vertexai
+    from vertexai.preview import reasoning_engines
+
+    # TODO(developer): Update and un-comment below lines
+    # PROJECT_ID = "your-project-id"
+    # staging_bucket = "gs://YOUR_BUCKET_NAME"
+    vertexai.init(
+        project=PROJECT_ID, location="us-central1", staging_bucket=staging_bucket
+    )
+
+    class SimpleAdditionApp:
+        def query(self, a: int, b: int) -> str:
+            """Query the application.
+            Args:
+                a: The first input number
+                b: The second input number
+            Returns:
+                int: The additional result.
+            """
+            return f"{int(a)} + {int(b)} is {int(a + b)}"
+
+    # Locally test
+    app = SimpleAdditionApp()
+    app.query(a=1, b=2)
+
+    # Create a remote app with Reasoning Engine.
+    # This may take 1-2 minutes to finish.
+    reasoning_engine = reasoning_engines.ReasoningEngine.create(
+        SimpleAdditionApp(),
+        display_name="Demo Addition App",
+        description="A simple demo addition app",
+        requirements=["cloudpickle==3"],
+        extra_packages=[],
+    )
+    # Example response:
+    # Using bucket YOUR_BUCKET_NAME
+    # Writing to gs://YOUR_BUCKET_NAME/reasoning_engine/reasoning_engine.pkl
+    # ...
+    # ReasoningEngine created. Resource name: projects/123456789/locations/us-central1/reasoningEngines/123456
+    # To use this ReasoningEngine in another session:
+    # reasoning_engine = vertexai.preview.reasoning_engines.ReasoningEngine('projects/123456789/locations/...
+
+    # [END generativeaionvertexai_create_reasoning_engine_basic]
+    return reasoning_engine
+
+
+if __name__ == "__main__":
+    create_reasoning_engine_basic("gs://your-bucket-unique-name")

generative_ai/reasoning_engine/delete_reasoning_engine_example.py

@@ -0,0 +1,40 @@
+# Copyright 2024 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
+#
+#    https://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
+
+PROJECT_ID = os.getenv("GOOGLE_CLOUD_PROJECT")
+
+
+def delete_reasoning_engine(reasoning_engine_id: str) -> None:
+    # [START generativeaionvertexai_delete_reasoning_engine]
+    import vertexai
+    from vertexai.preview import reasoning_engines
+
+    # TODO(developer): Update and un-comment below lines
+    # PROJECT_ID = "your-project-id"
+    # reasoning_engine_id = "1234567890123456"
+    vertexai.init(project=PROJECT_ID, location="us-central1")
+
+    reasoning_engine = reasoning_engines.ReasoningEngine(reasoning_engine_id)
+    reasoning_engine.delete()
+    # Example response:
+    # Deleting ReasoningEngine:projects/[PROJECT_ID]/locations/us-central1/reasoningEngines/1234567890123456
+    # ...
+    # ... resource projects/[PROJECT_ID]/locations/us-central1/reasoningEngines/1234567890123456 deleted.
+
+    # [END generativeaionvertexai_delete_reasoning_engine]
+
+
+if __name__ == "__main__":
+    delete_reasoning_engine("1234567890123456")

generative_ai/reasoning_engine/get_reasoning_engine_example.py

@@ -0,0 +1,42 @@
+# Copyright 2024 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
+#
+#    https://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 vertexai.preview import reasoning_engines
+
+PROJECT_ID = os.getenv("GOOGLE_CLOUD_PROJECT")
+
+
+def get_reasoning_engine(reasoning_engine_id: str) -> reasoning_engines.ReasoningEngine:
+    # [START generativeaionvertexai_get_reasoning_engine]
+    import vertexai
+    from vertexai.preview import reasoning_engines
+
+    # TODO(developer): Update and un-comment below lines
+    # PROJECT_ID = "your-project-id"
+    # reasoning_engine_id = "1234567890123456"
+    vertexai.init(project=PROJECT_ID, location="us-central1")
+
+    reasoning_engine = reasoning_engines.ReasoningEngine(reasoning_engine_id)
+    print(reasoning_engine)
+    # Example response:
+    # <vertexai.reasoning_engines._reasoning_engines.ReasoningEngine object at 0x757999a63c40>
+    # resource name: projects/[PROJECT_ID]/locations/us-central1/reasoningEngines/1234567890123456
+
+    # [END generativeaionvertexai_get_reasoning_engine]
+    return reasoning_engine
+
+
+if __name__ == "__main__":
+    get_reasoning_engine("1234567890123456")

generative_ai/reasoning_engine/list_reasoning_engine_example.py

@@ -0,0 +1,45 @@
+# Copyright 2024 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
+#
+#    https://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 typing import List
+
+from vertexai.preview import reasoning_engines
+
+PROJECT_ID = os.getenv("GOOGLE_CLOUD_PROJECT")
+
+
+def list_reasoning_engines() -> List[reasoning_engines.ReasoningEngine]:
+    # [START generativeaionvertexai_list_reasoning_engines]
+    import vertexai
+    from vertexai.preview import reasoning_engines
+
+    # TODO(developer): Update and un-comment below line
+    # PROJECT_ID = "your-project-id"
+    vertexai.init(project=PROJECT_ID, location="us-central1")
+
+    reasoning_engine_list = reasoning_engines.ReasoningEngine.list()
+    print(reasoning_engine_list)
+    # Example response:
+    # [<vertexai.reasoning_engines._reasoning_engines.ReasoningEngine object at 0x71a0e5cb99c0>
+    # resource name: projects/123456789/locations/us-central1/reasoningEngines/111111111111111111,
+    # <vertexai.reasoning_engines._reasoning_engines.ReasoningEngine object at 0x71a0e5cbac80>
+    # resource name: projects/123456789/locations/us-central1/reasoningEngines/222222222222222222]
+
+    # [END generativeaionvertexai_list_reasoning_engines]
+    return reasoning_engine_list
+
+
+if __name__ == "__main__":
+    list_reasoning_engines()

generative_ai/reasoning_engine/query_reasoning_engine_example.py

@@ -0,0 +1,41 @@
+# Copyright 2024 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
+#
+#    https://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
+
+PROJECT_ID = os.getenv("GOOGLE_CLOUD_PROJECT")
+
+
+def query_reasoning_engine(reasoning_engine_id: str) -> object:
+    # [START generativeaionvertexai_query_reasoning_engine]
+    import vertexai
+    from vertexai.preview import reasoning_engines
+
+    # TODO(developer): Update and un-comment below lines
+    # PROJECT_ID = "your-project-id"
+    # reasoning_engine_id = "1234567890123456"
+    vertexai.init(project=PROJECT_ID, location="us-central1")
+    reasoning_engine = reasoning_engines.ReasoningEngine(reasoning_engine_id)
+
+    # Replace with kwargs for `.query()` method.
+    response = reasoning_engine.query(a=1, b=2)
+    print(response)
+    # Example response:
+    # 1 + 2 is 3
+
+    # [END generativeaionvertexai_query_reasoning_engine]
+    return response
+
+
+if __name__ == "__main__":
+    query_reasoning_engine("1234567890123456")