docs(samples): Add Vertex AI Text Prompt Sample

holtskinner · holtskinner · commit 4c3c039370c6 · 2023-11-01T11:19:31.000-05:00
diff --git a/google-cloud-ai_platform/samples/Gemfile b/google-cloud-ai_platform/samples/Gemfile
@@ -0,0 +1,27 @@
+# Copyright 2023 Google, Inc
+#
+# 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.
+
+source "https://rubygems.org"
+
+master = ENV["GOOGLE_CLOUD_SAMPLES_TEST"] == "master"
+
+gem "google-cloud-ai_platform", path: master ? "../../google-cloud-ai_platform" : nil
+
+group :test do
+  gem "google-style", "~> 1.26.2"
+  gem "minitest", "~> 5.17"
+  gem "minitest-focus", "~> 1.4"
+  gem "minitest-rg", "~> 5.2"
+  gem "rake"
+end
diff --git a/google-cloud-ai_platform/samples/Rakefile b/google-cloud-ai_platform/samples/Rakefile
@@ -0,0 +1,23 @@
+# 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.
+
+require "rake/testtask"
+require "rubocop/rake_task"
+
+Rake::TestTask.new "test" do |t|
+  t.test_files = FileList["acceptance/*_test.rb"]
+  t.warning = false
+end
+
+RuboCop::RakeTask.new
diff --git a/google-cloud-ai_platform/samples/acceptance/quickstart_test.rb b/google-cloud-ai_platform/samples/acceptance/quickstart_test.rb
@@ -0,0 +1,36 @@
+# Copyright 2023 Google, Inc
+#
+# 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.
+
+require "google/cloud/ai_platform"
+
+require "minitest/autorun"
+require "minitest/focus"
+require "minitest/rg"
+
+require_relative "../../../.toys/.lib/sample_loader"
+
+describe "Vertex AI Quickstart" do
+  let(:project_id) { ENV["GOOGLE_CLOUD_PROJECT"] || raise("missing GOOGLE_CLOUD_PROJECT") }
+  let(:location_id) { "us-central1" }
+  let(:publisher) { "google" }
+  let(:model) { "text-bison@001" }
+
+  it "generates text" do
+    sample = SampleLoader.load "quickstart.rb"
+
+    assert_output(/\S/) do
+      sample.run project_id: project_id, location_id: location_id, publisher: publisher, model: model
+    end
+  end
+end
diff --git a/google-cloud-ai_platform/samples/quickstart.rb b/google-cloud-ai_platform/samples/quickstart.rb
@@ -0,0 +1,74 @@
+# 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 aiplatform_sdk_ideation]
+require "google/cloud/ai_platform"
+
+##
+# Vertex AI Predict Text Prompt
+#
+# @param project_id [String] Your Google Cloud project (e.g. "my-project")
+# @param location_id [String] Your Processor Location (e.g. "us-central1")
+# @param publisher [String] The Model Publisher (e.g. "google")
+# @param model [String] The Model Identifier (e.g. "text-bison@001")
+#
+def predict_text_prompt project_id:, location_id:, publisher:, model:
+  # Create the Vertex AI client.
+  client = ::Google::Cloud::AIPlatform::V1::PredictionService::Client.new do |config|
+  config.endpoint = "#{location_id}-aiplatform.googleapis.com"
+  end
+
+  # Build the resource name from the project.
+  endpoint = client.endpoint_path(
+    project: project_id,
+    location: location_id,
+    publisher: publisher,
+    model: model
+  )
+
+  prompt = "Give me ten interview questions for the role of program manager."
+
+  # Initialize the request arguments
+  instance = Google::Protobuf::Value.new(
+    struct_value: Google::Protobuf::Struct.new(
+      fields: {
+        "prompt" => Google::Protobuf::Value.new(
+          string_value: prompt
+        )
+      }
+    )
+  )
+
+  instances = [instance]
+
+  parameters = Google::Protobuf::Value.new(
+    struct_value: Google::Protobuf::Struct.new(
+      fields: {
+        "temperature" => Google::Protobuf::Value.new(number_value: 0.2),
+        "maxOutputTokens" => Google::Protobuf::Value.new(number_value: 256),
+        "topP" => Google::Protobuf::Value.new(number_value: 0.95),
+        "topK" => Google::Protobuf::Value.new(number_value: 40)
+      }
+    )
+  )
+  
+  # Make the prediction request
+  response = client.predict(endpoint: endpoint, instances: [instances], parameters: parameters)
+
+  # Handle the prediction response
+  puts "Predict Response"
+  puts response
+  return response
+end
+# [END aiplatform_sdk_ideation]
diff --git a/google-cloud-ai_platform/test/README.md b/google-cloud-ai_platform/test/README.md
@@ -0,0 +1,47 @@
+# Google Vertex AI API Samples
+
+Vertex AI offers everything you need to build and use generative AI—from AI solutions, to Search and Conversation, to 100+ foundation models, to a unified AI platform.
+
+## Description
+
+These samples show how to use the [Google Vertex AI API](https://cloud.google.com/vertex-ai/).
+
+## Build and Run
+1.  **Enable APIs** - [Enable the Vertex AI API](https://console.cloud.google.com/flows/enableapi?apiid=aiplatform.googleapis.com)
+    and create a new project or select an existing project.
+
+1.  **Install and Initialize Cloud SDK**
+    Follow instructions from the available [quickstarts](https://cloud.google.com/sdk/docs/quickstarts)
+
+1.  **Clone the repo** and cd into this directory
+
+    ```text
+    git clone https://github.com/googleapis/google-cloud-ruby.git
+    $ cd google-cloud-ruby/google-cloud-ai_platform
+    ```
+
+1. **Install Dependencies** via [Bundler](https://bundler.io).
+
+    ```text
+    $ bundle install
+    ```
+
+1. **Set Environment Variables**
+
+    ```text
+    $ export GOOGLE_CLOUD_PROJECT="YOUR_PROJECT_ID"
+    ```
+
+1. **Run samples**
+
+    ```text
+    bundle exec rake test
+    ```
+
+## Contributing changes
+
+* See [CONTRIBUTING.md](../CONTRIBUTING.md)
+
+## Licensing
+
+* See [LICENSE](../LICENSE)
