-
Notifications
You must be signed in to change notification settings - Fork 6.5k
basic python search example for docs #13119
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.
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
Open
EricDLarson
wants to merge
4
commits into
GoogleCloudPlatform:main
Choose a base branch
from
EricDLarson:retail-python
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
02d26e0
basic python search example for docs
EricDLarson 00f09cb
basic python search example for docs
EricDLarson f9efe40
Merge branch 'retail-python' of github.com:EricDLarson/python-docs-sa…
EricDLarson 58ee105
Update retail/doc-samples/search.py
EricDLarson File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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 suggestretail/snippets/search_request.py
, and you can then createretail/snippets/search_request_test.py
for the test. You can also use this folder for future samples with a sharedrequirements.txt
another configs (which you have also missed)