Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

basic python search example for docs #13119

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

basic python search example for docs #13119

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
02d26e0
basic python search example for docs
EricDLarson Jan 31, 2025
00f09cb
basic python search example for docs
EricDLarson Jan 31, 2025
f9efe40
Merge branch 'retail-python' of github.com:EricDLarson/python-docs-sa…
EricDLarson Jan 31, 2025
58ee105
Update retail/doc-samples/search.py
EricDLarson Feb 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions retail/doc-samples/search.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
// 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.

from google.cloud import retail_v2

def search_products(project_id, catalog_id, placement_id, branch, visitor_id, query):
client = retail_v2.SearchServiceClient()

placement_name = retail_v2.SearchServiceClient.placement_path(
project_id, location='global', catalog=catalog_id, placement=placement_id
)

search_request = retail_v2.SearchRequest(
placement=placement_name,
branch=branch,
visitor_id=visitor_id,
query=query,
page_size=10
)

response = client.search(search_request)

print(f"Search response: {response}")

return response

# Example usage
project_id = 'YOUR_PROJECT_ID'
catalog_id = 'YOUR_CATALOG_ID'
placement_id = 'YOUR_PLACEMENT_ID'
branch = 'YOUR_BRANCH_NAME'
visitor_id = 'YOUR_VISITOR_ID'
query = 'YOUR_QUERY'

search_products(project_id, catalog_id, placement_id, branch, visitor_id, query)
Comment on lines +38 to +46
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sample does not match our styleguide, particularly with respect to testing: https://googlecloudplatform.github.io/samples-style-guide/#testing

You will need to also add a region tag around the part of the code you want to include in the documentation.

I would also suggest you move this sample to a different folder, as doc-samples isn't very clear. I would suggest retail/snippets/search_request.py, and you can then create retail/snippets/search_request_test.py for the test. You can also use this folder for future samples with a shared requirements.txt another configs (which you have also missed)