docs(genai): Text Embedding Sample for Gen AI SDK

genai/embeddings/embed_content_text.py

@@ -0,0 +1,45 @@
+# Copyright 2025 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.
+
+
+def embed_content() -> str:
+    # [START googlegenaisdk_embeddings_docretrieval_with_txt]
+    from google import genai
+    from google.genai.types import EmbedContentConfig
+
+    client = genai.Client()
+    response = client.models.embed_content(
+        model="text-embedding-005",
+        contents=[
+            "How do I get a driver's license/learner's permit?",
+            "How do I renew my driver's license?",
+            "How do I change my address on my driver's license?",
+        ],
+        config=EmbedContentConfig(
+            task_type="RETRIEVAL_DOCUMENT",  # Optional
+            output_dimensionality=768,  # Optional
+            title="Driver's License",  # Optional
+        ),
+    )
+    print(response)
+    # Example response:
+    # embeddings=[ContentEmbedding(values=[-0.06302902102470398, 0.00928034819662571, 0.014716853387653828, -0.028747491538524628, ... ],
+    # statistics=ContentEmbeddingStatistics(truncated=False, token_count=13.0))]
+    # metadata=EmbedContentMetadata(billable_character_count=112)
+    # [END googlegenaisdk_embeddings_docretrieval_with_txt]
+    return response
+
+
+if __name__ == "__main__":
+    embed_content()

genai/embeddings/embeddings_docretrieval_with_txt.py

@@ -0,0 +1,45 @@
+# Copyright 2025 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.
+
+
+def embed_content() -> str:
+    # [START googlegenaisdk_embeddings_docretrieval_with_txt]
+    from google import genai
+    from google.genai.types import EmbedContentConfig
+
+    client = genai.Client()
+    response = client.models.embed_content(
+        model="text-embedding-005",
+        contents=[
+            "How do I get a driver's license/learner's permit?",
+            "How do I renew my driver's license?",
+            "How do I change my address on my driver's license?",
+        ],
+        config=EmbedContentConfig(
+            task_type="RETRIEVAL_DOCUMENT",  # Optional
+            output_dimensionality=768,  # Optional
+            title="Driver's License",  # Optional
+        ),
+    )
+    print(response)
+    # Example response:
+    # embeddings=[ContentEmbedding(values=[-0.06302902102470398, 0.00928034819662571, 0.014716853387653828, -0.028747491538524628, ... ],
+    # statistics=ContentEmbeddingStatistics(truncated=False, token_count=13.0))]
+    # metadata=EmbedContentMetadata(billable_character_count=112)
+    # [END googlegenaisdk_embeddings_docretrieval_with_txt]
+    return response
+
+
+if __name__ == "__main__":
+    embed_content()

genai/embeddings/noxfile_config.py

@@ -0,0 +1,42 @@
+# Copyright 2021 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.
+
+# Default TEST_CONFIG_OVERRIDE for python repos.
+
+# You can copy this file into your directory, then it will be imported from
+# the noxfile.py.
+
+# The source of truth:
+# https://github.com/GoogleCloudPlatform/python-docs-samples/blob/main/noxfile_config.py
+
+TEST_CONFIG_OVERRIDE = {
+    # You can opt out from the test for specific Python versions.
+    "ignored_versions": ["2.7", "3.7", "3.8", "3.10", "3.11", "3.13"],
+    # Old samples are opted out of enforcing Python type hints
+    # All new samples should feature them
+    "enforce_type_hints": True,
+    # An envvar key for determining the project id to use. Change it
+    # to 'BUILD_SPECIFIC_GCLOUD_PROJECT' if you want to opt in using a
+    # build specific Cloud project. You can also use your own string
+    # to use your own Cloud project.
+    "gcloud_project_env": "GOOGLE_CLOUD_PROJECT",
+    # 'gcloud_project_env': 'BUILD_SPECIFIC_GCLOUD_PROJECT',
+    # If you need to use a specific version of pip,
+    # change pip_version_override to the string representation
+    # of the version number, for example, "20.2.4"
+    "pip_version_override": None,
+    # A dictionary you want to inject into your test. Don't put any
+    # secrets here. These values will override predefined values.
+    "envs": {},
+}

genai/embeddings/requirements-test.txt

@@ -0,0 +1,2 @@
+google-api-core==2.24.0
+pytest==8.2.0

genai/embeddings/requirements.txt

@@ -0,0 +1 @@
+google-genai==1.2.0

genai/embeddings/test_embeddings_examples.py

@@ -0,0 +1,31 @@
+# Copyright 2025 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.
+
+#
+# Using Google Cloud Vertex AI to test the code samples.
+#
+
+import os
+
+import embeddings_docretrieval_with_txt
+
+os.environ["GOOGLE_GENAI_USE_VERTEXAI"] = "True"
+os.environ["GOOGLE_CLOUD_LOCATION"] = "us-central1"
+# The project name is included in the CICD pipeline
+# os.environ['GOOGLE_CLOUD_PROJECT'] = "add-your-project-name"
+
+
+def test_embeddings_docretrieval_with_txt() -> None:
+    response = embeddings_docretrieval_with_txt.embed_content()
+    assert response