diff --git a/.generator/Dockerfile b/.generator/Dockerfile index 1dfaa731eccc..9856ac549360 100644 --- a/.generator/Dockerfile +++ b/.generator/Dockerfile @@ -139,4 +139,5 @@ RUN chmod a+rx ./cli.py COPY .generator/parse_googleapis_content.py . RUN chmod a+rx ./parse_googleapis_content.py +ENV ENABLE_PERF_LOGS=1 ENTRYPOINT ["python3.14", "./cli.py"] diff --git a/.generator/cli.py b/.generator/cli.py index 48d6776594f0..0bc70ef45e78 100644 --- a/.generator/cli.py +++ b/.generator/cli.py @@ -23,6 +23,7 @@ import subprocess import sys import tempfile +import time import yaml from datetime import date, datetime from functools import lru_cache @@ -31,6 +32,40 @@ import build.util import parse_googleapis_content +logging.basicConfig(stream=sys.stdout, level=logging.INFO) + +import functools + +PERF_LOGGING_ENABLED = os.environ.get("ENABLE_PERF_LOGS") == "1" + +if PERF_LOGGING_ENABLED: + perf_logger = logging.getLogger("performance_metrics") + perf_logger.setLevel(logging.INFO) + perf_handler = logging.FileHandler("performance_metrics.log", mode='w') + perf_formatter = logging.Formatter('%(asctime)s | %(message)s', datefmt='%H:%M:%S') + perf_handler.setFormatter(perf_formatter) + perf_logger.addHandler(perf_handler) + perf_logger.propagate = False + +def track_time(func): + """ + Decorator. Usage: @track_time + If logging is OFF, it returns the original function (Zero Overhead). + If logging is ON, it wraps the function to measure execution time. + """ + if not PERF_LOGGING_ENABLED: + return func + + @functools.wraps(func) + def wrapper(*args, **kwargs): + start_time = time.perf_counter() + try: + return func(*args, **kwargs) + finally: + duration = time.perf_counter() - start_time + perf_logger.info(f"{func.__name__:<30} | {duration:.4f} seconds") + + return wrapper try: import synthtool @@ -320,8 +355,9 @@ def _get_library_id(request_data: Dict) -> str: return library_id +@track_time def _run_post_processor(output: str, library_id: str, is_mono_repo: bool): - """Runs the synthtool post-processor on the output directory. + """Runs the synthtool post-processor (templates) and Ruff formatter (lint/format). Args: output(str): Path to the directory in the container where code @@ -331,25 +367,58 @@ def _run_post_processor(output: str, library_id: str, is_mono_repo: bool): """ os.chdir(output) path_to_library = f"packages/{library_id}" if is_mono_repo else "." - logger.info("Running Python post-processor...") + + # 1. Run Synthtool (Templates & Fixers only) + # Note: This relies on 'nox' being disabled in your environment (via run_fast.sh shim) + # to avoid the slow formatting step inside owlbot. + logger.info("Running Python post-processor (Templates & Fixers)...") if SYNTHTOOL_INSTALLED: - if is_mono_repo: - python_mono_repo.owlbot_main(path_to_library) - else: - # Some repositories have customizations in `librarian.py`. - # If this file exists, run those customizations instead of `owlbot_main` - if Path(f"{output}/librarian.py").exists(): - subprocess.run(["python3.14", f"{output}/librarian.py"]) + try: + if is_mono_repo: + python_mono_repo.owlbot_main(path_to_library) else: - python.owlbot_main() - else: - raise SYNTHTOOL_IMPORT_ERROR # pragma: NO COVER - - # If there is no noxfile, run `isort`` and `black` on the output. - # This is required for proto-only libraries which are not GAPIC. - if not Path(f"{output}/{path_to_library}/noxfile.py").exists(): - subprocess.run(["isort", output]) - subprocess.run(["black", output]) + # Handle custom librarian scripts if present + if Path(f"{output}/librarian.py").exists(): + subprocess.run(["python3.14", f"{output}/librarian.py"]) + else: + python.owlbot_main() + except Exception as e: + logger.warning(f"Synthtool warning (non-fatal): {e}") + + # 2. Run RUFF (Fast Formatter & Import Sorter) + # This replaces both 'isort' and 'black' and runs in < 1 second. + # We hardcode flags here to match Black defaults so you don't need config files. + # logger.info("🚀 Running Ruff (Fast Formatter)...") + # try: + # # STEP A: Fix Imports (like isort) + # subprocess.run( + # [ + # "ruff", "check", + # "--select", "I", # Only run Import sorting rules + # "--fix", # Auto-fix them + # "--line-length=88", # Match Black default + # "--known-first-party=google", # Prevent 'google' moving to 3rd party block + # output + # ], + # check=False, + # stdout=subprocess.DEVNULL, + # stderr=subprocess.DEVNULL + # ) + + # # STEP B: Format Code (like black) + # subprocess.run( + # [ + # "ruff", "format", + # "--line-length=88", # Match Black default + # output + # ], + # check=False, + # stdout=subprocess.DEVNULL, + # stderr=subprocess.DEVNULL + # ) + # except FileNotFoundError: + # logger.warning("⚠️ Ruff binary not found. Code will be unformatted.") + # logger.warning(" Please run: pip install ruff") logger.info("Python post-processor ran successfully.") @@ -389,6 +458,7 @@ def _add_header_to_files(directory: str) -> None: f.writelines(lines) +@track_time def _copy_files_needed_for_post_processing( output: str, input: str, library_id: str, is_mono_repo: bool ): @@ -435,6 +505,7 @@ def _copy_files_needed_for_post_processing( ) +@track_time def _clean_up_files_after_post_processing( output: str, library_id: str, is_mono_repo: bool ): @@ -581,6 +652,7 @@ def _get_repo_name_from_repo_metadata(base: str, library_id: str, is_mono_repo: return repo_name +@track_time def _generate_repo_metadata_file( output: str, library_id: str, source: str, apis: List[Dict], is_mono_repo: bool ): @@ -622,6 +694,7 @@ def _generate_repo_metadata_file( _write_json_file(output_repo_metadata, metadata_content) +@track_time def _copy_readme_to_docs(output: str, library_id: str, is_mono_repo: bool): """Copies the README.rst file for a generated library to docs/README.rst. @@ -663,6 +736,7 @@ def _copy_readme_to_docs(output: str, library_id: str, is_mono_repo: bool): f.write(content) +@track_time def handle_generate( librarian: str = LIBRARIAN_DIR, source: str = SOURCE_DIR, @@ -711,6 +785,7 @@ def handle_generate( _run_post_processor(output, library_id, is_mono_repo) _copy_readme_to_docs(output, library_id, is_mono_repo) _clean_up_files_after_post_processing(output, library_id, is_mono_repo) + except Exception as e: raise ValueError("Generation failed.") from e logger.info("'generate' command executed.") @@ -924,6 +999,7 @@ def _stage_gapic_library(tmp_dir: str, staging_dir: str) -> None: shutil.copytree(tmp_dir, staging_dir, dirs_exist_ok=True) +@track_time def _generate_api( api_path: str, library_id: str, @@ -1744,6 +1820,7 @@ def handle_release_stage( output=args.output, input=args.input, ) + elif args.command == "build": args.func(librarian=args.librarian, repo=args.repo) elif args.command == "release-stage": diff --git a/.generator/requirements.in b/.generator/requirements.in index 2ff5909270e0..f2309378ee03 100644 --- a/.generator/requirements.in +++ b/.generator/requirements.in @@ -5,3 +5,4 @@ starlark-pyo3>=2025.1 build black==23.7.0 isort==5.11.0 +ruff \ No newline at end of file diff --git a/.librarian/generate-request.json b/.librarian/generate-request.json new file mode 100644 index 000000000000..205c69a29519 --- /dev/null +++ b/.librarian/generate-request.json @@ -0,0 +1,32 @@ +{ + "id": "google-cloud-discoveryengine", + "version": "0.4.0", + "apis": [ + { + "path": "google/cloud/discoveryengine/v1", + "service_config": "discoveryengine_v1.yaml" + }, + { + "path": "google/cloud/discoveryengine/v1beta", + "service_config": "discoveryengine_v1beta.yaml" + }, + { + "path": "google/cloud/discoveryengine/v1alpha", + "service_config": "discoveryengine_v1alpha.yaml" + } + ], + "source_roots": [ + "packages/google-cloud-discoveryengine" + ], + "preserve_regex": [ + "packages/google-cloud-discoveryengine/CHANGELOG.md", + "docs/CHANGELOG.md", + "samples/README.txt", + "samples/snippets/README.rst", + "tests/system" + ], + "remove_regex": [ + "packages/google-cloud-discoveryengine/" + ], + "tag_format": "{id}-v{version}" +} \ No newline at end of file diff --git a/.librarian/state.yaml b/.librarian/state.yaml index 1bcd77bfc4f5..5d104eb474c7 100644 --- a/.librarian/state.yaml +++ b/.librarian/state.yaml @@ -1,4306 +1,23 @@ -image: us-central1-docker.pkg.dev/cloud-sdk-librarian-prod/images-prod/python-librarian-generator@sha256:72e9b62c0f8f3799651ee62d777a2905f5b72ff19ea46f2e7b7d682d7d1e9414 +image: us-central1-docker.pkg.dev/cloud-sdk-librarian-prod/images-prod/python-librarian-generator:latest libraries: - - id: google-ads-admanager - version: 0.6.0 - last_generated_commit: e8365a7f88fabe8717cb8322b8ce784b03b6daea - apis: - - path: google/ads/admanager/v1 - service_config: admanager_v1.yaml - source_roots: - - packages/google-ads-admanager - preserve_regex: - - packages/google-ads-admanager/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-ads-admanager/ - tag_format: '{id}-v{version}' - - id: google-ads-datamanager - version: 0.1.0 - last_generated_commit: c2db528a3e4d12b95666c719ee0db30a3d4c78ad - apis: - - path: google/ads/datamanager/v1 - service_config: datamanager_v1.yaml - source_roots: - - packages/google-ads-datamanager - preserve_regex: - - packages/google-ads-datamanager/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-ads-datamanager - tag_format: '{id}-v{version}' - - id: google-ads-marketingplatform-admin - version: 0.3.0 - last_generated_commit: 53f97391f3451398f7b53c7f86dabd325d205677 - apis: - - path: google/marketingplatform/admin/v1alpha - service_config: marketingplatformadmin_v1alpha.yaml - source_roots: - - packages/google-ads-marketingplatform-admin - preserve_regex: - - packages/google-ads-marketingplatform-admin/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-ads-marketingplatform-admin/ - tag_format: '{id}-v{version}' - - id: google-ai-generativelanguage - version: 0.9.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/ai/generativelanguage/v1 - service_config: generativelanguage_v1.yaml - - path: google/ai/generativelanguage/v1beta - service_config: generativelanguage_v1beta.yaml - - path: google/ai/generativelanguage/v1beta3 - service_config: generativelanguage_v1beta3.yaml - - path: google/ai/generativelanguage/v1beta2 - service_config: generativelanguage_v1beta2.yaml - - path: google/ai/generativelanguage/v1alpha - service_config: generativelanguage_v1alpha.yaml - source_roots: - - packages/google-ai-generativelanguage - preserve_regex: - - packages/google-ai-generativelanguage/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-ai-generativelanguage/ - tag_format: '{id}-v{version}' - - id: google-analytics-admin - version: 0.26.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/analytics/admin/v1beta - service_config: analyticsadmin_v1beta.yaml - - path: google/analytics/admin/v1alpha - service_config: analyticsadmin_v1alpha.yaml - source_roots: - - packages/google-analytics-admin - preserve_regex: - - packages/google-analytics-admin/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-analytics-admin/ - tag_format: '{id}-v{version}' - - id: google-analytics-data - version: 0.19.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/analytics/data/v1alpha - service_config: analyticsdata_v1alpha.yaml - - path: google/analytics/data/v1beta - service_config: analyticsdata_v1beta.yaml - source_roots: - - packages/google-analytics-data - preserve_regex: - - packages/google-analytics-data/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-analytics-data/ - tag_format: '{id}-v{version}' - - id: google-apps-card - version: 0.3.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/apps/card/v1 - service_config: "" - source_roots: - - packages/google-apps-card - preserve_regex: - - packages/google-apps-card/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - - tests/unit/gapic/card_v1/test_card.py - remove_regex: - - packages/google-apps-card/ - tag_format: '{id}-v{version}' - - id: google-apps-chat - version: 0.4.0 - last_generated_commit: e8365a7f88fabe8717cb8322b8ce784b03b6daea - apis: - - path: google/chat/v1 - service_config: chat_v1.yaml - source_roots: - - packages/google-apps-chat - preserve_regex: - - packages/google-apps-chat/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-apps-chat/ - tag_format: '{id}-v{version}' - - id: google-apps-events-subscriptions - version: 0.3.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/apps/events/subscriptions/v1 - service_config: workspaceevents_v1.yaml - - path: google/apps/events/subscriptions/v1beta - service_config: workspaceevents_v1beta.yaml - source_roots: - - packages/google-apps-events-subscriptions - preserve_regex: - - packages/google-apps-events-subscriptions/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-apps-events-subscriptions/ - tag_format: '{id}-v{version}' - - id: google-apps-meet - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/apps/meet/v2beta - service_config: meet_v2beta.yaml - - path: google/apps/meet/v2 - service_config: meet_v2.yaml - source_roots: - - packages/google-apps-meet - preserve_regex: - - packages/google-apps-meet/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-apps-meet/ - tag_format: '{id}-v{version}' - - id: google-apps-script-type - version: 0.4.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/apps/script/type - service_config: "" - - path: google/apps/script/type/gmail - service_config: "" - - path: google/apps/script/type/docs - service_config: "" - - path: google/apps/script/type/drive - service_config: "" - - path: google/apps/script/type/sheets - service_config: "" - - path: google/apps/script/type/calendar - service_config: "" - - path: google/apps/script/type/slides - service_config: "" - source_roots: - - packages/google-apps-script-type - preserve_regex: - - packages/google-apps-script-type/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - - tests/unit/gapic/calendar/test_calendar.py - - tests/unit/gapic/docs/test_docs.py - - tests/unit/gapic/drive/test_drive.py - - tests/unit/gapic/gmail/test_gmail.py - - tests/unit/gapic/sheets/test_sheets.py - - tests/unit/gapic/slides/test_slides.py - - tests/unit/gapic/type/test_type.py - remove_regex: - - packages/google-apps-script-type - tag_format: '{id}-v{version}' - - id: google-area120-tables - version: 0.12.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/area120/tables/v1alpha1 - service_config: area120tables_v1alpha1.yaml - source_roots: - - packages/google-area120-tables - preserve_regex: - - packages/google-area120-tables/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-area120-tables/ - tag_format: '{id}-v{version}' - - id: google-cloud-access-approval - version: 1.17.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/accessapproval/v1 - service_config: accessapproval_v1.yaml - source_roots: - - packages/google-cloud-access-approval - preserve_regex: - - packages/google-cloud-access-approval/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-access-approval/ - tag_format: '{id}-v{version}' - - id: google-cloud-access-context-manager - version: 0.3.0 - last_generated_commit: e8365a7f88fabe8717cb8322b8ce784b03b6daea - apis: - - path: google/identity/accesscontextmanager/v1 - service_config: accesscontextmanager_v1.yaml - - path: google/identity/accesscontextmanager/type - service_config: "" - source_roots: - - packages/google-cloud-access-context-manager - preserve_regex: [] - remove_regex: - - ^packages/google-cloud-access-context-manager/google/.*/.*(?:\.proto|_pb2\.(?:py|pyi))$ - - .repo-metadata.json - - README.rst - - docs/summary_overview.md - tag_format: '{id}-v{version}' - - id: google-cloud-advisorynotifications - version: 0.4.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/advisorynotifications/v1 - service_config: advisorynotifications_v1.yaml - source_roots: - - packages/google-cloud-advisorynotifications - preserve_regex: - - packages/google-cloud-advisorynotifications/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-advisorynotifications/ - tag_format: '{id}-v{version}' - - id: google-cloud-alloydb - version: 0.6.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/alloydb/v1beta - service_config: alloydb_v1beta.yaml - - path: google/cloud/alloydb/v1 - service_config: alloydb_v1.yaml - - path: google/cloud/alloydb/v1alpha - service_config: alloydb_v1alpha.yaml - source_roots: - - packages/google-cloud-alloydb - preserve_regex: - - packages/google-cloud-alloydb/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-alloydb/ - tag_format: '{id}-v{version}' - - id: google-cloud-alloydb-connectors - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/alloydb/connectors/v1 - service_config: connectors_v1.yaml - - path: google/cloud/alloydb/connectors/v1alpha - service_config: connectors_v1alpha.yaml - - path: google/cloud/alloydb/connectors/v1beta - service_config: connectors_v1beta.yaml - source_roots: - - packages/google-cloud-alloydb-connectors - preserve_regex: - - packages/google-cloud-alloydb-connectors/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - - tests/unit/gapic/connectors_v1/test_connectors.py - remove_regex: - - packages/google-cloud-alloydb-connectors/ - tag_format: '{id}-v{version}' - - id: google-cloud-api-gateway - version: 1.13.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/apigateway/v1 - service_config: apigateway_v1.yaml - source_roots: - - packages/google-cloud-api-gateway - preserve_regex: - - packages/google-cloud-api-gateway/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-api-gateway/ - tag_format: '{id}-v{version}' - - id: google-cloud-api-keys - version: 0.6.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/api/apikeys/v2 - service_config: apikeys_v2.yaml - source_roots: - - packages/google-cloud-api-keys - preserve_regex: - - packages/google-cloud-api-keys/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-api-keys/ - tag_format: '{id}-v{version}' - - id: google-cloud-apigee-connect - version: 1.13.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/apigeeconnect/v1 - service_config: apigeeconnect_v1.yaml - source_roots: - - packages/google-cloud-apigee-connect - preserve_regex: - - packages/google-cloud-apigee-connect/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-apigee-connect/ - tag_format: '{id}-v{version}' - - id: google-cloud-apigee-registry - version: 0.7.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/apigeeregistry/v1 - service_config: apigeeregistry_v1.yaml - source_roots: - - packages/google-cloud-apigee-registry - preserve_regex: - - packages/google-cloud-apigee-registry/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-apigee-registry/ - tag_format: '{id}-v{version}' - - id: google-cloud-apihub - version: 0.4.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/apihub/v1 - service_config: apihub_v1.yaml - source_roots: - - packages/google-cloud-apihub - preserve_regex: - - packages/google-cloud-apihub/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-apihub/ - tag_format: '{id}-v{version}' - - id: google-cloud-appengine-admin - version: 1.15.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/appengine/v1 - service_config: appengine_v1.yaml - source_roots: - - packages/google-cloud-appengine-admin - preserve_regex: - - packages/google-cloud-appengine-admin/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-appengine-admin/ - tag_format: '{id}-v{version}' - - id: google-cloud-appengine-logging - version: 1.7.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/appengine/logging/v1 - service_config: "" - source_roots: - - packages/google-cloud-appengine-logging - preserve_regex: - - packages/google-cloud-appengine-logging/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - - tests/unit/gapic/appengine_logging_v1/test_appengine_logging_v1.py - remove_regex: - - packages/google-cloud-appengine-logging/ - tag_format: '{id}-v{version}' - - id: google-cloud-apphub - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/apphub/v1 - service_config: apphub_v1.yaml - source_roots: - - packages/google-cloud-apphub - preserve_regex: - - packages/google-cloud-apphub/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-apphub/ - tag_format: '{id}-v{version}' - - id: google-cloud-artifact-registry - version: 1.17.0 - last_generated_commit: c2db528a3e4d12b95666c719ee0db30a3d4c78ad - apis: - - path: google/devtools/artifactregistry/v1 - service_config: artifactregistry_v1.yaml - - path: google/devtools/artifactregistry/v1beta2 - service_config: artifactregistry_v1beta2.yaml - source_roots: - - packages/google-cloud-artifact-registry - preserve_regex: - - packages/google-cloud-artifact-registry/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-artifact-registry/ - tag_format: '{id}-v{version}' - - id: google-cloud-asset - version: 4.1.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/asset/v1p5beta1 - service_config: cloudasset_v1p5beta1.yaml - - path: google/cloud/asset/v1 - service_config: cloudasset_v1.yaml - - path: google/cloud/asset/v1p1beta1 - service_config: cloudasset_v1p1beta1.yaml - - path: google/cloud/asset/v1p2beta1 - service_config: cloudasset_v1p2beta1.yaml - source_roots: - - packages/google-cloud-asset - preserve_regex: - - packages/google-cloud-asset/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-asset/ - tag_format: '{id}-v{version}' - - id: google-cloud-assured-workloads - version: 2.1.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/assuredworkloads/v1 - service_config: assuredworkloads_v1.yaml - - path: google/cloud/assuredworkloads/v1beta1 - service_config: assuredworkloads_v1beta1.yaml - source_roots: - - packages/google-cloud-assured-workloads - preserve_regex: - - packages/google-cloud-assured-workloads/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-assured-workloads/ - tag_format: '{id}-v{version}' - - id: google-cloud-audit-log - version: 0.4.0 - last_generated_commit: e8365a7f88fabe8717cb8322b8ce784b03b6daea - apis: - - path: google/cloud/audit - service_config: cloudaudit.yaml - source_roots: - - packages/google-cloud-audit-log - preserve_regex: [] - remove_regex: - - ^packages/google-cloud-audit-log/google/.*/.*(?:\.proto|_pb2\.(?:py|pyi))$ - - .repo-metadata.json - - README.rst - - docs/summary_overview.md - tag_format: '{id}-v{version}' - - id: google-cloud-automl - version: 2.17.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/automl/v1beta1 - service_config: automl_v1beta1.yaml - - path: google/cloud/automl/v1 - service_config: automl_v1.yaml - source_roots: - - packages/google-cloud-automl - preserve_regex: - - packages/google-cloud-automl/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - - docs/automl_v1beta1/tables.rst - - google/cloud/automl_v1beta1/services/tables - - samples/README - - tests/unit/test_gcs_client_v1beta1.py - - tests/unit/test_tables_client_v1beta1.py - remove_regex: - - packages/google-cloud-automl/ - tag_format: '{id}-v{version}' - - id: google-cloud-backupdr - version: 0.4.0 - last_generated_commit: a17b84add8318f780fcc8a027815d5fee644b9f7 - apis: - - path: google/cloud/backupdr/v1 - service_config: backupdr_v1.yaml - source_roots: - - packages/google-cloud-backupdr - preserve_regex: - - packages/google-cloud-backupdr/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-backupdr/ - tag_format: '{id}-v{version}' - - id: google-cloud-bare-metal-solution - version: 1.11.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/baremetalsolution/v2 - service_config: baremetalsolution_v2.yaml - source_roots: - - packages/google-cloud-bare-metal-solution - preserve_regex: - - packages/google-cloud-bare-metal-solution/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-bare-metal-solution/ - tag_format: '{id}-v{version}' - - id: google-cloud-batch - version: 0.18.0 - last_generated_commit: a17b84add8318f780fcc8a027815d5fee644b9f7 - apis: - - path: google/cloud/batch/v1alpha - service_config: batch_v1alpha.yaml - - path: google/cloud/batch/v1 - service_config: batch_v1.yaml - source_roots: - - packages/google-cloud-batch - preserve_regex: - - packages/google-cloud-batch/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-batch/ - tag_format: '{id}-v{version}' - - id: google-cloud-beyondcorp-appconnections - version: 0.5.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/beyondcorp/appconnections/v1 - service_config: beyondcorp_v1.yaml - source_roots: - - packages/google-cloud-beyondcorp-appconnections - preserve_regex: - - packages/google-cloud-beyondcorp-appconnections/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-beyondcorp-appconnections/ - tag_format: '{id}-v{version}' - - id: google-cloud-beyondcorp-appconnectors - version: 0.5.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/beyondcorp/appconnectors/v1 - service_config: beyondcorp_v1.yaml - source_roots: - - packages/google-cloud-beyondcorp-appconnectors - preserve_regex: - - packages/google-cloud-beyondcorp-appconnectors/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-beyondcorp-appconnectors/ - tag_format: '{id}-v{version}' - - id: google-cloud-beyondcorp-appgateways - version: 0.5.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/beyondcorp/appgateways/v1 - service_config: beyondcorp_v1.yaml - source_roots: - - packages/google-cloud-beyondcorp-appgateways - preserve_regex: - - packages/google-cloud-beyondcorp-appgateways/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-beyondcorp-appgateways/ - tag_format: '{id}-v{version}' - - id: google-cloud-beyondcorp-clientconnectorservices - version: 0.5.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/beyondcorp/clientconnectorservices/v1 - service_config: beyondcorp_v1.yaml - source_roots: - - packages/google-cloud-beyondcorp-clientconnectorservices - preserve_regex: - - packages/google-cloud-beyondcorp-clientconnectorservices/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-beyondcorp-clientconnectorservices/ - tag_format: '{id}-v{version}' - - id: google-cloud-beyondcorp-clientgateways - version: 0.5.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/beyondcorp/clientgateways/v1 - service_config: beyondcorp_v1.yaml - source_roots: - - packages/google-cloud-beyondcorp-clientgateways - preserve_regex: - - packages/google-cloud-beyondcorp-clientgateways/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-beyondcorp-clientgateways/ - tag_format: '{id}-v{version}' - - id: google-cloud-biglake - version: 0.1.1 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/biglake/v1 - service_config: biglake_v1.yaml - source_roots: - - packages/google-cloud-biglake - preserve_regex: - - packages/google-cloud-biglake/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-biglake - tag_format: '{id}-v{version}' - - id: google-cloud-bigquery-analyticshub - version: 0.6.0 - last_generated_commit: 53f97391f3451398f7b53c7f86dabd325d205677 - apis: - - path: google/cloud/bigquery/analyticshub/v1 - service_config: analyticshub_v1.yaml - source_roots: - - packages/google-cloud-bigquery-analyticshub - preserve_regex: - - packages/google-cloud-bigquery-analyticshub/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-bigquery-analyticshub/ - tag_format: '{id}-v{version}' - - id: google-cloud-bigquery-biglake - version: 0.5.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/bigquery/biglake/v1alpha1 - service_config: biglake_v1alpha1.yaml - - path: google/cloud/bigquery/biglake/v1 - service_config: biglake_v1.yaml - source_roots: - - packages/google-cloud-bigquery-biglake - preserve_regex: - - packages/google-cloud-bigquery-biglake/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-bigquery-biglake/ - tag_format: '{id}-v{version}' - - id: google-cloud-bigquery-connection - version: 1.19.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/bigquery/connection/v1 - service_config: bigqueryconnection_v1.yaml - source_roots: - - packages/google-cloud-bigquery-connection - preserve_regex: - - packages/google-cloud-bigquery-connection/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-bigquery-connection/ - tag_format: '{id}-v{version}' - - id: google-cloud-bigquery-data-exchange - version: 0.6.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/bigquery/dataexchange/v1beta1 - service_config: analyticshub_v1beta1.yaml - source_roots: - - packages/google-cloud-bigquery-data-exchange - preserve_regex: - - packages/google-cloud-bigquery-data-exchange/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-bigquery-data-exchange/ - tag_format: '{id}-v{version}' - - id: google-cloud-bigquery-datapolicies - version: 0.7.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/bigquery/datapolicies/v2beta1 - service_config: bigquerydatapolicy_v2beta1.yaml - - path: google/cloud/bigquery/datapolicies/v2 - service_config: bigquerydatapolicy_v2.yaml - - path: google/cloud/bigquery/datapolicies/v1beta1 - service_config: bigquerydatapolicy_v1beta1.yaml - - path: google/cloud/bigquery/datapolicies/v1 - service_config: bigquerydatapolicy_v1.yaml - source_roots: - - packages/google-cloud-bigquery-datapolicies - preserve_regex: - - packages/google-cloud-bigquery-datapolicies/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-bigquery-datapolicies/ - tag_format: '{id}-v{version}' - - id: google-cloud-bigquery-datatransfer - version: 3.20.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/bigquery/datatransfer/v1 - service_config: bigquerydatatransfer_v1.yaml - source_roots: - - packages/google-cloud-bigquery-datatransfer - preserve_regex: - - packages/google-cloud-bigquery-datatransfer/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-bigquery-datatransfer/ - tag_format: '{id}-v{version}' - - id: google-cloud-bigquery-logging - version: 1.7.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/bigquery/logging/v1 - service_config: "" - source_roots: - - packages/google-cloud-bigquery-logging - preserve_regex: - - packages/google-cloud-bigquery-logging/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - - tests/unit/gapic/bigquery_logging_v1/test_bigquery_logging_v1.py - remove_regex: - - packages/google-cloud-bigquery-logging/ - tag_format: '{id}-v{version}' - - id: google-cloud-bigquery-migration - version: 0.12.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/bigquery/migration/v2alpha - service_config: bigquerymigration_v2alpha.yaml - - path: google/cloud/bigquery/migration/v2 - service_config: bigquerymigration_v2.yaml - source_roots: - - packages/google-cloud-bigquery-migration - preserve_regex: - - packages/google-cloud-bigquery-migration/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-bigquery-migration/ - tag_format: '{id}-v{version}' - - id: google-cloud-bigquery-reservation - version: 1.21.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/bigquery/reservation/v1 - service_config: bigqueryreservation_v1.yaml - source_roots: - - packages/google-cloud-bigquery-reservation - preserve_regex: - - packages/google-cloud-bigquery-reservation/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-bigquery-reservation/ - tag_format: '{id}-v{version}' - - id: google-cloud-bigquery-storage - version: 2.34.0 - last_generated_commit: bd94e0b8c4975af0a66dc1f846c63c77dbc0064e - apis: - - path: google/cloud/bigquery/storage/v1beta2 - service_config: bigquerystorage_v1beta2.yaml - - path: google/cloud/bigquery/storage/v1alpha - service_config: bigquerystorage_v1alpha.yaml - - path: google/cloud/bigquery/storage/v1beta - service_config: bigquerystorage_v1beta.yaml - - path: google/cloud/bigquery/storage/v1 - service_config: bigquerystorage_v1.yaml - source_roots: - - packages/google-cloud-bigquery-storage - preserve_regex: - - docs/.*/library.rst - - docs/samples - - docs/CHANGELOG.md - - google/cloud/bigquery_storage_v1/client.py - - google/cloud/bigquery_storage_v1/exceptions.py - - google/cloud/bigquery_storage_v1/gapic_types.py - - google/cloud/bigquery_storage_v1/reader.py - - google/cloud/bigquery_storage_v1/writer.py - - google/cloud/bigquery_storage_v1beta2/client.py - - google/cloud/bigquery_storage_v1beta2/exceptions.py - - google/cloud/bigquery_storage_v1beta2/writer.py - - packages/google-cloud-bigquery-storage/CHANGELOG.md - - packages/google-cloud-bigquery-storage/CONTRIBUTING - - samples/__init__.py - - samples/README.txt - - samples/conftest.py - - samples/pyarrow - - samples/quickstart - - samples/snippets - - samples/to_dataframe - - scripts/readme-gen - - testing/.gitignore - - tests/system - - tests/unit/helpers.py - - tests/unit/test_.*.py - remove_regex: - - packages/google-cloud-bigquery-storage - tag_format: '{id}-v{version}' - - id: google-cloud-billing - version: 1.17.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/billing/v1 - service_config: cloudbilling_v1.yaml - source_roots: - - packages/google-cloud-billing - preserve_regex: - - packages/google-cloud-billing/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-billing/ - tag_format: '{id}-v{version}' - - id: google-cloud-billing-budgets - version: 1.18.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/billing/budgets/v1 - service_config: billingbudgets.yaml - - path: google/cloud/billing/budgets/v1beta1 - service_config: billingbudgets.yaml - source_roots: - - packages/google-cloud-billing-budgets - preserve_regex: - - packages/google-cloud-billing-budgets/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-billing-budgets/ - tag_format: '{id}-v{version}' - - id: google-cloud-binary-authorization - version: 1.14.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/binaryauthorization/v1 - service_config: binaryauthorization_v1.yaml - - path: google/cloud/binaryauthorization/v1beta1 - service_config: binaryauthorization_v1beta1.yaml - source_roots: - - packages/google-cloud-binary-authorization - preserve_regex: - - packages/google-cloud-binary-authorization/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-binary-authorization/ - tag_format: '{id}-v{version}' - - id: google-cloud-build - version: 3.33.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/devtools/cloudbuild/v1 - service_config: cloudbuild_v1.yaml - - path: google/devtools/cloudbuild/v2 - service_config: cloudbuild_v2.yaml - source_roots: - - packages/google-cloud-build - preserve_regex: - - packages/google-cloud-build/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-build/ - tag_format: '{id}-v{version}' - - id: google-cloud-capacityplanner - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/capacityplanner/v1beta - service_config: capacityplanner_v1beta.yaml - source_roots: - - packages/google-cloud-capacityplanner - preserve_regex: - - packages/google-cloud-capacityplanner/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-capacityplanner/ - tag_format: '{id}-v{version}' - - id: google-cloud-certificate-manager - version: 1.11.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/certificatemanager/v1 - service_config: certificatemanager_v1.yaml - source_roots: - - packages/google-cloud-certificate-manager - preserve_regex: - - packages/google-cloud-certificate-manager/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-certificate-manager/ - tag_format: '{id}-v{version}' - - id: google-cloud-channel - version: 1.24.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/channel/v1 - service_config: cloudchannel_v1.yaml - source_roots: - - packages/google-cloud-channel - preserve_regex: - - packages/google-cloud-channel/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-channel/ - tag_format: '{id}-v{version}' - - id: google-cloud-chronicle - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/chronicle/v1 - service_config: chronicle_v1.yaml - source_roots: - - packages/google-cloud-chronicle - preserve_regex: - - packages/google-cloud-chronicle/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-chronicle/ - tag_format: '{id}-v{version}' - - id: google-cloud-cloudcontrolspartner - version: 0.3.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/cloudcontrolspartner/v1beta - service_config: cloudcontrolspartner_v1beta.yaml - - path: google/cloud/cloudcontrolspartner/v1 - service_config: cloudcontrolspartner_v1.yaml - source_roots: - - packages/google-cloud-cloudcontrolspartner - preserve_regex: - - packages/google-cloud-cloudcontrolspartner/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-cloudcontrolspartner/ - tag_format: '{id}-v{version}' - - id: google-cloud-cloudsecuritycompliance - version: 0.4.0 - last_generated_commit: 53f97391f3451398f7b53c7f86dabd325d205677 - apis: - - path: google/cloud/cloudsecuritycompliance/v1 - service_config: cloudsecuritycompliance_v1.yaml - source_roots: - - packages/google-cloud-cloudsecuritycompliance - preserve_regex: - - packages/google-cloud-cloudsecuritycompliance/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-cloudsecuritycompliance/ - tag_format: '{id}-v{version}' - - id: google-cloud-commerce-consumer-procurement - version: 0.3.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/commerce/consumer/procurement/v1 - service_config: cloudcommerceconsumerprocurement_v1.yaml - - path: google/cloud/commerce/consumer/procurement/v1alpha1 - service_config: cloudcommerceconsumerprocurement_v1alpha1.yaml - source_roots: - - packages/google-cloud-commerce-consumer-procurement - preserve_regex: - - packages/google-cloud-commerce-consumer-procurement/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-commerce-consumer-procurement/ - tag_format: '{id}-v{version}' - - id: google-cloud-common - version: 1.7.0 - last_generated_commit: e8365a7f88fabe8717cb8322b8ce784b03b6daea - apis: - - path: google/cloud/common - service_config: common.yaml - source_roots: - - packages/google-cloud-common - preserve_regex: - - packages/google-cloud-common/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - - tests/unit/gapic/common/test_common.py - remove_regex: - - packages/google-cloud-common/ - tag_format: '{id}-v{version}' - - id: google-cloud-compute - version: 1.40.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/compute/v1 - service_config: compute_v1.yaml - source_roots: - - packages/google-cloud-compute - preserve_regex: - - packages/google-cloud-compute/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-compute/ - tag_format: '{id}-v{version}' - - id: google-cloud-compute-v1beta - version: 0.3.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/compute/v1beta - service_config: compute_v1beta.yaml - source_roots: - - packages/google-cloud-compute-v1beta - preserve_regex: - - packages/google-cloud-compute-v1beta/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-compute-v1beta/ - tag_format: '{id}-v{version}' - - id: google-cloud-confidentialcomputing - version: 0.6.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/confidentialcomputing/v1 - service_config: confidentialcomputing_v1.yaml - source_roots: - - packages/google-cloud-confidentialcomputing - preserve_regex: - - packages/google-cloud-confidentialcomputing/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-confidentialcomputing/ - tag_format: '{id}-v{version}' - - id: google-cloud-config - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/config/v1 - service_config: config_v1.yaml - source_roots: - - packages/google-cloud-config - preserve_regex: - - packages/google-cloud-config/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-config/ - tag_format: '{id}-v{version}' - - id: google-cloud-configdelivery - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/configdelivery/v1beta - service_config: configdelivery_v1beta.yaml - - path: google/cloud/configdelivery/v1alpha - service_config: configdelivery_v1alpha.yaml - - path: google/cloud/configdelivery/v1 - service_config: configdelivery_v1.yaml - source_roots: - - packages/google-cloud-configdelivery - preserve_regex: - - packages/google-cloud-configdelivery/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-configdelivery/ - tag_format: '{id}-v{version}' - - id: google-cloud-contact-center-insights - version: 1.24.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/contactcenterinsights/v1 - service_config: contactcenterinsights_v1.yaml - source_roots: - - packages/google-cloud-contact-center-insights - preserve_regex: - - packages/google-cloud-contact-center-insights/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-contact-center-insights/ - tag_format: '{id}-v{version}' - - id: google-cloud-container - version: 2.61.0 - last_generated_commit: 94ccdfe4519e0ba817bd33aa22eb9c64f88a6874 - apis: - - path: google/container/v1 - service_config: container_v1.yaml - - path: google/container/v1beta1 - service_config: container_v1beta1.yaml - source_roots: - - packages/google-cloud-container - preserve_regex: - - packages/google-cloud-container/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-container/ - tag_format: '{id}-v{version}' - - id: google-cloud-containeranalysis - version: 2.19.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/devtools/containeranalysis/v1 - service_config: containeranalysis_v1.yaml - source_roots: - - packages/google-cloud-containeranalysis - preserve_regex: - - packages/google-cloud-containeranalysis/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - - tests/unit/test_get_grafeas_client.py - remove_regex: - - packages/google-cloud-containeranalysis/ - tag_format: '{id}-v{version}' - - id: google-cloud-contentwarehouse - version: 0.8.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/contentwarehouse/v1 - service_config: contentwarehouse_v1.yaml - source_roots: - - packages/google-cloud-contentwarehouse - preserve_regex: - - packages/google-cloud-contentwarehouse/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-contentwarehouse/ - tag_format: '{id}-v{version}' - - id: google-cloud-data-fusion - version: 1.14.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/datafusion/v1 - service_config: datafusion_v1.yaml - source_roots: - - packages/google-cloud-data-fusion - preserve_regex: - - packages/google-cloud-data-fusion/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-data-fusion/ - tag_format: '{id}-v{version}' - - id: google-cloud-data-qna - version: 0.11.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/dataqna/v1alpha - service_config: dataqna_v1alpha.yaml - source_roots: - - packages/google-cloud-data-qna - preserve_regex: - - packages/google-cloud-data-qna/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-data-qna/ - tag_format: '{id}-v{version}' - - id: google-cloud-datacatalog - version: 3.28.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/datacatalog/v1 - service_config: datacatalog_v1.yaml - - path: google/cloud/datacatalog/v1beta1 - service_config: datacatalog_v1beta1.yaml - source_roots: - - packages/google-cloud-datacatalog - preserve_regex: - - packages/google-cloud-datacatalog/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-datacatalog/ - tag_format: '{id}-v{version}' - - id: google-cloud-datacatalog-lineage - version: 0.4.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/datacatalog/lineage/v1 - service_config: datalineage_v1.yaml - source_roots: - - packages/google-cloud-datacatalog-lineage - preserve_regex: - - packages/google-cloud-datacatalog-lineage/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-datacatalog-lineage/ - tag_format: '{id}-v{version}' - - id: google-cloud-dataflow-client - version: 0.10.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/dataflow/v1beta3 - service_config: dataflow_v1beta3.yaml - source_roots: - - packages/google-cloud-dataflow-client - preserve_regex: - - packages/google-cloud-dataflow-client/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-dataflow-client/ - tag_format: '{id}-v{version}' - - id: google-cloud-dataform - version: 0.7.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/dataform/v1beta1 - service_config: dataform_v1beta1.yaml - - path: google/cloud/dataform/v1 - service_config: dataform_v1.yaml - source_roots: - - packages/google-cloud-dataform - preserve_regex: - - packages/google-cloud-dataform/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-dataform/ - tag_format: '{id}-v{version}' - - id: google-cloud-datalabeling - version: 1.14.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/datalabeling/v1beta1 - service_config: datalabeling_v1beta1.yaml - source_roots: - - packages/google-cloud-datalabeling - preserve_regex: - - packages/google-cloud-datalabeling/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-datalabeling/ - tag_format: '{id}-v{version}' - - id: google-cloud-dataplex - version: 2.15.0 - last_generated_commit: 53f97391f3451398f7b53c7f86dabd325d205677 - apis: - - path: google/cloud/dataplex/v1 - service_config: dataplex_v1.yaml - source_roots: - - packages/google-cloud-dataplex - preserve_regex: - - packages/google-cloud-dataplex/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-dataplex/ - tag_format: '{id}-v{version}' - - id: google-cloud-dataproc - version: 5.23.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/dataproc/v1 - service_config: dataproc_v1.yaml - source_roots: - - packages/google-cloud-dataproc - preserve_regex: - - packages/google-cloud-dataproc/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-dataproc/ - tag_format: '{id}-v{version}' - - id: google-cloud-dataproc-metastore - version: 1.20.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/metastore/v1alpha - service_config: metastore_v1alpha.yaml - - path: google/cloud/metastore/v1beta - service_config: metastore_v1beta.yaml - - path: google/cloud/metastore/v1 - service_config: metastore_v1.yaml - source_roots: - - packages/google-cloud-dataproc-metastore - preserve_regex: - - packages/google-cloud-dataproc-metastore/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-dataproc-metastore/ - tag_format: '{id}-v{version}' - - id: google-cloud-datastream - version: 1.16.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/datastream/v1 - service_config: datastream_v1.yaml - - path: google/cloud/datastream/v1alpha1 - service_config: datastream_v1alpha1.yaml - source_roots: - - packages/google-cloud-datastream - preserve_regex: - - packages/google-cloud-datastream/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-datastream/ - tag_format: '{id}-v{version}' - - id: google-cloud-deploy - version: 2.8.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/deploy/v1 - service_config: clouddeploy_v1.yaml - source_roots: - - packages/google-cloud-deploy - preserve_regex: - - packages/google-cloud-deploy/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-deploy/ - tag_format: '{id}-v{version}' - - id: google-cloud-developerconnect - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/developerconnect/v1 - service_config: developerconnect_v1.yaml - source_roots: - - packages/google-cloud-developerconnect - preserve_regex: - - packages/google-cloud-developerconnect/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-developerconnect/ - tag_format: '{id}-v{version}' - - id: google-cloud-devicestreaming - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/devicestreaming/v1 - service_config: devicestreaming_v1.yaml - source_roots: - - packages/google-cloud-devicestreaming - preserve_regex: - - packages/google-cloud-devicestreaming/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-devicestreaming/ - tag_format: '{id}-v{version}' - - id: google-cloud-dialogflow - version: 2.43.0 - last_generated_commit: c2db528a3e4d12b95666c719ee0db30a3d4c78ad - apis: - - path: google/cloud/dialogflow/v2beta1 - service_config: dialogflow_v2beta1.yaml - - path: google/cloud/dialogflow/v2 - service_config: dialogflow_v2.yaml - source_roots: - - packages/google-cloud-dialogflow - preserve_regex: - - packages/google-cloud-dialogflow/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-dialogflow/ - tag_format: '{id}-v{version}' - - id: google-cloud-dialogflow-cx - version: 2.0.0 - last_generated_commit: c2db528a3e4d12b95666c719ee0db30a3d4c78ad - apis: - - path: google/cloud/dialogflow/cx/v3 - service_config: dialogflow_v3.yaml - - path: google/cloud/dialogflow/cx/v3beta1 - service_config: dialogflow_v3beta1.yaml - source_roots: - - packages/google-cloud-dialogflow-cx - preserve_regex: - - packages/google-cloud-dialogflow-cx/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-dialogflow-cx - tag_format: '{id}-v{version}' - - id: google-cloud-discoveryengine - version: 0.15.0 - last_generated_commit: c288189b43c016dd3cf1ec73ce3cadee8b732f07 - apis: - - path: google/cloud/discoveryengine/v1 - service_config: discoveryengine_v1.yaml - - path: google/cloud/discoveryengine/v1beta - service_config: discoveryengine_v1beta.yaml - - path: google/cloud/discoveryengine/v1alpha - service_config: discoveryengine_v1alpha.yaml - source_roots: - - packages/google-cloud-discoveryengine - preserve_regex: - - packages/google-cloud-discoveryengine/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-discoveryengine/ - tag_format: '{id}-v{version}' - - id: google-cloud-dlp - version: 3.33.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/privacy/dlp/v2 - service_config: dlp_v2.yaml - source_roots: - - packages/google-cloud-dlp - preserve_regex: - - packages/google-cloud-dlp/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-dlp/ - tag_format: '{id}-v{version}' - - id: google-cloud-dms - version: 1.13.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/clouddms/v1 - service_config: datamigration_v1.yaml - source_roots: - - packages/google-cloud-dms - preserve_regex: - - packages/google-cloud-dms/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-dms/ - tag_format: '{id}-v{version}' - - id: google-cloud-documentai - version: 3.7.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/documentai/v1beta3 - service_config: documentai_v1beta3.yaml - - path: google/cloud/documentai/v1 - service_config: documentai_v1.yaml - source_roots: - - packages/google-cloud-documentai - preserve_regex: - - packages/google-cloud-documentai/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-documentai/ - tag_format: '{id}-v{version}' - - id: google-cloud-domains - version: 1.11.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/domains/v1beta1 - service_config: domains_v1beta1.yaml - - path: google/cloud/domains/v1 - service_config: domains_v1.yaml - source_roots: - - packages/google-cloud-domains - preserve_regex: - - packages/google-cloud-domains/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-domains/ - tag_format: '{id}-v{version}' - - id: google-cloud-edgecontainer - version: 0.6.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/edgecontainer/v1 - service_config: edgecontainer_v1.yaml - source_roots: - - packages/google-cloud-edgecontainer - preserve_regex: - - packages/google-cloud-edgecontainer/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-edgecontainer/ - tag_format: '{id}-v{version}' - - id: google-cloud-edgenetwork - version: 0.3.0 - last_generated_commit: b1a9eefc2e1021fb9465bdac5e2984499451ae34 - apis: - - path: google/cloud/edgenetwork/v1 - service_config: edgenetwork_v1.yaml - source_roots: - - packages/google-cloud-edgenetwork - preserve_regex: - - packages/google-cloud-edgenetwork/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-edgenetwork/ - tag_format: '{id}-v{version}' - - id: google-cloud-enterpriseknowledgegraph - version: 0.4.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/enterpriseknowledgegraph/v1 - service_config: enterpriseknowledgegraph_v1.yaml - source_roots: - - packages/google-cloud-enterpriseknowledgegraph - preserve_regex: - - packages/google-cloud-enterpriseknowledgegraph/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-enterpriseknowledgegraph/ - tag_format: '{id}-v{version}' - - id: google-cloud-essential-contacts - version: 1.11.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/essentialcontacts/v1 - service_config: essentialcontacts_v1.yaml - source_roots: - - packages/google-cloud-essential-contacts - preserve_regex: - - packages/google-cloud-essential-contacts/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-essential-contacts/ - tag_format: '{id}-v{version}' - - id: google-cloud-eventarc - version: 1.17.0 - last_generated_commit: c9ff4f1cd26f1fe63e6d1c11a198366b70ebdb84 - apis: - - path: google/cloud/eventarc/v1 - service_config: eventarc_v1.yaml - source_roots: - - packages/google-cloud-eventarc - preserve_regex: - - packages/google-cloud-eventarc/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-eventarc/ - tag_format: '{id}-v{version}' - - id: google-cloud-eventarc-publishing - version: 0.8.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/eventarc/publishing/v1 - service_config: eventarcpublishing_v1.yaml - source_roots: - - packages/google-cloud-eventarc-publishing - preserve_regex: - - packages/google-cloud-eventarc-publishing/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-eventarc-publishing/ - tag_format: '{id}-v{version}' - - id: google-cloud-filestore - version: 1.14.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/filestore/v1 - service_config: file_v1.yaml - source_roots: - - packages/google-cloud-filestore - preserve_regex: - - packages/google-cloud-filestore/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-filestore/ - tag_format: '{id}-v{version}' - - id: google-cloud-financialservices - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/financialservices/v1 - service_config: financialservices_v1.yaml - source_roots: - - packages/google-cloud-financialservices - preserve_regex: - - packages/google-cloud-financialservices/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-financialservices/ - tag_format: '{id}-v{version}' - - id: google-cloud-functions - version: 1.21.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/functions/v2 - service_config: cloudfunctions_v2.yaml - - path: google/cloud/functions/v1 - service_config: cloudfunctions_v1.yaml - source_roots: - - packages/google-cloud-functions - preserve_regex: - - packages/google-cloud-functions/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-functions/ - tag_format: '{id}-v{version}' - - id: google-cloud-gdchardwaremanagement - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/gdchardwaremanagement/v1alpha - service_config: gdchardwaremanagement_v1alpha.yaml - source_roots: - - packages/google-cloud-gdchardwaremanagement - preserve_regex: - - packages/google-cloud-gdchardwaremanagement/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-gdchardwaremanagement/ - tag_format: '{id}-v{version}' - - id: google-cloud-geminidataanalytics - version: 0.6.0 - last_generated_commit: cf0434f4bd20618db60ddd16a1e7db2c0dfb9158 - apis: - - path: google/cloud/geminidataanalytics/v1beta - service_config: geminidataanalytics_v1beta.yaml - - path: google/cloud/geminidataanalytics/v1alpha - service_config: geminidataanalytics_v1alpha.yaml - source_roots: - - packages/google-cloud-geminidataanalytics - preserve_regex: - - packages/google-cloud-geminidataanalytics/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-geminidataanalytics/ - tag_format: '{id}-v{version}' - - id: google-cloud-gke-backup - version: 0.6.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/gkebackup/v1 - service_config: gkebackup_v1.yaml - source_roots: - - packages/google-cloud-gke-backup - preserve_regex: - - packages/google-cloud-gke-backup/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-gke-backup/ - tag_format: '{id}-v{version}' - - id: google-cloud-gke-connect-gateway - version: 0.11.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/gkeconnect/gateway/v1beta1 - service_config: connectgateway_v1beta1.yaml - - path: google/cloud/gkeconnect/gateway/v1 - service_config: connectgateway_v1.yaml - source_roots: - - packages/google-cloud-gke-connect-gateway - preserve_regex: - - packages/google-cloud-gke-connect-gateway/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-gke-connect-gateway/ - tag_format: '{id}-v{version}' - - id: google-cloud-gke-hub - version: 1.19.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/gkehub/v1 - service_config: gkehub_v1.yaml - - path: google/cloud/gkehub/v1beta1 - service_config: gkehub_v1beta1.yaml - source_roots: - - packages/google-cloud-gke-hub - preserve_regex: - - packages/google-cloud-gke-hub/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - - docs/gkehub_v1/configmanagement_v1 - - docs/gkehub_v1/multiclusteringress_v1 - - google/cloud/gkehub_v1/configmanagement_v1 - - google/cloud/gkehub_v1/multiclusteringress_v1 - remove_regex: - - packages/google-cloud-gke-hub - tag_format: '{id}-v{version}' - - id: google-cloud-gke-multicloud - version: 0.6.22 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/gkemulticloud/v1 - service_config: gkemulticloud_v1.yaml - source_roots: - - packages/google-cloud-gke-multicloud - preserve_regex: - - packages/google-cloud-gke-multicloud/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-gke-multicloud - tag_format: '{id}-v{version}' - - id: google-cloud-gkerecommender - version: 0.1.0 - last_generated_commit: 94ccdfe4519e0ba817bd33aa22eb9c64f88a6874 - apis: - - path: google/cloud/gkerecommender/v1 - service_config: gkerecommender_v1.yaml - source_roots: - - packages/google-cloud-gkerecommender - preserve_regex: - - packages/google-cloud-gkerecommender/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-gkerecommender - tag_format: '{id}-v{version}' - - id: google-cloud-gsuiteaddons - version: 0.3.18 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/gsuiteaddons/v1 - service_config: gsuiteaddons_v1.yaml - source_roots: - - packages/google-cloud-gsuiteaddons - preserve_regex: - - packages/google-cloud-gsuiteaddons/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-gsuiteaddons - tag_format: '{id}-v{version}' - - id: google-cloud-hypercomputecluster - version: 0.1.0 - last_generated_commit: b6bb60733a7314d0c45e294b12d563fd6194b8f5 - apis: - - path: google/cloud/hypercomputecluster/v1beta - service_config: hypercomputecluster_v1beta.yaml - source_roots: - - packages/google-cloud-hypercomputecluster - preserve_regex: - - packages/google-cloud-hypercomputecluster/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-hypercomputecluster - tag_format: '{id}-v{version}' - - id: google-cloud-iam - version: 2.20.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/iam/v3 - service_config: iam_v3.yaml - - path: google/iam/v3beta - service_config: iam_v3beta.yaml - - path: google/iam/admin/v1 - service_config: iam.yaml - - path: google/iam/v2 - service_config: iam_v2.yaml - - path: google/iam/credentials/v1 - service_config: iamcredentials_v1.yaml - - path: google/iam/v2beta - service_config: iam_v2beta.yaml - source_roots: - - packages/google-cloud-iam - preserve_regex: - - packages/google-cloud-iam/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-iam - tag_format: '{id}-v{version}' - - id: google-cloud-iam-logging - version: 1.5.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/iam/v1/logging - service_config: "" - source_roots: - - packages/google-cloud-iam-logging - preserve_regex: - - packages/google-cloud-iam-logging/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - - tests/unit/gapic/iam_logging_v1/test_iam_logging.py - remove_regex: - - packages/google-cloud-iam-logging/ - tag_format: '{id}-v{version}' - - id: google-cloud-iap - version: 1.18.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/iap/v1 - service_config: iap_v1.yaml - source_roots: - - packages/google-cloud-iap - preserve_regex: - - packages/google-cloud-iap/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-iap/ - tag_format: '{id}-v{version}' - - id: google-cloud-ids - version: 1.11.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/ids/v1 - service_config: ids_v1.yaml - source_roots: - - packages/google-cloud-ids - preserve_regex: - - packages/google-cloud-ids/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-ids/ - tag_format: '{id}-v{version}' - - id: google-cloud-kms - version: 3.7.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/kms/v1 - service_config: cloudkms_v1.yaml - source_roots: - - packages/google-cloud-kms - preserve_regex: - - packages/google-cloud-kms/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-kms/ - tag_format: '{id}-v{version}' - - id: google-cloud-kms-inventory - version: 0.3.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/kms/inventory/v1 - service_config: kmsinventory_v1.yaml - source_roots: - - packages/google-cloud-kms-inventory - preserve_regex: - - packages/google-cloud-kms-inventory/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-kms-inventory/ - tag_format: '{id}-v{version}' - - id: google-cloud-language - version: 2.18.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/language/v1 - service_config: language_v1.yaml - - path: google/cloud/language/v1beta2 - service_config: language_v1beta2.yaml - - path: google/cloud/language/v2 - service_config: language_v2.yaml - source_roots: - - packages/google-cloud-language - preserve_regex: - - packages/google-cloud-language/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-language/ - tag_format: '{id}-v{version}' - - id: google-cloud-licensemanager - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/licensemanager/v1 - service_config: licensemanager_v1.yaml - source_roots: - - packages/google-cloud-licensemanager - preserve_regex: - - packages/google-cloud-licensemanager/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-licensemanager/ - tag_format: '{id}-v{version}' - - id: google-cloud-life-sciences - version: 0.10.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/lifesciences/v2beta - service_config: lifesciences_v2beta.yaml - source_roots: - - packages/google-cloud-life-sciences - preserve_regex: - - packages/google-cloud-life-sciences/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-life-sciences/ - tag_format: '{id}-v{version}' - - id: google-cloud-locationfinder - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/locationfinder/v1 - service_config: cloudlocationfinder_v1.yaml - source_roots: - - packages/google-cloud-locationfinder - preserve_regex: - - packages/google-cloud-locationfinder/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-locationfinder/ - tag_format: '{id}-v{version}' - - id: google-cloud-lustre - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/lustre/v1 - service_config: lustre_v1.yaml - source_roots: - - packages/google-cloud-lustre - preserve_regex: - - packages/google-cloud-lustre/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-lustre/ - tag_format: '{id}-v{version}' - - id: google-cloud-maintenance-api - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/maintenance/api/v1beta - service_config: maintenance_v1beta.yaml - source_roots: - - packages/google-cloud-maintenance-api - preserve_regex: - - packages/google-cloud-maintenance-api/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-maintenance-api/ - tag_format: '{id}-v{version}' - - id: google-cloud-managed-identities - version: 1.13.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/managedidentities/v1 - service_config: managedidentities_v1.yaml - source_roots: - - packages/google-cloud-managed-identities - preserve_regex: - - packages/google-cloud-managed-identities/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-managed-identities/ - tag_format: '{id}-v{version}' - - id: google-cloud-managedkafka - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/managedkafka/v1 - service_config: managedkafka_v1.yaml - source_roots: - - packages/google-cloud-managedkafka - preserve_regex: - - packages/google-cloud-managedkafka/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-managedkafka/ - tag_format: '{id}-v{version}' - - id: google-cloud-managedkafka-schemaregistry - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/managedkafka/schemaregistry/v1 - service_config: managedkafka_v1.yaml - source_roots: - - packages/google-cloud-managedkafka-schemaregistry - preserve_regex: - - packages/google-cloud-managedkafka-schemaregistry/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-managedkafka-schemaregistry/ - tag_format: '{id}-v{version}' - - id: google-cloud-media-translation - version: 0.12.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/mediatranslation/v1beta1 - service_config: mediatranslation_v1beta1.yaml - source_roots: - - packages/google-cloud-media-translation - preserve_regex: - - packages/google-cloud-media-translation/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-media-translation/ - tag_format: '{id}-v{version}' - - id: google-cloud-memcache - version: 1.13.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/memcache/v1 - service_config: memcache_v1.yaml - - path: google/cloud/memcache/v1beta2 - service_config: memcache_v1beta2.yaml - source_roots: - - packages/google-cloud-memcache - preserve_regex: - - packages/google-cloud-memcache/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-memcache/ - tag_format: '{id}-v{version}' - - id: google-cloud-memorystore - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/memorystore/v1beta - service_config: memorystore_v1beta.yaml - - path: google/cloud/memorystore/v1 - service_config: memorystore_v1.yaml - source_roots: - - packages/google-cloud-memorystore - preserve_regex: - - packages/google-cloud-memorystore/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-memorystore/ - tag_format: '{id}-v{version}' - - id: google-cloud-migrationcenter - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/migrationcenter/v1 - service_config: migrationcenter_v1.yaml - source_roots: - - packages/google-cloud-migrationcenter - preserve_regex: - - packages/google-cloud-migrationcenter/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-migrationcenter/ - tag_format: '{id}-v{version}' - - id: google-cloud-modelarmor - version: 0.3.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/modelarmor/v1beta - service_config: modelarmor_v1beta.yaml - - path: google/cloud/modelarmor/v1 - service_config: modelarmor_v1.yaml - source_roots: - - packages/google-cloud-modelarmor - preserve_regex: - - packages/google-cloud-modelarmor/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-modelarmor/ - tag_format: '{id}-v{version}' - - id: google-cloud-monitoring - version: 2.28.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/monitoring/v3 - service_config: monitoring.yaml - source_roots: - - packages/google-cloud-monitoring - preserve_regex: - - packages/google-cloud-monitoring/CHANGELOG.md - - docs/CHANGELOG.md - - docs/query.rst - - packages/google-cloud-monitoring/google/cloud/monitoring_v3/_dataframe.py - - packages/google-cloud-monitoring/google/cloud/monitoring_v3/query.py - - samples/README.txt - - samples/snippets/README.rst - - tests/system - - tests/unit/test__dataframe.py - - tests/unit/test_query.py - remove_regex: - - packages/google-cloud-monitoring - tag_format: '{id}-v{version}' - - id: google-cloud-monitoring-dashboards - version: 2.19.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/monitoring/dashboard/v1 - service_config: monitoring.yaml - source_roots: - - packages/google-cloud-monitoring-dashboards - preserve_regex: - - packages/google-cloud-monitoring-dashboards/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - - packages/google-cloud-monitoring-dashboards/google/monitoring - - tests/unit/gapic/dashboard_v1 - remove_regex: - - packages/google-cloud-monitoring-dashboards - tag_format: '{id}-v{version}' - - id: google-cloud-monitoring-metrics-scopes - version: 1.10.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/monitoring/metricsscope/v1 - service_config: monitoring.yaml - source_roots: - - packages/google-cloud-monitoring-metrics-scopes - preserve_regex: - - packages/google-cloud-monitoring-metrics-scopes/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-monitoring-metrics-scopes/ - tag_format: '{id}-v{version}' - - id: google-cloud-netapp - version: 0.4.0 - last_generated_commit: c9ff4f1cd26f1fe63e6d1c11a198366b70ebdb84 - apis: - - path: google/cloud/netapp/v1 - service_config: netapp_v1.yaml - source_roots: - - packages/google-cloud-netapp - preserve_regex: - - packages/google-cloud-netapp/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-netapp/ - tag_format: '{id}-v{version}' - - id: google-cloud-network-connectivity - version: 2.11.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/networkconnectivity/v1 - service_config: networkconnectivity_v1.yaml - - path: google/cloud/networkconnectivity/v1alpha1 - service_config: networkconnectivity_v1alpha1.yaml - source_roots: - - packages/google-cloud-network-connectivity - preserve_regex: - - packages/google-cloud-network-connectivity/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-network-connectivity/ - tag_format: '{id}-v{version}' - - id: google-cloud-network-management - version: 1.30.0 - last_generated_commit: 53f97391f3451398f7b53c7f86dabd325d205677 - apis: - - path: google/cloud/networkmanagement/v1 - service_config: networkmanagement_v1.yaml - source_roots: - - packages/google-cloud-network-management - preserve_regex: - - packages/google-cloud-network-management/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-network-management/ - tag_format: '{id}-v{version}' - - id: google-cloud-network-security - version: 0.9.21 - last_generated_commit: c9ff4f1cd26f1fe63e6d1c11a198366b70ebdb84 - apis: - - path: google/cloud/networksecurity/v1alpha1 - service_config: networksecurity_v1alpha1.yaml - - path: google/cloud/networksecurity/v1beta1 - service_config: networksecurity_v1beta1.yaml - - path: google/cloud/networksecurity/v1 - service_config: networksecurity_v1.yaml - source_roots: - - packages/google-cloud-network-security - preserve_regex: - - packages/google-cloud-network-security/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-network-security - tag_format: '{id}-v{version}' - - id: google-cloud-network-services - version: 0.7.0 - last_generated_commit: 53f97391f3451398f7b53c7f86dabd325d205677 - apis: - - path: google/cloud/networkservices/v1 - service_config: networkservices_v1.yaml - source_roots: - - packages/google-cloud-network-services - preserve_regex: - - packages/google-cloud-network-services/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-network-services/ - tag_format: '{id}-v{version}' - - id: google-cloud-notebooks - version: 1.14.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/notebooks/v1beta1 - service_config: notebooks_v1beta1.yaml - - path: google/cloud/notebooks/v1 - service_config: notebooks_v1.yaml - - path: google/cloud/notebooks/v2 - service_config: notebooks_v2.yaml - source_roots: - - packages/google-cloud-notebooks - preserve_regex: - - packages/google-cloud-notebooks/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-notebooks/ - tag_format: '{id}-v{version}' - - id: google-cloud-optimization - version: 1.12.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/optimization/v1 - service_config: cloudoptimization_v1.yaml - source_roots: - - packages/google-cloud-optimization - preserve_regex: - - packages/google-cloud-optimization/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-optimization/ - tag_format: '{id}-v{version}' - - id: google-cloud-oracledatabase - version: 0.3.0 - last_generated_commit: 94ccdfe4519e0ba817bd33aa22eb9c64f88a6874 - apis: - - path: google/cloud/oracledatabase/v1 - service_config: oracledatabase_v1.yaml - source_roots: - - packages/google-cloud-oracledatabase - preserve_regex: - - packages/google-cloud-oracledatabase/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-oracledatabase/ - tag_format: '{id}-v{version}' - - id: google-cloud-orchestration-airflow - version: 1.18.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/orchestration/airflow/service/v1 - service_config: composer_v1.yaml - - path: google/cloud/orchestration/airflow/service/v1beta1 - service_config: composer_v1beta1.yaml - source_roots: - - packages/google-cloud-orchestration-airflow - preserve_regex: - - packages/google-cloud-orchestration-airflow/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-orchestration-airflow/ - tag_format: '{id}-v{version}' - - id: google-cloud-org-policy - version: 1.15.0 - last_generated_commit: 55319b058f8a0e46bbeeff30e374e4b1f081f494 - apis: - - path: google/cloud/orgpolicy/v1 - service_config: "" - - path: google/cloud/orgpolicy/v2 - service_config: orgpolicy_v2.yaml - source_roots: - - packages/google-cloud-org-policy - preserve_regex: - - packages/google-cloud-org-policy/pytest.ini - - packages/google-cloud-org-policy/CHANGELOG.md - - google/cloud/orgpolicy/v1/__init__.py - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - - tests/unit/test_packaging.py - remove_regex: - - packages/google-cloud-org-policy - tag_format: '{id}-v{version}' - - id: google-cloud-os-config - version: 1.22.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/osconfig/v1alpha - service_config: osconfig_v1alpha.yaml - - path: google/cloud/osconfig/v1 - service_config: osconfig_v1.yaml - source_roots: - - packages/google-cloud-os-config - preserve_regex: - - packages/google-cloud-os-config/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-os-config/ - tag_format: '{id}-v{version}' - - id: google-cloud-os-login - version: 2.18.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/oslogin/v1 - service_config: oslogin_v1.yaml - source_roots: - - packages/google-cloud-os-login - preserve_regex: - - packages/google-cloud-os-login/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - - google/cloud/oslogin_v1/common - - docs/oslogin_v1/common/types.rst - remove_regex: - - packages/google-cloud-os-login - tag_format: '{id}-v{version}' - - id: google-cloud-parallelstore - version: 0.3.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/parallelstore/v1 - service_config: parallelstore_v1.yaml - - path: google/cloud/parallelstore/v1beta - service_config: parallelstore_v1beta.yaml - source_roots: - - packages/google-cloud-parallelstore - preserve_regex: - - packages/google-cloud-parallelstore/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-parallelstore/ - tag_format: '{id}-v{version}' - - id: google-cloud-parametermanager - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/parametermanager/v1 - service_config: parametermanager_v1.yaml - source_roots: - - packages/google-cloud-parametermanager - preserve_regex: - - packages/google-cloud-parametermanager/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-parametermanager/ - tag_format: '{id}-v{version}' - - id: google-cloud-phishing-protection - version: 1.15.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/phishingprotection/v1beta1 - service_config: phishingprotection_v1beta1.yaml - source_roots: - - packages/google-cloud-phishing-protection - preserve_regex: - - packages/google-cloud-phishing-protection/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-phishing-protection/ - tag_format: '{id}-v{version}' - - id: google-cloud-policy-troubleshooter - version: 1.14.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/policytroubleshooter/v1 - service_config: policytroubleshooter_v1.yaml - source_roots: - - packages/google-cloud-policy-troubleshooter - preserve_regex: - - packages/google-cloud-policy-troubleshooter/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-policy-troubleshooter/ - tag_format: '{id}-v{version}' - - id: google-cloud-policysimulator - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/policysimulator/v1 - service_config: policysimulator_v1.yaml - source_roots: - - packages/google-cloud-policysimulator - preserve_regex: - - packages/google-cloud-policysimulator/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-policysimulator/ - tag_format: '{id}-v{version}' - - id: google-cloud-policytroubleshooter-iam - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/policytroubleshooter/iam/v3 - service_config: policytroubleshooter_v3.yaml - source_roots: - - packages/google-cloud-policytroubleshooter-iam - preserve_regex: - - packages/google-cloud-policytroubleshooter-iam/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-policytroubleshooter-iam/ - tag_format: '{id}-v{version}' - - id: google-cloud-private-ca - version: 1.16.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/security/privateca/v1 - service_config: privateca_v1.yaml - - path: google/cloud/security/privateca/v1beta1 - service_config: privateca_v1beta1.yaml - source_roots: - - packages/google-cloud-private-ca - preserve_regex: - - packages/google-cloud-private-ca/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-private-ca/ - tag_format: '{id}-v{version}' - - id: google-cloud-private-catalog - version: 0.10.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/privatecatalog/v1beta1 - service_config: cloudprivatecatalog_v1beta1.yaml - source_roots: - - packages/google-cloud-private-catalog - preserve_regex: - - packages/google-cloud-private-catalog/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-private-catalog/ - tag_format: '{id}-v{version}' - - id: google-cloud-privilegedaccessmanager - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/privilegedaccessmanager/v1 - service_config: privilegedaccessmanager_v1.yaml - source_roots: - - packages/google-cloud-privilegedaccessmanager - preserve_regex: - - packages/google-cloud-privilegedaccessmanager/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-privilegedaccessmanager/ - tag_format: '{id}-v{version}' - - id: google-cloud-quotas - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/api/cloudquotas/v1 - service_config: cloudquotas_v1.yaml - - path: google/api/cloudquotas/v1beta - service_config: cloudquotas_v1beta.yaml - source_roots: - - packages/google-cloud-quotas - preserve_regex: - - packages/google-cloud-quotas/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-quotas/ - tag_format: '{id}-v{version}' - - id: google-cloud-rapidmigrationassessment - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/rapidmigrationassessment/v1 - service_config: rapidmigrationassessment_v1.yaml - source_roots: - - packages/google-cloud-rapidmigrationassessment - preserve_regex: - - packages/google-cloud-rapidmigrationassessment/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-rapidmigrationassessment/ - tag_format: '{id}-v{version}' - - id: google-cloud-recaptcha-enterprise - version: 1.29.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/recaptchaenterprise/v1 - service_config: recaptchaenterprise_v1.yaml - source_roots: - - packages/google-cloud-recaptcha-enterprise - preserve_regex: - - packages/google-cloud-recaptcha-enterprise/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-recaptcha-enterprise/ - tag_format: '{id}-v{version}' - - id: google-cloud-recommendations-ai - version: 0.11.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/recommendationengine/v1beta1 - service_config: recommendationengine_v1beta1.yaml - source_roots: - - packages/google-cloud-recommendations-ai - preserve_regex: - - packages/google-cloud-recommendations-ai/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-recommendations-ai/ - tag_format: '{id}-v{version}' - - id: google-cloud-recommender - version: 2.19.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/recommender/v1beta1 - service_config: recommender_v1beta1.yaml - - path: google/cloud/recommender/v1 - service_config: recommender_v1.yaml - source_roots: - - packages/google-cloud-recommender - preserve_regex: - - packages/google-cloud-recommender/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-recommender/ - tag_format: '{id}-v{version}' - - id: google-cloud-redis - version: 2.19.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/redis/v1 - service_config: redis_v1.yaml - - path: google/cloud/redis/v1beta1 - service_config: redis_v1beta1.yaml - source_roots: - - packages/google-cloud-redis - preserve_regex: - - packages/google-cloud-redis/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-redis/ - tag_format: '{id}-v{version}' - - id: google-cloud-redis-cluster - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/redis/cluster/v1 - service_config: redis_v1.yaml - - path: google/cloud/redis/cluster/v1beta1 - service_config: redis_v1beta1.yaml - source_roots: - - packages/google-cloud-redis-cluster - preserve_regex: - - packages/google-cloud-redis-cluster/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-redis-cluster/ - tag_format: '{id}-v{version}' - - id: google-cloud-resource-manager - version: 1.15.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/resourcemanager/v3 - service_config: cloudresourcemanager_v3.yaml - source_roots: - - packages/google-cloud-resource-manager - preserve_regex: - - packages/google-cloud-resource-manager/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-resource-manager/ - tag_format: '{id}-v{version}' - - id: google-cloud-retail - version: 2.7.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/retail/v2 - service_config: retail_v2.yaml - - path: google/cloud/retail/v2alpha - service_config: retail_v2alpha.yaml - - path: google/cloud/retail/v2beta - service_config: retail_v2beta.yaml - source_roots: - - packages/google-cloud-retail - preserve_regex: - - packages/google-cloud-retail/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-retail/ - tag_format: '{id}-v{version}' - - id: google-cloud-run - version: 0.12.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/run/v2 - service_config: run_v2.yaml - source_roots: - - packages/google-cloud-run - preserve_regex: - - packages/google-cloud-run/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-run/ - tag_format: '{id}-v{version}' - - id: google-cloud-saasplatform-saasservicemgmt - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/saasplatform/saasservicemgmt/v1beta1 - service_config: saasservicemgmt_v1beta1.yaml - source_roots: - - packages/google-cloud-saasplatform-saasservicemgmt - preserve_regex: - - packages/google-cloud-saasplatform-saasservicemgmt/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-saasplatform-saasservicemgmt/ - tag_format: '{id}-v{version}' - - id: google-cloud-scheduler - version: 2.17.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/scheduler/v1 - service_config: cloudscheduler_v1.yaml - - path: google/cloud/scheduler/v1beta1 - service_config: cloudscheduler_v1beta1.yaml - source_roots: - - packages/google-cloud-scheduler - preserve_regex: - - packages/google-cloud-scheduler/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-scheduler/ - tag_format: '{id}-v{version}' - - id: google-cloud-secret-manager - version: 2.25.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/secretmanager/v1 - service_config: secretmanager_v1.yaml - - path: google/cloud/secretmanager/v1beta2 - service_config: secretmanager_v1beta2.yaml - - path: google/cloud/secrets/v1beta1 - service_config: secretmanager_v1beta1.yaml - source_roots: - - packages/google-cloud-secret-manager - preserve_regex: - - packages/google-cloud-secret-manager/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-secret-manager - tag_format: '{id}-v{version}' - - id: google-cloud-securesourcemanager - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/securesourcemanager/v1 - service_config: securesourcemanager_v1.yaml - source_roots: - - packages/google-cloud-securesourcemanager - preserve_regex: - - packages/google-cloud-securesourcemanager/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-securesourcemanager/ - tag_format: '{id}-v{version}' - - id: google-cloud-security-publicca - version: 0.4.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/security/publicca/v1 - service_config: publicca_v1.yaml - - path: google/cloud/security/publicca/v1beta1 - service_config: publicca_v1beta1.yaml - source_roots: - - packages/google-cloud-security-publicca - preserve_regex: - - packages/google-cloud-security-publicca/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-security-publicca/ - tag_format: '{id}-v{version}' - - id: google-cloud-securitycenter - version: 1.41.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/securitycenter/v2 - service_config: securitycenter_v2.yaml - - path: google/cloud/securitycenter/v1p1beta1 - service_config: securitycenter_v1p1beta1.yaml - - path: google/cloud/securitycenter/v1beta1 - service_config: securitycenter_v1beta1.yaml - - path: google/cloud/securitycenter/v1 - service_config: securitycenter_v1.yaml - source_roots: - - packages/google-cloud-securitycenter - preserve_regex: - - packages/google-cloud-securitycenter/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-securitycenter/ - tag_format: '{id}-v{version}' - - id: google-cloud-securitycentermanagement - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/securitycentermanagement/v1 - service_config: securitycentermanagement_v1.yaml - source_roots: - - packages/google-cloud-securitycentermanagement - preserve_regex: - - packages/google-cloud-securitycentermanagement/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-securitycentermanagement/ - tag_format: '{id}-v{version}' - - id: google-cloud-service-control - version: 1.17.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/api/servicecontrol/v2 - service_config: servicecontrol.yaml - - path: google/api/servicecontrol/v1 - service_config: servicecontrol.yaml - source_roots: - - packages/google-cloud-service-control - preserve_regex: - - packages/google-cloud-service-control/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-service-control/ - tag_format: '{id}-v{version}' - - id: google-cloud-service-directory - version: 1.15.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/servicedirectory/v1 - service_config: servicedirectory_v1.yaml - - path: google/cloud/servicedirectory/v1beta1 - service_config: servicedirectory_v1beta1.yaml - source_roots: - - packages/google-cloud-service-directory - preserve_regex: - - packages/google-cloud-service-directory/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-service-directory/ - tag_format: '{id}-v{version}' - - id: google-cloud-service-management - version: 1.14.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/api/servicemanagement/v1 - service_config: servicemanagement_v1.yaml - source_roots: - - packages/google-cloud-service-management - preserve_regex: - - packages/google-cloud-service-management/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-service-management/ - tag_format: '{id}-v{version}' - - id: google-cloud-service-usage - version: 1.14.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/api/serviceusage/v1 - service_config: serviceusage_v1.yaml - source_roots: - - packages/google-cloud-service-usage - preserve_regex: - - packages/google-cloud-service-usage/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-service-usage/ - tag_format: '{id}-v{version}' - - id: google-cloud-servicehealth - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/servicehealth/v1 - service_config: servicehealth_v1.yaml - source_roots: - - packages/google-cloud-servicehealth - preserve_regex: - - packages/google-cloud-servicehealth/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-servicehealth/ - tag_format: '{id}-v{version}' - - id: google-cloud-shell - version: 1.13.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/shell/v1 - service_config: cloudshell_v1.yaml - source_roots: - - packages/google-cloud-shell - preserve_regex: - - packages/google-cloud-shell/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-shell/ - tag_format: '{id}-v{version}' - - id: google-cloud-source-context - version: 1.8.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/devtools/source/v1 - service_config: "" - source_roots: - - packages/google-cloud-source-context - preserve_regex: - - packages/google-cloud-source-context/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - - tests/unit/gapic/source_context_v1/test_source_context_v1.py - remove_regex: - - packages/google-cloud-source-context/ - tag_format: '{id}-v{version}' - - id: google-cloud-speech - version: 2.34.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/speech/v1 - service_config: speech_v1.yaml - - path: google/cloud/speech/v2 - service_config: speech_v2.yaml - - path: google/cloud/speech/v1p1beta1 - service_config: speech_v1p1beta1.yaml - source_roots: - - packages/google-cloud-speech - preserve_regex: - - packages/google-cloud-speech/CHANGELOG.md - - docs/CHANGELOG.md - - google/cloud/speech_v1/helpers.py - - samples/README.txt - - samples/snippets/README.rst - - tests/system - - tests/unit/test_helpers.py - remove_regex: - - packages/google-cloud-speech/ - tag_format: '{id}-v{version}' - - id: google-cloud-storage-control - version: 1.8.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/storage/control/v2 - service_config: storage_v2.yaml - source_roots: - - packages/google-cloud-storage-control - preserve_regex: - - packages/google-cloud-storage-control/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-storage-control/ - tag_format: '{id}-v{version}' - - id: google-cloud-storage-transfer - version: 1.18.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/storagetransfer/v1 - service_config: storagetransfer_v1.yaml - source_roots: - - packages/google-cloud-storage-transfer - preserve_regex: - - packages/google-cloud-storage-transfer/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-storage-transfer/ - tag_format: '{id}-v{version}' - - id: google-cloud-storagebatchoperations - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/storagebatchoperations/v1 - service_config: storagebatchoperations_v1.yaml - source_roots: - - packages/google-cloud-storagebatchoperations - preserve_regex: - - packages/google-cloud-storagebatchoperations/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-storagebatchoperations/ - tag_format: '{id}-v{version}' - - id: google-cloud-storageinsights - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/storageinsights/v1 - service_config: storageinsights_v1.yaml - source_roots: - - packages/google-cloud-storageinsights - preserve_regex: - - packages/google-cloud-storageinsights/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-storageinsights/ - tag_format: '{id}-v{version}' - - id: google-cloud-support - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/support/v2beta - service_config: cloudsupport_v2beta.yaml - - path: google/cloud/support/v2 - service_config: cloudsupport_v2.yaml - source_roots: - - packages/google-cloud-support - preserve_regex: - - packages/google-cloud-support/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-support/ - tag_format: '{id}-v{version}' - - id: google-cloud-talent - version: 2.18.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/talent/v4beta1 - service_config: jobs_v4beta1.yaml - - path: google/cloud/talent/v4 - service_config: jobs_v4.yaml - source_roots: - - packages/google-cloud-talent - preserve_regex: - - packages/google-cloud-talent/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-talent/ - tag_format: '{id}-v{version}' - - id: google-cloud-tasks - version: 2.20.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/tasks/v2beta2 - service_config: cloudtasks_v2beta2.yaml - - path: google/cloud/tasks/v2beta3 - service_config: cloudtasks_v2beta3.yaml - - path: google/cloud/tasks/v2 - service_config: cloudtasks_v2.yaml - source_roots: - - packages/google-cloud-tasks - preserve_regex: - - packages/google-cloud-tasks/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - snippets/README.md - - tests/system - remove_regex: - - packages/google-cloud-tasks/ - tag_format: '{id}-v{version}' - - id: google-cloud-telcoautomation - version: 0.3.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/telcoautomation/v1 - service_config: telcoautomation_v1.yaml - - path: google/cloud/telcoautomation/v1alpha1 - service_config: telcoautomation_v1alpha1.yaml - source_roots: - - packages/google-cloud-telcoautomation - preserve_regex: - - packages/google-cloud-telcoautomation/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - snippets/README.md - - tests/system - remove_regex: - - packages/google-cloud-telcoautomation/ - tag_format: '{id}-v{version}' - - id: google-cloud-texttospeech - version: 2.33.0 - last_generated_commit: c288189b43c016dd3cf1ec73ce3cadee8b732f07 - apis: - - path: google/cloud/texttospeech/v1 - service_config: texttospeech_v1.yaml - - path: google/cloud/texttospeech/v1beta1 - service_config: texttospeech_v1beta1.yaml - source_roots: - - packages/google-cloud-texttospeech - preserve_regex: - - packages/google-cloud-texttospeech/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-texttospeech/ - tag_format: '{id}-v{version}' - - id: google-cloud-tpu - version: 1.24.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/tpu/v2alpha1 - service_config: tpu_v2alpha1.yaml - - path: google/cloud/tpu/v2 - service_config: tpu_v2.yaml - - path: google/cloud/tpu/v1 - service_config: tpu_v1.yaml - source_roots: - - packages/google-cloud-tpu - preserve_regex: - - packages/google-cloud-tpu/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-tpu/ - tag_format: '{id}-v{version}' - - id: google-cloud-trace - version: 1.17.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/devtools/cloudtrace/v2 - service_config: cloudtrace_v2.yaml - - path: google/devtools/cloudtrace/v1 - service_config: cloudtrace_v1.yaml - source_roots: - - packages/google-cloud-trace - preserve_regex: - - packages/google-cloud-trace/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-trace/ - tag_format: '{id}-v{version}' - - id: google-cloud-translate - version: 3.23.0 - last_generated_commit: 53f97391f3451398f7b53c7f86dabd325d205677 - apis: - - path: google/cloud/translate/v3beta1 - service_config: translate_v3beta1.yaml - - path: google/cloud/translate/v3 - service_config: translate_v3.yaml - source_roots: - - packages/google-cloud-translate - preserve_regex: - - packages/google-cloud-translate/CHANGELOG.md - - docs/CHANGELOG.md - - docs/client.rst - - docs/v2.rst - - google/cloud/translate_v2 - - samples/README.txt - - samples/snippets/README.rst - - tests/system - - tests/unit/v2 - remove_regex: - - packages/google-cloud-translate/ - tag_format: '{id}-v{version}' - - id: google-cloud-vectorsearch - version: 0.2.0 - last_generated_commit: ded7ed1e4cce7c165c56a417572cebea9bc1d82c - apis: - - path: google/cloud/vectorsearch/v1beta - service_config: vectorsearch_v1beta.yaml - source_roots: - - packages/google-cloud-vectorsearch - preserve_regex: - - packages/google-cloud-vectorsearch/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-vectorsearch - tag_format: '{id}-v{version}' - - id: google-cloud-video-live-stream - version: 1.14.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/video/livestream/v1 - service_config: livestream_v1.yaml - source_roots: - - packages/google-cloud-video-live-stream - preserve_regex: - - packages/google-cloud-video-live-stream/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-video-live-stream/ - tag_format: '{id}-v{version}' - - id: google-cloud-video-stitcher - version: 0.9.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/video/stitcher/v1 - service_config: videostitcher_v1.yaml - source_roots: - - packages/google-cloud-video-stitcher - preserve_regex: - - packages/google-cloud-video-stitcher/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-video-stitcher/ - tag_format: '{id}-v{version}' - - id: google-cloud-video-transcoder - version: 1.18.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/video/transcoder/v1 - service_config: transcoder_v1.yaml - source_roots: - - packages/google-cloud-video-transcoder - preserve_regex: - - packages/google-cloud-video-transcoder/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-video-transcoder/ - tag_format: '{id}-v{version}' - - id: google-cloud-videointelligence - version: 2.17.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/videointelligence/v1p3beta1 - service_config: videointelligence_v1p3beta1.yaml - - path: google/cloud/videointelligence/v1 - service_config: videointelligence_v1.yaml - - path: google/cloud/videointelligence/v1p2beta1 - service_config: videointelligence_v1p2beta1.yaml - - path: google/cloud/videointelligence/v1p1beta1 - service_config: videointelligence_v1p1beta1.yaml - - path: google/cloud/videointelligence/v1beta2 - service_config: videointelligence_v1beta2.yaml - source_roots: - - packages/google-cloud-videointelligence - preserve_regex: - - packages/google-cloud-videointelligence/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-videointelligence/ - tag_format: '{id}-v{version}' - - id: google-cloud-vision - version: 3.11.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/vision/v1p3beta1 - service_config: vision_v1p3beta1.yaml - - path: google/cloud/vision/v1 - service_config: vision_v1.yaml - - path: google/cloud/vision/v1p1beta1 - service_config: vision_v1p1beta1.yaml - - path: google/cloud/vision/v1p2beta1 - service_config: vision_v1p2beta1.yaml - - path: google/cloud/vision/v1p4beta1 - service_config: vision_v1p4beta1.yaml - source_roots: - - packages/google-cloud-vision - preserve_regex: - - packages/google-cloud-vision/CHANGELOG.md - - docs/CHANGELOG.md - - google/cloud/vision_helpers - - samples/README.txt - - samples/snippets/README.rst - - tests/system - - tests/unit/test_decorators.py - - tests/unit/test_helpers.py - remove_regex: - - packages/google-cloud-vision/ - tag_format: '{id}-v{version}' - - id: google-cloud-visionai - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/visionai/v1alpha1 - service_config: visionai_v1alpha1.yaml - - path: google/cloud/visionai/v1 - service_config: visionai_v1.yaml - source_roots: - - packages/google-cloud-visionai - preserve_regex: - - packages/google-cloud-visionai/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-visionai/ - tag_format: '{id}-v{version}' - - id: google-cloud-vm-migration - version: 1.13.0 - last_generated_commit: a17b84add8318f780fcc8a027815d5fee644b9f7 - apis: - - path: google/cloud/vmmigration/v1 - service_config: vmmigration_v1.yaml - source_roots: - - packages/google-cloud-vm-migration - preserve_regex: - - packages/google-cloud-vm-migration/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-vm-migration/ - tag_format: '{id}-v{version}' - - id: google-cloud-vmwareengine - version: 1.9.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/vmwareengine/v1 - service_config: vmwareengine_v1.yaml - source_roots: - - packages/google-cloud-vmwareengine - preserve_regex: - - packages/google-cloud-vmwareengine/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-vmwareengine/ - tag_format: '{id}-v{version}' - - id: google-cloud-vpc-access - version: 1.14.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/vpcaccess/v1 - service_config: vpcaccess_v1.yaml - source_roots: - - packages/google-cloud-vpc-access - preserve_regex: - - packages/google-cloud-vpc-access/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-vpc-access/ - tag_format: '{id}-v{version}' - - id: google-cloud-webrisk - version: 1.19.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/webrisk/v1beta1 - service_config: webrisk_v1beta1.yaml - - path: google/cloud/webrisk/v1 - service_config: webrisk_v1.yaml - source_roots: - - packages/google-cloud-webrisk - preserve_regex: - - packages/google-cloud-webrisk/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-webrisk/ - tag_format: '{id}-v{version}' - - id: google-cloud-websecurityscanner - version: 1.18.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/websecurityscanner/v1alpha - service_config: websecurityscanner_v1alpha.yaml - - path: google/cloud/websecurityscanner/v1beta - service_config: websecurityscanner_v1beta.yaml - - path: google/cloud/websecurityscanner/v1 - service_config: websecurityscanner_v1.yaml - source_roots: - - packages/google-cloud-websecurityscanner - preserve_regex: - - packages/google-cloud-websecurityscanner/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-websecurityscanner/ - tag_format: '{id}-v{version}' - - id: google-cloud-workflows - version: 1.19.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/workflows/executions/v1 - service_config: workflowexecutions_v1.yaml - - path: google/cloud/workflows/executions/v1beta - service_config: workflowexecutions_v1beta.yaml - - path: google/cloud/workflows/v1 - service_config: workflows_v1.yaml - - path: google/cloud/workflows/v1beta - service_config: workflows_v1beta.yaml - source_roots: - - packages/google-cloud-workflows - preserve_regex: - - packages/google-cloud-workflows/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-workflows/ - tag_format: '{id}-v{version}' - - id: google-cloud-workstations - version: 0.6.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/cloud/workstations/v1beta - service_config: workstations_v1beta.yaml - - path: google/cloud/workstations/v1 - service_config: workstations_v1.yaml - source_roots: - - packages/google-cloud-workstations - preserve_regex: - - packages/google-cloud-workstations/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-cloud-workstations/ - tag_format: '{id}-v{version}' - - id: google-geo-type - version: 0.4.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/geo/type - service_config: type_geo.yaml - source_roots: - - packages/google-geo-type - preserve_regex: - - packages/google-geo-type/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - - tests/unit/gapic/type/test_type.py - remove_regex: - - packages/google-geo-type - tag_format: '{id}-v{version}' - - id: google-maps-addressvalidation - version: 0.4.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/maps/addressvalidation/v1 - service_config: addressvalidation_v1.yaml - source_roots: - - packages/google-maps-addressvalidation - preserve_regex: - - packages/google-maps-addressvalidation/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-maps-addressvalidation - tag_format: '{id}-v{version}' - - id: google-maps-areainsights - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/maps/areainsights/v1 - service_config: areainsights_v1.yaml - source_roots: - - packages/google-maps-areainsights - preserve_regex: - - packages/google-maps-areainsights/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-maps-areainsights - tag_format: '{id}-v{version}' - - id: google-maps-fleetengine - version: 0.3.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/maps/fleetengine/v1 - service_config: fleetengine_v1.yaml - source_roots: - - packages/google-maps-fleetengine - preserve_regex: - - packages/google-maps-fleetengine/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-maps-fleetengine - tag_format: '{id}-v{version}' - - id: google-maps-fleetengine-delivery - version: 0.3.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/maps/fleetengine/delivery/v1 - service_config: fleetengine_v1.yaml - source_roots: - - packages/google-maps-fleetengine-delivery - preserve_regex: - - packages/google-maps-fleetengine-delivery/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-maps-fleetengine-delivery - tag_format: '{id}-v{version}' - - id: google-maps-mapsplatformdatasets - version: 0.5.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/maps/mapsplatformdatasets/v1 - service_config: mapsplatformdatasets_v1.yaml - source_roots: - - packages/google-maps-mapsplatformdatasets - preserve_regex: - - packages/google-maps-mapsplatformdatasets/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-maps-mapsplatformdatasets - tag_format: '{id}-v{version}' - - id: google-maps-places - version: 0.5.0 - last_generated_commit: e8365a7f88fabe8717cb8322b8ce784b03b6daea - apis: - - path: google/maps/places/v1 - service_config: places_v1.yaml - source_roots: - - packages/google-maps-places - preserve_regex: - - packages/google-maps-places/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-maps-places - tag_format: '{id}-v{version}' - - id: google-maps-routeoptimization - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/maps/routeoptimization/v1 - service_config: routeoptimization_v1.yaml - source_roots: - - packages/google-maps-routeoptimization - preserve_regex: - - packages/google-maps-routeoptimization/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/README.rst - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-maps-routeoptimization - tag_format: '{id}-v{version}' - - id: google-maps-routing - version: 0.7.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/maps/routing/v2 - service_config: routes_v2.yaml - source_roots: - - packages/google-maps-routing - preserve_regex: - - packages/google-maps-routing/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-maps-routing - tag_format: '{id}-v{version}' - - id: google-maps-solar - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/maps/solar/v1 - service_config: solar_v1.yaml - source_roots: - - packages/google-maps-solar - preserve_regex: - - packages/google-maps-solar/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-maps-solar - tag_format: '{id}-v{version}' - - id: google-shopping-css - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/shopping/css/v1 - service_config: css_v1.yaml - source_roots: - - packages/google-shopping-css - preserve_regex: - - packages/google-shopping-css/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-shopping-css/ - tag_format: '{id}-v{version}' - - id: google-shopping-merchant-accounts - version: 1.1.0 - last_generated_commit: a17b84add8318f780fcc8a027815d5fee644b9f7 - apis: - - path: google/shopping/merchant/accounts/v1 - service_config: merchantapi_v1.yaml - - path: google/shopping/merchant/accounts/v1beta - service_config: merchantapi_v1beta.yaml - source_roots: - - packages/google-shopping-merchant-accounts - preserve_regex: - - packages/google-shopping-merchant-accounts/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-shopping-merchant-accounts/ - tag_format: '{id}-v{version}' - - id: google-shopping-merchant-conversions - version: 1.1.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/shopping/merchant/conversions/v1 - service_config: merchantapi_v1.yaml - - path: google/shopping/merchant/conversions/v1beta - service_config: merchantapi_v1beta.yaml - source_roots: - - packages/google-shopping-merchant-conversions - preserve_regex: - - packages/google-shopping-merchant-conversions/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-shopping-merchant-conversions/ - tag_format: '{id}-v{version}' - - id: google-shopping-merchant-datasources - version: 1.2.0 - last_generated_commit: 53f97391f3451398f7b53c7f86dabd325d205677 - apis: - - path: google/shopping/merchant/datasources/v1 - service_config: merchantapi_v1.yaml - - path: google/shopping/merchant/datasources/v1beta - service_config: merchantapi_v1beta.yaml - source_roots: - - packages/google-shopping-merchant-datasources - preserve_regex: - - packages/google-shopping-merchant-datasources/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-shopping-merchant-datasources/ - tag_format: '{id}-v{version}' - - id: google-shopping-merchant-inventories - version: 1.1.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/shopping/merchant/inventories/v1beta - service_config: merchantapi_v1beta.yaml - - path: google/shopping/merchant/inventories/v1 - service_config: merchantapi_v1.yaml - source_roots: - - packages/google-shopping-merchant-inventories - preserve_regex: - - packages/google-shopping-merchant-inventories/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-shopping-merchant-inventories/ - tag_format: '{id}-v{version}' - - id: google-shopping-merchant-issueresolution - version: 1.1.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/shopping/merchant/issueresolution/v1 - service_config: merchantapi_v1.yaml - - path: google/shopping/merchant/issueresolution/v1beta - service_config: merchantapi_v1beta.yaml - source_roots: - - packages/google-shopping-merchant-issueresolution - preserve_regex: - - packages/google-shopping-merchant-issueresolution/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-shopping-merchant-issueresolution/ - tag_format: '{id}-v{version}' - - id: google-shopping-merchant-lfp - version: 1.1.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/shopping/merchant/lfp/v1beta - service_config: merchantapi_v1beta.yaml - - path: google/shopping/merchant/lfp/v1 - service_config: merchantapi_v1.yaml - source_roots: - - packages/google-shopping-merchant-lfp - preserve_regex: - - packages/google-shopping-merchant-lfp/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-shopping-merchant-lfp/ - tag_format: '{id}-v{version}' - - id: google-shopping-merchant-notifications - version: 1.1.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/shopping/merchant/notifications/v1 - service_config: merchantapi_v1.yaml - - path: google/shopping/merchant/notifications/v1beta - service_config: merchantapi_v1beta.yaml - source_roots: - - packages/google-shopping-merchant-notifications - preserve_regex: - - packages/google-shopping-merchant-notifications/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-shopping-merchant-notifications/ - tag_format: '{id}-v{version}' - - id: google-shopping-merchant-ordertracking - version: 1.1.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/shopping/merchant/ordertracking/v1 - service_config: merchantapi_v1.yaml - - path: google/shopping/merchant/ordertracking/v1beta - service_config: merchantapi_v1beta.yaml - source_roots: - - packages/google-shopping-merchant-ordertracking - preserve_regex: - - packages/google-shopping-merchant-ordertracking/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-shopping-merchant-ordertracking/ - tag_format: '{id}-v{version}' - - id: google-shopping-merchant-products - version: 1.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/shopping/merchant/products/v1 - service_config: merchantapi_v1.yaml - - path: google/shopping/merchant/products/v1beta - service_config: merchantapi_v1beta.yaml - source_roots: - - packages/google-shopping-merchant-products - preserve_regex: - - packages/google-shopping-merchant-products/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-shopping-merchant-products/ - tag_format: '{id}-v{version}' - - id: google-shopping-merchant-productstudio - version: 0.2.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/shopping/merchant/productstudio/v1alpha - service_config: merchantapi_v1alpha.yaml - source_roots: - - packages/google-shopping-merchant-productstudio - preserve_regex: - - packages/google-shopping-merchant-productstudio/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-shopping-merchant-productstudio/ - tag_format: '{id}-v{version}' - - id: google-shopping-merchant-promotions - version: 1.1.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/shopping/merchant/promotions/v1 - service_config: merchantapi_v1.yaml - - path: google/shopping/merchant/promotions/v1beta - service_config: merchantapi_v1beta.yaml - source_roots: - - packages/google-shopping-merchant-promotions - preserve_regex: - - packages/google-shopping-merchant-promotions/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-shopping-merchant-promotions/ - tag_format: '{id}-v{version}' - - id: google-shopping-merchant-quota - version: 1.1.0 - last_generated_commit: c2db528a3e4d12b95666c719ee0db30a3d4c78ad - apis: - - path: google/shopping/merchant/quota/v1beta - service_config: merchantapi_v1beta.yaml - - path: google/shopping/merchant/quota/v1 - service_config: merchantapi_v1.yaml - source_roots: - - packages/google-shopping-merchant-quota - preserve_regex: - - packages/google-shopping-merchant-quota/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-shopping-merchant-quota/ - tag_format: '{id}-v{version}' - - id: google-shopping-merchant-reports - version: 1.1.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/shopping/merchant/reports/v1beta - service_config: merchantapi_v1beta.yaml - - path: google/shopping/merchant/reports/v1 - service_config: merchantapi_v1.yaml - - path: google/shopping/merchant/reports/v1alpha - service_config: merchantapi_v1alpha.yaml - source_roots: - - packages/google-shopping-merchant-reports - preserve_regex: - - packages/google-shopping-merchant-reports/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-shopping-merchant-reports/ - tag_format: '{id}-v{version}' - - id: google-shopping-merchant-reviews - version: 0.3.0 - last_generated_commit: 3322511885371d2b2253f209ccc3aa60d4100cfd - apis: - - path: google/shopping/merchant/reviews/v1beta - service_config: merchantapi_v1beta.yaml - source_roots: - - packages/google-shopping-merchant-reviews - preserve_regex: - - packages/google-shopping-merchant-reviews/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - remove_regex: - - packages/google-shopping-merchant-reviews/ - tag_format: '{id}-v{version}' - - id: google-shopping-type - version: 1.1.0 - last_generated_commit: a17b84add8318f780fcc8a027815d5fee644b9f7 - apis: - - path: google/shopping/type - service_config: "" - source_roots: - - packages/google-shopping-type - preserve_regex: - - packages/google-shopping-type/CHANGELOG.md - - docs/CHANGELOG.md - - samples/README.txt - - samples/snippets/README.rst - - tests/system - - tests/unit/gapic/type/test_type.py - remove_regex: - - packages/google-shopping-type/ - tag_format: '{id}-v{version}' - - id: googleapis-common-protos - version: 1.72.0 - last_generated_commit: c9ff4f1cd26f1fe63e6d1c11a198366b70ebdb84 - apis: - - path: google/api - service_config: serviceconfig.yaml - - path: google/cloud - service_config: "" - - path: google/cloud/location - service_config: cloud.yaml - - path: google/logging/type - service_config: "" - - path: google/rpc - service_config: rpc_publish.yaml - - path: google/rpc/context - service_config: "" - - path: google/type - service_config: type.yaml - source_roots: - - packages/googleapis-common-protos - preserve_regex: [] - remove_regex: - - ^packages/googleapis-common-protos/google/(?:api|cloud|logging|rpc|type)/.*(?:\.proto|_pb2\.(?:py|pyi))$ - - .repo-metadata.json - - README.rst - - docs/summary_overview.md - tag_format: '{id}-v{version}' - - id: grafeas - version: 1.16.0 - last_generated_commit: e8365a7f88fabe8717cb8322b8ce784b03b6daea + - id: google-cloud-discoveryengine + version: 0.15.0 + last_generated_commit: c288189b43c016dd3cf1ec73ce3cadee8b732f07 apis: - - path: grafeas/v1 - service_config: grafeas_v1.yaml + - path: google/cloud/discoveryengine/v1 + service_config: discoveryengine_v1.yaml + - path: google/cloud/discoveryengine/v1beta + service_config: discoveryengine_v1beta.yaml + - path: google/cloud/discoveryengine/v1alpha + service_config: discoveryengine_v1alpha.yaml source_roots: - - packages/grafeas + - packages/google-cloud-discoveryengine preserve_regex: - - packages/grafeas/CHANGELOG.md + - packages/google-cloud-discoveryengine/CHANGELOG.md - docs/CHANGELOG.md - samples/README.txt - samples/snippets/README.rst - tests/system - - grafeas/grafeas\.py - - ^packages/grafeas/grafeas/__init__.py - - grafeas/grafeas/grafeas_v1/types.py remove_regex: - - packages/grafeas - tag_format: '{id}-v{version}' - - id: grpc-google-iam-v1 - version: 0.14.2 - last_generated_commit: e8365a7f88fabe8717cb8322b8ce784b03b6daea - apis: - - path: google/iam/v1 - service_config: iam_meta_api.yaml - source_roots: - - packages/grpc-google-iam-v1/ - preserve_regex: [] - remove_regex: - - ^packages/grpc-google-iam-v1/google/iam/v1/[^/]*(?:\.proto|_pb2\.(?:py|pyi))$ - - .repo-metadata.json - - README.rst - - docs/summary_overview.md - tag_format: '{id}-v{version}' + - packages/google-cloud-discoveryengine/ + tag_format: '{id}-v{version}' \ No newline at end of file diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine/gapic_version.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine/gapic_version.py index 6b356a66811e..fd79d4e761b7 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine/gapic_version.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "0.15.0" # {x-release-please-version} +__version__ = "0.4.0" # {x-release-please-version} diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/gapic_version.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/gapic_version.py index 6b356a66811e..fd79d4e761b7 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/gapic_version.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "0.15.0" # {x-release-please-version} +__version__ = "0.4.0" # {x-release-please-version} diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/assistant_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/assistant_service/async_client.py index 53976232bc61..ae7425821392 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/assistant_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/assistant_service/async_client.py @@ -345,7 +345,8 @@ async def sample_stream_assist(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.StreamAssistRequest, dict]]): The request object. Request for the - [AssistantService.StreamAssist][google.cloud.discoveryengine.v1.AssistantService.StreamAssist] + `AssistantService.StreamAssist + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -358,8 +359,9 @@ async def sample_stream_assist(): Returns: AsyncIterable[google.cloud.discoveryengine_v1.types.StreamAssistResponse]: Response for the - [AssistantService.StreamAssist][google.cloud.discoveryengine.v1.AssistantService.StreamAssist] - method. + `AssistantService.StreamAssist + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/assistant_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/assistant_service/client.py index be979d2572c3..f46d111827c1 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/assistant_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/assistant_service/client.py @@ -862,7 +862,8 @@ def sample_stream_assist(): Args: request (Union[google.cloud.discoveryengine_v1.types.StreamAssistRequest, dict]): The request object. Request for the - [AssistantService.StreamAssist][google.cloud.discoveryengine.v1.AssistantService.StreamAssist] + `AssistantService.StreamAssist + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -875,8 +876,9 @@ def sample_stream_assist(): Returns: Iterable[google.cloud.discoveryengine_v1.types.StreamAssistResponse]: Response for the - [AssistantService.StreamAssist][google.cloud.discoveryengine.v1.AssistantService.StreamAssist] - method. + `AssistantService.StreamAssist + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/assistant_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/assistant_service/transports/rest.py index 49ba60e14f26..01b2ba3a50fc 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/assistant_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/assistant_service/transports/rest.py @@ -343,7 +343,8 @@ def __call__( Args: request (~.assistant_service.StreamAssistRequest): The request object. Request for the - [AssistantService.StreamAssist][google.cloud.discoveryengine.v1.AssistantService.StreamAssist] + `AssistantService.StreamAssist + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -356,7 +357,8 @@ def __call__( Returns: ~.assistant_service.StreamAssistResponse: Response for the - [AssistantService.StreamAssist][google.cloud.discoveryengine.v1.AssistantService.StreamAssist] + `AssistantService.StreamAssist + `__ method. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/cmek_config_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/cmek_config_service/async_client.py index a5e23bae15a0..d0d328de4c99 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/cmek_config_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/cmek_config_service/async_client.py @@ -379,12 +379,13 @@ async def sample_update_cmek_config(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1.types.CmekConfig` - Configurations used to enable CMEK data encryption with - Cloud KMS keys. + Configurations used to enable CMEK data + encryption with Cloud KMS keys. """ # Create or coerce a protobuf request object. @@ -455,8 +456,8 @@ async def get_cmek_config( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> cmek_config_service.CmekConfig: - r"""Gets the - [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig]. + r"""Gets the `CmekConfig + `__. .. code-block:: python @@ -490,14 +491,17 @@ async def sample_get_cmek_config(): GetCmekConfigRequest method. name (:class:`str`): Required. Resource name of - [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig], - such as ``projects/*/locations/*/cmekConfig`` or + `CmekConfig + `__, + such as + ``projects/*/locations/*/cmekConfig`` or ``projects/*/locations/*/cmekConfigs/*``. - If the caller does not have permission to access the - [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `CmekConfig + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -576,8 +580,8 @@ async def list_cmek_configs( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> cmek_config_service.ListCmekConfigsResponse: - r"""Lists all the - [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig]s with + r"""Lists all the `CmekConfig + `__s with the project. .. code-block:: python @@ -609,17 +613,20 @@ async def sample_list_cmek_configs(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.ListCmekConfigsRequest, dict]]): The request object. Request message for - [CmekConfigService.ListCmekConfigs][google.cloud.discoveryengine.v1.CmekConfigService.ListCmekConfigs] + `CmekConfigService.ListCmekConfigs + `__ method. parent (:class:`str`): - Required. The parent location resource name, such as + Required. The parent location resource + name, such as ``projects/{project}/locations/{location}``. - If the caller does not have permission to list - [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig]s - under this location, regardless of whether or not a - CmekConfig exists, a PERMISSION_DENIED error is - returned. + If the caller does not have permission + to list `CmekConfig + `__s + under this location, regardless of + whether or not a CmekConfig exists, a + PERMISSION_DENIED error is returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -635,8 +642,9 @@ async def sample_list_cmek_configs(): Returns: google.cloud.discoveryengine_v1.types.ListCmekConfigsResponse: Response message for - [CmekConfigService.ListCmekConfigs][google.cloud.discoveryengine.v1.CmekConfigService.ListCmekConfigs] - method. + `CmekConfigService.ListCmekConfigs + `__ + method. """ # Create or coerce a protobuf request object. @@ -734,11 +742,13 @@ async def sample_delete_cmek_config(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.DeleteCmekConfigRequest, dict]]): The request object. Request message for - [CmekConfigService.DeleteCmekConfig][google.cloud.discoveryengine.v1.CmekConfigService.DeleteCmekConfig] + `CmekConfigService.DeleteCmekConfig + `__ method. name (:class:`str`): Required. The resource name of the - [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig] + `CmekConfig + `__ to delete, such as ``projects/{project}/locations/{location}/cmekConfigs/{cmek_config}``. @@ -755,18 +765,21 @@ async def sample_delete_cmek_config(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/cmek_config_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/cmek_config_service/client.py index aa8828198418..6a1f213f3faa 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/cmek_config_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/cmek_config_service/client.py @@ -853,12 +853,13 @@ def sample_update_cmek_config(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1.types.CmekConfig` - Configurations used to enable CMEK data encryption with - Cloud KMS keys. + Configurations used to enable CMEK data + encryption with Cloud KMS keys. """ # Create or coerce a protobuf request object. @@ -926,8 +927,8 @@ def get_cmek_config( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> cmek_config_service.CmekConfig: - r"""Gets the - [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig]. + r"""Gets the `CmekConfig + `__. .. code-block:: python @@ -961,14 +962,17 @@ def sample_get_cmek_config(): GetCmekConfigRequest method. name (str): Required. Resource name of - [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig], - such as ``projects/*/locations/*/cmekConfig`` or + `CmekConfig + `__, + such as + ``projects/*/locations/*/cmekConfig`` or ``projects/*/locations/*/cmekConfigs/*``. - If the caller does not have permission to access the - [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `CmekConfig + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -1044,8 +1048,8 @@ def list_cmek_configs( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> cmek_config_service.ListCmekConfigsResponse: - r"""Lists all the - [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig]s with + r"""Lists all the `CmekConfig + `__s with the project. .. code-block:: python @@ -1077,17 +1081,20 @@ def sample_list_cmek_configs(): Args: request (Union[google.cloud.discoveryengine_v1.types.ListCmekConfigsRequest, dict]): The request object. Request message for - [CmekConfigService.ListCmekConfigs][google.cloud.discoveryengine.v1.CmekConfigService.ListCmekConfigs] + `CmekConfigService.ListCmekConfigs + `__ method. parent (str): - Required. The parent location resource name, such as + Required. The parent location resource + name, such as ``projects/{project}/locations/{location}``. - If the caller does not have permission to list - [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig]s - under this location, regardless of whether or not a - CmekConfig exists, a PERMISSION_DENIED error is - returned. + If the caller does not have permission + to list `CmekConfig + `__s + under this location, regardless of + whether or not a CmekConfig exists, a + PERMISSION_DENIED error is returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -1103,8 +1110,9 @@ def sample_list_cmek_configs(): Returns: google.cloud.discoveryengine_v1.types.ListCmekConfigsResponse: Response message for - [CmekConfigService.ListCmekConfigs][google.cloud.discoveryengine.v1.CmekConfigService.ListCmekConfigs] - method. + `CmekConfigService.ListCmekConfigs + `__ + method. """ # Create or coerce a protobuf request object. @@ -1199,11 +1207,13 @@ def sample_delete_cmek_config(): Args: request (Union[google.cloud.discoveryengine_v1.types.DeleteCmekConfigRequest, dict]): The request object. Request message for - [CmekConfigService.DeleteCmekConfig][google.cloud.discoveryengine.v1.CmekConfigService.DeleteCmekConfig] + `CmekConfigService.DeleteCmekConfig + `__ method. name (str): Required. The resource name of the - [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig] + `CmekConfig + `__ to delete, such as ``projects/{project}/locations/{location}/cmekConfigs/{cmek_config}``. @@ -1220,18 +1230,21 @@ def sample_delete_cmek_config(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/cmek_config_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/cmek_config_service/transports/grpc.py index a51541d73d1b..796f502f8326 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/cmek_config_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/cmek_config_service/transports/grpc.py @@ -380,8 +380,8 @@ def get_cmek_config( ]: r"""Return a callable for the get cmek config method over gRPC. - Gets the - [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig]. + Gets the `CmekConfig + `__. Returns: Callable[[~.GetCmekConfigRequest], @@ -410,8 +410,8 @@ def list_cmek_configs( ]: r"""Return a callable for the list cmek configs method over gRPC. - Lists all the - [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig]s with + Lists all the `CmekConfig + `__s with the project. Returns: diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/cmek_config_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/cmek_config_service/transports/grpc_asyncio.py index 2e31add97da0..527945772f74 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/cmek_config_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/cmek_config_service/transports/grpc_asyncio.py @@ -390,8 +390,8 @@ def get_cmek_config( ]: r"""Return a callable for the get cmek config method over gRPC. - Gets the - [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig]. + Gets the `CmekConfig + `__. Returns: Callable[[~.GetCmekConfigRequest], @@ -420,8 +420,8 @@ def list_cmek_configs( ]: r"""Return a callable for the list cmek configs method over gRPC. - Lists all the - [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig]s with + Lists all the `CmekConfig + `__s with the project. Returns: diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/cmek_config_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/cmek_config_service/transports/rest.py index 43ffa1c6f925..77d2d997b008 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/cmek_config_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/cmek_config_service/transports/rest.py @@ -697,7 +697,8 @@ def __call__( Args: request (~.cmek_config_service.DeleteCmekConfigRequest): The request object. Request message for - [CmekConfigService.DeleteCmekConfig][google.cloud.discoveryengine.v1.CmekConfigService.DeleteCmekConfig] + `CmekConfigService.DeleteCmekConfig + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -995,7 +996,8 @@ def __call__( Args: request (~.cmek_config_service.ListCmekConfigsRequest): The request object. Request message for - [CmekConfigService.ListCmekConfigs][google.cloud.discoveryengine.v1.CmekConfigService.ListCmekConfigs] + `CmekConfigService.ListCmekConfigs + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1008,7 +1010,8 @@ def __call__( Returns: ~.cmek_config_service.ListCmekConfigsResponse: Response message for - [CmekConfigService.ListCmekConfigs][google.cloud.discoveryengine.v1.CmekConfigService.ListCmekConfigs] + `CmekConfigService.ListCmekConfigs + `__ method. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/completion_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/completion_service/async_client.py index 31704e8c8267..1285779b167a 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/completion_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/completion_service/async_client.py @@ -340,7 +340,8 @@ async def sample_complete_query(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.CompleteQueryRequest, dict]]): The request object. Request message for - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1.CompletionService.CompleteQuery] + `CompletionService.CompleteQuery + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -353,8 +354,9 @@ async def sample_complete_query(): Returns: google.cloud.discoveryengine_v1.types.CompleteQueryResponse: Response message for - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1.CompletionService.CompleteQuery] - method. + `CompletionService.CompleteQuery + `__ + method. """ # Create or coerce a protobuf request object. @@ -402,7 +404,8 @@ async def import_suggestion_deny_list_entries( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: r"""Imports all - [SuggestionDenyListEntry][google.cloud.discoveryengine.v1.SuggestionDenyListEntry] + `SuggestionDenyListEntry + `__ for a DataStore. .. code-block:: python @@ -443,7 +446,8 @@ async def sample_import_suggestion_deny_list_entries(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.ImportSuggestionDenyListEntriesRequest, dict]]): The request object. Request message for - [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.ImportSuggestionDenyListEntries] + `CompletionService.ImportSuggestionDenyListEntries + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -455,11 +459,15 @@ async def sample_import_suggestion_deny_list_entries(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.ImportSuggestionDenyListEntriesResponse` Response message for - [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.ImportSuggestionDenyListEntries] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.ImportSuggestionDenyListEntriesResponse` + Response message for + `CompletionService.ImportSuggestionDenyListEntries + `__ + method. """ # Create or coerce a protobuf request object. @@ -515,7 +523,8 @@ async def purge_suggestion_deny_list_entries( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: r"""Permanently deletes all - [SuggestionDenyListEntry][google.cloud.discoveryengine.v1.SuggestionDenyListEntry] + `SuggestionDenyListEntry + `__ for a DataStore. .. code-block:: python @@ -551,7 +560,8 @@ async def sample_purge_suggestion_deny_list_entries(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.PurgeSuggestionDenyListEntriesRequest, dict]]): The request object. Request message for - [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.PurgeSuggestionDenyListEntries] + `CompletionService.PurgeSuggestionDenyListEntries + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -563,11 +573,15 @@ async def sample_purge_suggestion_deny_list_entries(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.PurgeSuggestionDenyListEntriesResponse` Response message for - [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.PurgeSuggestionDenyListEntries] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.PurgeSuggestionDenyListEntriesResponse` + Response message for + `CompletionService.PurgeSuggestionDenyListEntries + `__ + method. """ # Create or coerce a protobuf request object. @@ -621,7 +635,8 @@ async def import_completion_suggestions( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: r"""Imports - [CompletionSuggestion][google.cloud.discoveryengine.v1.CompletionSuggestion]s + `CompletionSuggestion + `__s for a DataStore. .. code-block:: python @@ -662,7 +677,8 @@ async def sample_import_completion_suggestions(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.ImportCompletionSuggestionsRequest, dict]]): The request object. Request message for - [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1.CompletionService.ImportCompletionSuggestions] + `CompletionService.ImportCompletionSuggestions + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -674,14 +690,18 @@ async def sample_import_completion_suggestions(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.ImportCompletionSuggestionsResponse` Response of the - [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1.CompletionService.ImportCompletionSuggestions] - method. If the long running operation is done, this - message is returned by the - google.longrunning.Operations.response field if the - operation is successful. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.ImportCompletionSuggestionsResponse` + Response of the + `CompletionService.ImportCompletionSuggestions + `__ + method. If the long running operation is + done, this message is returned by the + google.longrunning.Operations.response + field if the operation is successful. """ # Create or coerce a protobuf request object. @@ -735,7 +755,8 @@ async def purge_completion_suggestions( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: r"""Permanently deletes all - [CompletionSuggestion][google.cloud.discoveryengine.v1.CompletionSuggestion]s + `CompletionSuggestion + `__s for a DataStore. .. code-block:: python @@ -771,7 +792,8 @@ async def sample_purge_completion_suggestions(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.PurgeCompletionSuggestionsRequest, dict]]): The request object. Request message for - [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1.CompletionService.PurgeCompletionSuggestions] + `CompletionService.PurgeCompletionSuggestions + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -783,11 +805,15 @@ async def sample_purge_completion_suggestions(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.PurgeCompletionSuggestionsResponse` Response message for - [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1.CompletionService.PurgeCompletionSuggestions] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.PurgeCompletionSuggestionsResponse` + Response message for + `CompletionService.PurgeCompletionSuggestions + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/completion_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/completion_service/client.py index 142e6da0e1a7..ddadfcb0ea78 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/completion_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/completion_service/client.py @@ -764,7 +764,8 @@ def sample_complete_query(): Args: request (Union[google.cloud.discoveryengine_v1.types.CompleteQueryRequest, dict]): The request object. Request message for - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1.CompletionService.CompleteQuery] + `CompletionService.CompleteQuery + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -777,8 +778,9 @@ def sample_complete_query(): Returns: google.cloud.discoveryengine_v1.types.CompleteQueryResponse: Response message for - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1.CompletionService.CompleteQuery] - method. + `CompletionService.CompleteQuery + `__ + method. """ # Create or coerce a protobuf request object. @@ -824,7 +826,8 @@ def import_suggestion_deny_list_entries( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: r"""Imports all - [SuggestionDenyListEntry][google.cloud.discoveryengine.v1.SuggestionDenyListEntry] + `SuggestionDenyListEntry + `__ for a DataStore. .. code-block:: python @@ -865,7 +868,8 @@ def sample_import_suggestion_deny_list_entries(): Args: request (Union[google.cloud.discoveryengine_v1.types.ImportSuggestionDenyListEntriesRequest, dict]): The request object. Request message for - [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.ImportSuggestionDenyListEntries] + `CompletionService.ImportSuggestionDenyListEntries + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -877,11 +881,15 @@ def sample_import_suggestion_deny_list_entries(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.ImportSuggestionDenyListEntriesResponse` Response message for - [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.ImportSuggestionDenyListEntries] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.ImportSuggestionDenyListEntriesResponse` + Response message for + `CompletionService.ImportSuggestionDenyListEntries + `__ + method. """ # Create or coerce a protobuf request object. @@ -937,7 +945,8 @@ def purge_suggestion_deny_list_entries( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: r"""Permanently deletes all - [SuggestionDenyListEntry][google.cloud.discoveryengine.v1.SuggestionDenyListEntry] + `SuggestionDenyListEntry + `__ for a DataStore. .. code-block:: python @@ -973,7 +982,8 @@ def sample_purge_suggestion_deny_list_entries(): Args: request (Union[google.cloud.discoveryengine_v1.types.PurgeSuggestionDenyListEntriesRequest, dict]): The request object. Request message for - [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.PurgeSuggestionDenyListEntries] + `CompletionService.PurgeSuggestionDenyListEntries + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -985,11 +995,15 @@ def sample_purge_suggestion_deny_list_entries(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.PurgeSuggestionDenyListEntriesResponse` Response message for - [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.PurgeSuggestionDenyListEntries] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.PurgeSuggestionDenyListEntriesResponse` + Response message for + `CompletionService.PurgeSuggestionDenyListEntries + `__ + method. """ # Create or coerce a protobuf request object. @@ -1043,7 +1057,8 @@ def import_completion_suggestions( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: r"""Imports - [CompletionSuggestion][google.cloud.discoveryengine.v1.CompletionSuggestion]s + `CompletionSuggestion + `__s for a DataStore. .. code-block:: python @@ -1084,7 +1099,8 @@ def sample_import_completion_suggestions(): Args: request (Union[google.cloud.discoveryengine_v1.types.ImportCompletionSuggestionsRequest, dict]): The request object. Request message for - [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1.CompletionService.ImportCompletionSuggestions] + `CompletionService.ImportCompletionSuggestions + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1096,14 +1112,18 @@ def sample_import_completion_suggestions(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.ImportCompletionSuggestionsResponse` Response of the - [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1.CompletionService.ImportCompletionSuggestions] - method. If the long running operation is done, this - message is returned by the - google.longrunning.Operations.response field if the - operation is successful. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.ImportCompletionSuggestionsResponse` + Response of the + `CompletionService.ImportCompletionSuggestions + `__ + method. If the long running operation is + done, this message is returned by the + google.longrunning.Operations.response + field if the operation is successful. """ # Create or coerce a protobuf request object. @@ -1157,7 +1177,8 @@ def purge_completion_suggestions( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: r"""Permanently deletes all - [CompletionSuggestion][google.cloud.discoveryengine.v1.CompletionSuggestion]s + `CompletionSuggestion + `__s for a DataStore. .. code-block:: python @@ -1193,7 +1214,8 @@ def sample_purge_completion_suggestions(): Args: request (Union[google.cloud.discoveryengine_v1.types.PurgeCompletionSuggestionsRequest, dict]): The request object. Request message for - [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1.CompletionService.PurgeCompletionSuggestions] + `CompletionService.PurgeCompletionSuggestions + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1205,11 +1227,15 @@ def sample_purge_completion_suggestions(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.PurgeCompletionSuggestionsResponse` Response message for - [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1.CompletionService.PurgeCompletionSuggestions] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.PurgeCompletionSuggestionsResponse` + Response message for + `CompletionService.PurgeCompletionSuggestions + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/completion_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/completion_service/transports/grpc.py index 0901a44674cb..39b9231db48b 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/completion_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/completion_service/transports/grpc.py @@ -384,7 +384,8 @@ def import_suggestion_deny_list_entries( entries method over gRPC. Imports all - [SuggestionDenyListEntry][google.cloud.discoveryengine.v1.SuggestionDenyListEntry] + `SuggestionDenyListEntry + `__ for a DataStore. Returns: @@ -417,7 +418,8 @@ def purge_suggestion_deny_list_entries( entries method over gRPC. Permanently deletes all - [SuggestionDenyListEntry][google.cloud.discoveryengine.v1.SuggestionDenyListEntry] + `SuggestionDenyListEntry + `__ for a DataStore. Returns: @@ -449,7 +451,8 @@ def import_completion_suggestions( r"""Return a callable for the import completion suggestions method over gRPC. Imports - [CompletionSuggestion][google.cloud.discoveryengine.v1.CompletionSuggestion]s + `CompletionSuggestion + `__s for a DataStore. Returns: @@ -481,7 +484,8 @@ def purge_completion_suggestions( r"""Return a callable for the purge completion suggestions method over gRPC. Permanently deletes all - [CompletionSuggestion][google.cloud.discoveryengine.v1.CompletionSuggestion]s + `CompletionSuggestion + `__s for a DataStore. Returns: diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/completion_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/completion_service/transports/grpc_asyncio.py index 7ac71da82875..870647b0e814 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/completion_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/completion_service/transports/grpc_asyncio.py @@ -393,7 +393,8 @@ def import_suggestion_deny_list_entries( entries method over gRPC. Imports all - [SuggestionDenyListEntry][google.cloud.discoveryengine.v1.SuggestionDenyListEntry] + `SuggestionDenyListEntry + `__ for a DataStore. Returns: @@ -427,7 +428,8 @@ def purge_suggestion_deny_list_entries( entries method over gRPC. Permanently deletes all - [SuggestionDenyListEntry][google.cloud.discoveryengine.v1.SuggestionDenyListEntry] + `SuggestionDenyListEntry + `__ for a DataStore. Returns: @@ -460,7 +462,8 @@ def import_completion_suggestions( r"""Return a callable for the import completion suggestions method over gRPC. Imports - [CompletionSuggestion][google.cloud.discoveryengine.v1.CompletionSuggestion]s + `CompletionSuggestion + `__s for a DataStore. Returns: @@ -493,7 +496,8 @@ def purge_completion_suggestions( r"""Return a callable for the purge completion suggestions method over gRPC. Permanently deletes all - [CompletionSuggestion][google.cloud.discoveryengine.v1.CompletionSuggestion]s + `CompletionSuggestion + `__s for a DataStore. Returns: diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/completion_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/completion_service/transports/rest.py index 828892b07ea0..224128c443bb 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/completion_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/completion_service/transports/rest.py @@ -757,7 +757,8 @@ def __call__( Args: request (~.completion_service.CompleteQueryRequest): The request object. Request message for - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1.CompletionService.CompleteQuery] + `CompletionService.CompleteQuery + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -770,7 +771,8 @@ def __call__( Returns: ~.completion_service.CompleteQueryResponse: Response message for - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1.CompletionService.CompleteQuery] + `CompletionService.CompleteQuery + `__ method. """ @@ -911,7 +913,8 @@ def __call__( Args: request (~.import_config.ImportCompletionSuggestionsRequest): The request object. Request message for - [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1.CompletionService.ImportCompletionSuggestions] + `CompletionService.ImportCompletionSuggestions + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1073,7 +1076,8 @@ def __call__( Args: request (~.import_config.ImportSuggestionDenyListEntriesRequest): The request object. Request message for - [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.ImportSuggestionDenyListEntries] + `CompletionService.ImportSuggestionDenyListEntries + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1236,7 +1240,8 @@ def __call__( Args: request (~.purge_config.PurgeCompletionSuggestionsRequest): The request object. Request message for - [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1.CompletionService.PurgeCompletionSuggestions] + `CompletionService.PurgeCompletionSuggestions + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1393,7 +1398,8 @@ def __call__( Args: request (~.purge_config.PurgeSuggestionDenyListEntriesRequest): The request object. Request message for - [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.PurgeSuggestionDenyListEntries] + `CompletionService.PurgeSuggestionDenyListEntries + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/control_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/control_service/async_client.py index 6d551e10468e..f4bdb1ec81dc 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/control_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/control_service/async_client.py @@ -315,10 +315,11 @@ async def create_control( ) -> gcd_control.Control: r"""Creates a Control. - By default 1000 controls are allowed for a data store. A request - can be submitted to adjust this limit. If the - [Control][google.cloud.discoveryengine.v1.Control] to create - already exists, an ALREADY_EXISTS error is returned. + By default 1000 controls are allowed for a data store. A + request can be submitted to adjust this limit. If the + `Control `__ to + create already exists, an ALREADY_EXISTS error is + returned. .. code-block:: python @@ -359,8 +360,8 @@ async def sample_create_control(): request (Optional[Union[google.cloud.discoveryengine_v1.types.CreateControlRequest, dict]]): The request object. Request for CreateControl method. parent (:class:`str`): - Required. Full resource name of parent data store. - Format: + Required. Full resource name of parent + data store. Format: ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`` or ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. @@ -374,12 +375,13 @@ async def sample_create_control(): on the ``request`` instance; if ``request`` is provided, this should not be set. control_id (:class:`str`): - Required. The ID to use for the Control, which will - become the final component of the Control's resource - name. + Required. The ID to use for the Control, + which will become the final component of + the Control's resource name. - This value must be within 1-63 characters. Valid - characters are /[a-z][0-9]-\_/. + This value must be within 1-63 + characters. Valid characters are /`a-z + <0-9>`__-_/. This corresponds to the ``control_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -394,11 +396,13 @@ async def sample_create_control(): Returns: google.cloud.discoveryengine_v1.types.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] - to be considered at serving time. Permitted actions - dependent on SolutionType. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ # Create or coerce a protobuf request object. @@ -465,8 +469,9 @@ async def delete_control( ) -> None: r"""Deletes a Control. - If the [Control][google.cloud.discoveryengine.v1.Control] to - delete does not exist, a NOT_FOUND error is returned. + If the `Control + `__ to delete + does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -495,8 +500,8 @@ async def sample_delete_control(): request (Optional[Union[google.cloud.discoveryengine_v1.types.DeleteControlRequest, dict]]): The request object. Request for DeleteControl method. name (:class:`str`): - Required. The resource name of the Control to delete. - Format: + Required. The resource name of the + Control to delete. Format: ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`` This corresponds to the ``name`` field @@ -568,9 +573,9 @@ async def update_control( ) -> gcd_control.Control: r"""Updates a Control. - [Control][google.cloud.discoveryengine.v1.Control] action type - cannot be changed. If the - [Control][google.cloud.discoveryengine.v1.Control] to update + `Control `__ + action type cannot be changed. If the `Control + `__ to update does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -615,14 +620,19 @@ async def sample_update_control(): on the ``request`` instance; if ``request`` is provided, this should not be set. update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - Optional. Indicates which fields in the provided - [Control][google.cloud.discoveryengine.v1.Control] to - update. The following are NOT supported: + Optional. Indicates which fields in the + provided `Control + `__ + to update. The following are NOT + supported: - - [Control.name][google.cloud.discoveryengine.v1.Control.name] - - [Control.solution_type][google.cloud.discoveryengine.v1.Control.solution_type] + * `Control.name + `__ + * `Control.solution_type + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported + fields are updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -637,11 +647,13 @@ async def sample_update_control(): Returns: google.cloud.discoveryengine_v1.types.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] - to be considered at serving time. Permitted actions - dependent on SolutionType. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ # Create or coerce a protobuf request object. @@ -738,8 +750,8 @@ async def sample_get_control(): request (Optional[Union[google.cloud.discoveryengine_v1.types.GetControlRequest, dict]]): The request object. Request for GetControl method. name (:class:`str`): - Required. The resource name of the Control to get. - Format: + Required. The resource name of the + Control to get. Format: ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`` This corresponds to the ``name`` field @@ -755,11 +767,13 @@ async def sample_get_control(): Returns: google.cloud.discoveryengine_v1.types.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] - to be considered at serving time. Permitted actions - dependent on SolutionType. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ # Create or coerce a protobuf request object. @@ -821,7 +835,8 @@ async def list_controls( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListControlsAsyncPager: r"""Lists all Controls by their parent - [DataStore][google.cloud.discoveryengine.v1.DataStore]. + `DataStore + `__. .. code-block:: python @@ -854,7 +869,8 @@ async def sample_list_controls(): request (Optional[Union[google.cloud.discoveryengine_v1.types.ListControlsRequest, dict]]): The request object. Request for ListControls method. parent (:class:`str`): - Required. The data store resource name. Format: + Required. The data store resource name. + Format: ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`` or ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/control_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/control_service/client.py index effeb8344b29..478316f373d2 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/control_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/control_service/client.py @@ -784,10 +784,11 @@ def create_control( ) -> gcd_control.Control: r"""Creates a Control. - By default 1000 controls are allowed for a data store. A request - can be submitted to adjust this limit. If the - [Control][google.cloud.discoveryengine.v1.Control] to create - already exists, an ALREADY_EXISTS error is returned. + By default 1000 controls are allowed for a data store. A + request can be submitted to adjust this limit. If the + `Control `__ to + create already exists, an ALREADY_EXISTS error is + returned. .. code-block:: python @@ -828,8 +829,8 @@ def sample_create_control(): request (Union[google.cloud.discoveryengine_v1.types.CreateControlRequest, dict]): The request object. Request for CreateControl method. parent (str): - Required. Full resource name of parent data store. - Format: + Required. Full resource name of parent + data store. Format: ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`` or ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. @@ -843,12 +844,13 @@ def sample_create_control(): on the ``request`` instance; if ``request`` is provided, this should not be set. control_id (str): - Required. The ID to use for the Control, which will - become the final component of the Control's resource - name. + Required. The ID to use for the Control, + which will become the final component of + the Control's resource name. - This value must be within 1-63 characters. Valid - characters are /[a-z][0-9]-\_/. + This value must be within 1-63 + characters. Valid characters are /`a-z + <0-9>`__-_/. This corresponds to the ``control_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -863,11 +865,13 @@ def sample_create_control(): Returns: google.cloud.discoveryengine_v1.types.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] - to be considered at serving time. Permitted actions - dependent on SolutionType. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ # Create or coerce a protobuf request object. @@ -931,8 +935,9 @@ def delete_control( ) -> None: r"""Deletes a Control. - If the [Control][google.cloud.discoveryengine.v1.Control] to - delete does not exist, a NOT_FOUND error is returned. + If the `Control + `__ to delete + does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -961,8 +966,8 @@ def sample_delete_control(): request (Union[google.cloud.discoveryengine_v1.types.DeleteControlRequest, dict]): The request object. Request for DeleteControl method. name (str): - Required. The resource name of the Control to delete. - Format: + Required. The resource name of the + Control to delete. Format: ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`` This corresponds to the ``name`` field @@ -1031,9 +1036,9 @@ def update_control( ) -> gcd_control.Control: r"""Updates a Control. - [Control][google.cloud.discoveryengine.v1.Control] action type - cannot be changed. If the - [Control][google.cloud.discoveryengine.v1.Control] to update + `Control `__ + action type cannot be changed. If the `Control + `__ to update does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -1078,14 +1083,19 @@ def sample_update_control(): on the ``request`` instance; if ``request`` is provided, this should not be set. update_mask (google.protobuf.field_mask_pb2.FieldMask): - Optional. Indicates which fields in the provided - [Control][google.cloud.discoveryengine.v1.Control] to - update. The following are NOT supported: + Optional. Indicates which fields in the + provided `Control + `__ + to update. The following are NOT + supported: - - [Control.name][google.cloud.discoveryengine.v1.Control.name] - - [Control.solution_type][google.cloud.discoveryengine.v1.Control.solution_type] + * `Control.name + `__ + * `Control.solution_type + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported + fields are updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -1100,11 +1110,13 @@ def sample_update_control(): Returns: google.cloud.discoveryengine_v1.types.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] - to be considered at serving time. Permitted actions - dependent on SolutionType. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ # Create or coerce a protobuf request object. @@ -1198,8 +1210,8 @@ def sample_get_control(): request (Union[google.cloud.discoveryengine_v1.types.GetControlRequest, dict]): The request object. Request for GetControl method. name (str): - Required. The resource name of the Control to get. - Format: + Required. The resource name of the + Control to get. Format: ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`` This corresponds to the ``name`` field @@ -1215,11 +1227,13 @@ def sample_get_control(): Returns: google.cloud.discoveryengine_v1.types.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] - to be considered at serving time. Permitted actions - dependent on SolutionType. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ # Create or coerce a protobuf request object. @@ -1278,7 +1292,8 @@ def list_controls( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListControlsPager: r"""Lists all Controls by their parent - [DataStore][google.cloud.discoveryengine.v1.DataStore]. + `DataStore + `__. .. code-block:: python @@ -1311,7 +1326,8 @@ def sample_list_controls(): request (Union[google.cloud.discoveryengine_v1.types.ListControlsRequest, dict]): The request object. Request for ListControls method. parent (str): - Required. The data store resource name. Format: + Required. The data store resource name. + Format: ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`` or ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/control_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/control_service/transports/grpc.py index feee03b815e0..6f3e9becb078 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/control_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/control_service/transports/grpc.py @@ -337,10 +337,11 @@ def create_control( Creates a Control. - By default 1000 controls are allowed for a data store. A request - can be submitted to adjust this limit. If the - [Control][google.cloud.discoveryengine.v1.Control] to create - already exists, an ALREADY_EXISTS error is returned. + By default 1000 controls are allowed for a data store. A + request can be submitted to adjust this limit. If the + `Control `__ to + create already exists, an ALREADY_EXISTS error is + returned. Returns: Callable[[~.CreateControlRequest], @@ -368,8 +369,9 @@ def delete_control( Deletes a Control. - If the [Control][google.cloud.discoveryengine.v1.Control] to - delete does not exist, a NOT_FOUND error is returned. + If the `Control + `__ to delete + does not exist, a NOT_FOUND error is returned. Returns: Callable[[~.DeleteControlRequest], @@ -397,9 +399,9 @@ def update_control( Updates a Control. - [Control][google.cloud.discoveryengine.v1.Control] action type - cannot be changed. If the - [Control][google.cloud.discoveryengine.v1.Control] to update + `Control `__ + action type cannot be changed. If the `Control + `__ to update does not exist, a NOT_FOUND error is returned. Returns: @@ -455,7 +457,8 @@ def list_controls( r"""Return a callable for the list controls method over gRPC. Lists all Controls by their parent - [DataStore][google.cloud.discoveryengine.v1.DataStore]. + `DataStore + `__. Returns: Callable[[~.ListControlsRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/control_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/control_service/transports/grpc_asyncio.py index d1cd6f7eca62..1525918d8801 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/control_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/control_service/transports/grpc_asyncio.py @@ -347,10 +347,11 @@ def create_control( Creates a Control. - By default 1000 controls are allowed for a data store. A request - can be submitted to adjust this limit. If the - [Control][google.cloud.discoveryengine.v1.Control] to create - already exists, an ALREADY_EXISTS error is returned. + By default 1000 controls are allowed for a data store. A + request can be submitted to adjust this limit. If the + `Control `__ to + create already exists, an ALREADY_EXISTS error is + returned. Returns: Callable[[~.CreateControlRequest], @@ -378,8 +379,9 @@ def delete_control( Deletes a Control. - If the [Control][google.cloud.discoveryengine.v1.Control] to - delete does not exist, a NOT_FOUND error is returned. + If the `Control + `__ to delete + does not exist, a NOT_FOUND error is returned. Returns: Callable[[~.DeleteControlRequest], @@ -409,9 +411,9 @@ def update_control( Updates a Control. - [Control][google.cloud.discoveryengine.v1.Control] action type - cannot be changed. If the - [Control][google.cloud.discoveryengine.v1.Control] to update + `Control `__ + action type cannot be changed. If the `Control + `__ to update does not exist, a NOT_FOUND error is returned. Returns: @@ -468,7 +470,8 @@ def list_controls( r"""Return a callable for the list controls method over gRPC. Lists all Controls by their parent - [DataStore][google.cloud.discoveryengine.v1.DataStore]. + `DataStore + `__. Returns: Callable[[~.ListControlsRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/control_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/control_service/transports/rest.py index a25262b30968..f477824902a8 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/control_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/control_service/transports/rest.py @@ -537,11 +537,13 @@ def __call__( Returns: ~.gcd_control.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] - to be considered at serving time. Permitted actions - dependent on ``SolutionType``. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ @@ -797,11 +799,13 @@ def __call__( Returns: ~.control.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] - to be considered at serving time. Permitted actions - dependent on ``SolutionType``. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ @@ -1095,11 +1099,13 @@ def __call__( Returns: ~.gcd_control.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] - to be considered at serving time. Permitted actions - dependent on ``SolutionType``. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/conversational_search_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/conversational_search_service/async_client.py index f52112df7f9f..f6dae9d429e4 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/conversational_search_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/conversational_search_service/async_client.py @@ -394,17 +394,18 @@ async def sample_converse_conversation(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.ConverseConversationRequest, dict]]): The request object. Request message for - [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1.ConversationalSearchService.ConverseConversation] + `ConversationalSearchService.ConverseConversation + `__ method. name (:class:`str`): - Required. The resource name of the Conversation to get. - Format: + Required. The resource name of the + Conversation to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}``. Use ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-`` - to activate auto session mode, which automatically - creates a new conversation inside a ConverseConversation - session. + to activate auto session mode, which + automatically creates a new conversation + inside a ConverseConversation session. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -425,8 +426,9 @@ async def sample_converse_conversation(): Returns: google.cloud.discoveryengine_v1.types.ConverseConversationResponse: Response message for - [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1.ConversationalSearchService.ConverseConversation] - method. + `ConversationalSearchService.ConverseConversation + `__ + method. """ # Create or coerce a protobuf request object. @@ -496,9 +498,10 @@ async def create_conversation( ) -> gcd_conversation.Conversation: r"""Creates a Conversation. - If the - [Conversation][google.cloud.discoveryengine.v1.Conversation] to - create already exists, an ALREADY_EXISTS error is returned. + If the `Conversation + `__ to + create already exists, an ALREADY_EXISTS error is + returned. .. code-block:: python @@ -531,8 +534,8 @@ async def sample_create_conversation(): The request object. Request for CreateConversation method. parent (:class:`str`): - Required. Full resource name of parent data store. - Format: + Required. Full resource name of parent + data store. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field @@ -623,8 +626,8 @@ async def delete_conversation( ) -> None: r"""Deletes a Conversation. - If the - [Conversation][google.cloud.discoveryengine.v1.Conversation] to + If the `Conversation + `__ to delete does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -655,8 +658,8 @@ async def sample_delete_conversation(): The request object. Request for DeleteConversation method. name (:class:`str`): - Required. The resource name of the Conversation to - delete. Format: + Required. The resource name of the + Conversation to delete. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`` This corresponds to the ``name`` field @@ -732,9 +735,11 @@ async def update_conversation( ) -> gcd_conversation.Conversation: r"""Updates a Conversation. - [Conversation][google.cloud.discoveryengine.v1.Conversation] - action type cannot be changed. If the - [Conversation][google.cloud.discoveryengine.v1.Conversation] to + `Conversation + `__ action + type cannot be changed. If the + `Conversation + `__ to update does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -773,12 +778,16 @@ async def sample_update_conversation(): should not be set. update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): Indicates which fields in the provided - [Conversation][google.cloud.discoveryengine.v1.Conversation] - to update. The following are NOT supported: + `Conversation + `__ + to update. The following are NOT + supported: - - [Conversation.name][google.cloud.discoveryengine.v1.Conversation.name] + * `Conversation.name + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported + fields are updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -895,8 +904,8 @@ async def sample_get_conversation(): request (Optional[Union[google.cloud.discoveryengine_v1.types.GetConversationRequest, dict]]): The request object. Request for GetConversation method. name (:class:`str`): - Required. The resource name of the Conversation to get. - Format: + Required. The resource name of the + Conversation to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`` This corresponds to the ``name`` field @@ -979,7 +988,8 @@ async def list_conversations( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListConversationsAsyncPager: r"""Lists all Conversations by their parent - [DataStore][google.cloud.discoveryengine.v1.DataStore]. + `DataStore + `__. .. code-block:: python @@ -1012,7 +1022,8 @@ async def sample_list_conversations(): request (Optional[Union[google.cloud.discoveryengine_v1.types.ListConversationsRequest, dict]]): The request object. Request for ListConversations method. parent (:class:`str`): - Required. The data store resource name. Format: + Required. The data store resource name. + Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field @@ -1142,7 +1153,8 @@ async def sample_answer_query(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.AnswerQueryRequest, dict]]): The request object. Request message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1.ConversationalSearchService.AnswerQuery] + `ConversationalSearchService.AnswerQuery + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -1155,8 +1167,9 @@ async def sample_answer_query(): Returns: google.cloud.discoveryengine_v1.types.AnswerQueryResponse: Response message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1.ConversationalSearchService.AnswerQuery] - method. + `ConversationalSearchService.AnswerQuery + `__ + method. """ # Create or coerce a protobuf request object. @@ -1206,9 +1219,11 @@ def stream_answer_query( r"""Answer query method (streaming). It takes one - [AnswerQueryRequest][google.cloud.discoveryengine.v1.AnswerQueryRequest] + `AnswerQueryRequest + `__ and returns multiple - [AnswerQueryResponse][google.cloud.discoveryengine.v1.AnswerQueryResponse] + `AnswerQueryResponse + `__ messages in a stream. .. code-block:: python @@ -1245,7 +1260,8 @@ async def sample_stream_answer_query(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.AnswerQueryRequest, dict]]): The request object. Request message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1.ConversationalSearchService.AnswerQuery] + `ConversationalSearchService.AnswerQuery + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -1258,8 +1274,9 @@ async def sample_stream_answer_query(): Returns: AsyncIterable[google.cloud.discoveryengine_v1.types.AnswerQueryResponse]: Response message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1.ConversationalSearchService.AnswerQuery] - method. + `ConversationalSearchService.AnswerQuery + `__ + method. """ # Create or coerce a protobuf request object. @@ -1339,8 +1356,8 @@ async def sample_get_answer(): request (Optional[Union[google.cloud.discoveryengine_v1.types.GetAnswerRequest, dict]]): The request object. Request for GetAnswer method. name (:class:`str`): - Required. The resource name of the Answer to get. - Format: + Required. The resource name of the + Answer to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`` This corresponds to the ``name`` field @@ -1421,8 +1438,9 @@ async def create_session( ) -> gcd_session.Session: r"""Creates a Session. - If the [Session][google.cloud.discoveryengine.v1.Session] to - create already exists, an ALREADY_EXISTS error is returned. + If the `Session + `__ to create + already exists, an ALREADY_EXISTS error is returned. .. code-block:: python @@ -1454,8 +1472,8 @@ async def sample_create_session(): request (Optional[Union[google.cloud.discoveryengine_v1.types.CreateSessionRequest, dict]]): The request object. Request for CreateSession method. parent (:class:`str`): - Required. Full resource name of parent data store. - Format: + Required. Full resource name of parent + data store. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field @@ -1542,8 +1560,9 @@ async def delete_session( ) -> None: r"""Deletes a Session. - If the [Session][google.cloud.discoveryengine.v1.Session] to - delete does not exist, a NOT_FOUND error is returned. + If the `Session + `__ to delete + does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -1572,8 +1591,8 @@ async def sample_delete_session(): request (Optional[Union[google.cloud.discoveryengine_v1.types.DeleteSessionRequest, dict]]): The request object. Request for DeleteSession method. name (:class:`str`): - Required. The resource name of the Session to delete. - Format: + Required. The resource name of the + Session to delete. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` This corresponds to the ``name`` field @@ -1647,9 +1666,9 @@ async def update_session( ) -> gcd_session.Session: r"""Updates a Session. - [Session][google.cloud.discoveryengine.v1.Session] action type - cannot be changed. If the - [Session][google.cloud.discoveryengine.v1.Session] to update + `Session `__ + action type cannot be changed. If the `Session + `__ to update does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -1687,12 +1706,16 @@ async def sample_update_session(): should not be set. update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): Indicates which fields in the provided - [Session][google.cloud.discoveryengine.v1.Session] to - update. The following are NOT supported: + `Session + `__ + to update. The following are NOT + supported: - - [Session.name][google.cloud.discoveryengine.v1.Session.name] + * `Session.name + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported + fields are updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -1805,8 +1828,8 @@ async def sample_get_session(): request (Optional[Union[google.cloud.discoveryengine_v1.types.GetSessionRequest, dict]]): The request object. Request for GetSession method. name (:class:`str`): - Required. The resource name of the Session to get. - Format: + Required. The resource name of the + Session to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` This corresponds to the ``name`` field @@ -1885,7 +1908,8 @@ async def list_sessions( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListSessionsAsyncPager: r"""Lists all Sessions by their parent - [DataStore][google.cloud.discoveryengine.v1.DataStore]. + `DataStore + `__. .. code-block:: python @@ -1918,7 +1942,8 @@ async def sample_list_sessions(): request (Optional[Union[google.cloud.discoveryengine_v1.types.ListSessionsRequest, dict]]): The request object. Request for ListSessions method. parent (:class:`str`): - Required. The data store resource name. Format: + Required. The data store resource name. + Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/conversational_search_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/conversational_search_service/client.py index 16de9ed07c2a..a26993ae616e 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/conversational_search_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/conversational_search_service/client.py @@ -965,17 +965,18 @@ def sample_converse_conversation(): Args: request (Union[google.cloud.discoveryengine_v1.types.ConverseConversationRequest, dict]): The request object. Request message for - [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1.ConversationalSearchService.ConverseConversation] + `ConversationalSearchService.ConverseConversation + `__ method. name (str): - Required. The resource name of the Conversation to get. - Format: + Required. The resource name of the + Conversation to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}``. Use ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-`` - to activate auto session mode, which automatically - creates a new conversation inside a ConverseConversation - session. + to activate auto session mode, which + automatically creates a new conversation + inside a ConverseConversation session. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -996,8 +997,9 @@ def sample_converse_conversation(): Returns: google.cloud.discoveryengine_v1.types.ConverseConversationResponse: Response message for - [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1.ConversationalSearchService.ConverseConversation] - method. + `ConversationalSearchService.ConverseConversation + `__ + method. """ # Create or coerce a protobuf request object. @@ -1064,9 +1066,10 @@ def create_conversation( ) -> gcd_conversation.Conversation: r"""Creates a Conversation. - If the - [Conversation][google.cloud.discoveryengine.v1.Conversation] to - create already exists, an ALREADY_EXISTS error is returned. + If the `Conversation + `__ to + create already exists, an ALREADY_EXISTS error is + returned. .. code-block:: python @@ -1099,8 +1102,8 @@ def sample_create_conversation(): The request object. Request for CreateConversation method. parent (str): - Required. Full resource name of parent data store. - Format: + Required. Full resource name of parent + data store. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field @@ -1188,8 +1191,8 @@ def delete_conversation( ) -> None: r"""Deletes a Conversation. - If the - [Conversation][google.cloud.discoveryengine.v1.Conversation] to + If the `Conversation + `__ to delete does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -1220,8 +1223,8 @@ def sample_delete_conversation(): The request object. Request for DeleteConversation method. name (str): - Required. The resource name of the Conversation to - delete. Format: + Required. The resource name of the + Conversation to delete. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`` This corresponds to the ``name`` field @@ -1294,9 +1297,11 @@ def update_conversation( ) -> gcd_conversation.Conversation: r"""Updates a Conversation. - [Conversation][google.cloud.discoveryengine.v1.Conversation] - action type cannot be changed. If the - [Conversation][google.cloud.discoveryengine.v1.Conversation] to + `Conversation + `__ action + type cannot be changed. If the + `Conversation + `__ to update does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -1335,12 +1340,16 @@ def sample_update_conversation(): should not be set. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [Conversation][google.cloud.discoveryengine.v1.Conversation] - to update. The following are NOT supported: + `Conversation + `__ + to update. The following are NOT + supported: - - [Conversation.name][google.cloud.discoveryengine.v1.Conversation.name] + * `Conversation.name + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported + fields are updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -1454,8 +1463,8 @@ def sample_get_conversation(): request (Union[google.cloud.discoveryengine_v1.types.GetConversationRequest, dict]): The request object. Request for GetConversation method. name (str): - Required. The resource name of the Conversation to get. - Format: + Required. The resource name of the + Conversation to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`` This corresponds to the ``name`` field @@ -1535,7 +1544,8 @@ def list_conversations( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListConversationsPager: r"""Lists all Conversations by their parent - [DataStore][google.cloud.discoveryengine.v1.DataStore]. + `DataStore + `__. .. code-block:: python @@ -1568,7 +1578,8 @@ def sample_list_conversations(): request (Union[google.cloud.discoveryengine_v1.types.ListConversationsRequest, dict]): The request object. Request for ListConversations method. parent (str): - Required. The data store resource name. Format: + Required. The data store resource name. + Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field @@ -1695,7 +1706,8 @@ def sample_answer_query(): Args: request (Union[google.cloud.discoveryengine_v1.types.AnswerQueryRequest, dict]): The request object. Request message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1.ConversationalSearchService.AnswerQuery] + `ConversationalSearchService.AnswerQuery + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1708,8 +1720,9 @@ def sample_answer_query(): Returns: google.cloud.discoveryengine_v1.types.AnswerQueryResponse: Response message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1.ConversationalSearchService.AnswerQuery] - method. + `ConversationalSearchService.AnswerQuery + `__ + method. """ # Create or coerce a protobuf request object. @@ -1757,9 +1770,11 @@ def stream_answer_query( r"""Answer query method (streaming). It takes one - [AnswerQueryRequest][google.cloud.discoveryengine.v1.AnswerQueryRequest] + `AnswerQueryRequest + `__ and returns multiple - [AnswerQueryResponse][google.cloud.discoveryengine.v1.AnswerQueryResponse] + `AnswerQueryResponse + `__ messages in a stream. .. code-block:: python @@ -1796,7 +1811,8 @@ def sample_stream_answer_query(): Args: request (Union[google.cloud.discoveryengine_v1.types.AnswerQueryRequest, dict]): The request object. Request message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1.ConversationalSearchService.AnswerQuery] + `ConversationalSearchService.AnswerQuery + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1809,8 +1825,9 @@ def sample_stream_answer_query(): Returns: Iterable[google.cloud.discoveryengine_v1.types.AnswerQueryResponse]: Response message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1.ConversationalSearchService.AnswerQuery] - method. + `ConversationalSearchService.AnswerQuery + `__ + method. """ # Create or coerce a protobuf request object. @@ -1888,8 +1905,8 @@ def sample_get_answer(): request (Union[google.cloud.discoveryengine_v1.types.GetAnswerRequest, dict]): The request object. Request for GetAnswer method. name (str): - Required. The resource name of the Answer to get. - Format: + Required. The resource name of the + Answer to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`` This corresponds to the ``name`` field @@ -1967,8 +1984,9 @@ def create_session( ) -> gcd_session.Session: r"""Creates a Session. - If the [Session][google.cloud.discoveryengine.v1.Session] to - create already exists, an ALREADY_EXISTS error is returned. + If the `Session + `__ to create + already exists, an ALREADY_EXISTS error is returned. .. code-block:: python @@ -2000,8 +2018,8 @@ def sample_create_session(): request (Union[google.cloud.discoveryengine_v1.types.CreateSessionRequest, dict]): The request object. Request for CreateSession method. parent (str): - Required. Full resource name of parent data store. - Format: + Required. Full resource name of parent + data store. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field @@ -2085,8 +2103,9 @@ def delete_session( ) -> None: r"""Deletes a Session. - If the [Session][google.cloud.discoveryengine.v1.Session] to - delete does not exist, a NOT_FOUND error is returned. + If the `Session + `__ to delete + does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -2115,8 +2134,8 @@ def sample_delete_session(): request (Union[google.cloud.discoveryengine_v1.types.DeleteSessionRequest, dict]): The request object. Request for DeleteSession method. name (str): - Required. The resource name of the Session to delete. - Format: + Required. The resource name of the + Session to delete. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` This corresponds to the ``name`` field @@ -2187,9 +2206,9 @@ def update_session( ) -> gcd_session.Session: r"""Updates a Session. - [Session][google.cloud.discoveryengine.v1.Session] action type - cannot be changed. If the - [Session][google.cloud.discoveryengine.v1.Session] to update + `Session `__ + action type cannot be changed. If the `Session + `__ to update does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -2227,12 +2246,16 @@ def sample_update_session(): should not be set. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [Session][google.cloud.discoveryengine.v1.Session] to - update. The following are NOT supported: + `Session + `__ + to update. The following are NOT + supported: - - [Session.name][google.cloud.discoveryengine.v1.Session.name] + * `Session.name + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported + fields are updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -2342,8 +2365,8 @@ def sample_get_session(): request (Union[google.cloud.discoveryengine_v1.types.GetSessionRequest, dict]): The request object. Request for GetSession method. name (str): - Required. The resource name of the Session to get. - Format: + Required. The resource name of the + Session to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` This corresponds to the ``name`` field @@ -2419,7 +2442,8 @@ def list_sessions( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListSessionsPager: r"""Lists all Sessions by their parent - [DataStore][google.cloud.discoveryengine.v1.DataStore]. + `DataStore + `__. .. code-block:: python @@ -2452,7 +2476,8 @@ def sample_list_sessions(): request (Union[google.cloud.discoveryengine_v1.types.ListSessionsRequest, dict]): The request object. Request for ListSessions method. parent (str): - Required. The data store resource name. Format: + Required. The data store resource name. + Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/conversational_search_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/conversational_search_service/transports/grpc.py index 87669a1bde2d..9a3a2710e547 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/conversational_search_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/conversational_search_service/transports/grpc.py @@ -369,9 +369,10 @@ def create_conversation( Creates a Conversation. - If the - [Conversation][google.cloud.discoveryengine.v1.Conversation] to - create already exists, an ALREADY_EXISTS error is returned. + If the `Conversation + `__ to + create already exists, an ALREADY_EXISTS error is + returned. Returns: Callable[[~.CreateConversationRequest], @@ -401,8 +402,8 @@ def delete_conversation( Deletes a Conversation. - If the - [Conversation][google.cloud.discoveryengine.v1.Conversation] to + If the `Conversation + `__ to delete does not exist, a NOT_FOUND error is returned. Returns: @@ -434,9 +435,11 @@ def update_conversation( Updates a Conversation. - [Conversation][google.cloud.discoveryengine.v1.Conversation] - action type cannot be changed. If the - [Conversation][google.cloud.discoveryengine.v1.Conversation] to + `Conversation + `__ action + type cannot be changed. If the + `Conversation + `__ to update does not exist, a NOT_FOUND error is returned. Returns: @@ -496,7 +499,8 @@ def list_conversations( r"""Return a callable for the list conversations method over gRPC. Lists all Conversations by their parent - [DataStore][google.cloud.discoveryengine.v1.DataStore]. + `DataStore + `__. Returns: Callable[[~.ListConversationsRequest], @@ -557,9 +561,11 @@ def stream_answer_query( Answer query method (streaming). It takes one - [AnswerQueryRequest][google.cloud.discoveryengine.v1.AnswerQueryRequest] + `AnswerQueryRequest + `__ and returns multiple - [AnswerQueryResponse][google.cloud.discoveryengine.v1.AnswerQueryResponse] + `AnswerQueryResponse + `__ messages in a stream. Returns: @@ -616,8 +622,9 @@ def create_session( Creates a Session. - If the [Session][google.cloud.discoveryengine.v1.Session] to - create already exists, an ALREADY_EXISTS error is returned. + If the `Session + `__ to create + already exists, an ALREADY_EXISTS error is returned. Returns: Callable[[~.CreateSessionRequest], @@ -647,8 +654,9 @@ def delete_session( Deletes a Session. - If the [Session][google.cloud.discoveryengine.v1.Session] to - delete does not exist, a NOT_FOUND error is returned. + If the `Session + `__ to delete + does not exist, a NOT_FOUND error is returned. Returns: Callable[[~.DeleteSessionRequest], @@ -678,9 +686,9 @@ def update_session( Updates a Session. - [Session][google.cloud.discoveryengine.v1.Session] action type - cannot be changed. If the - [Session][google.cloud.discoveryengine.v1.Session] to update + `Session `__ + action type cannot be changed. If the `Session + `__ to update does not exist, a NOT_FOUND error is returned. Returns: @@ -737,7 +745,8 @@ def list_sessions( r"""Return a callable for the list sessions method over gRPC. Lists all Sessions by their parent - [DataStore][google.cloud.discoveryengine.v1.DataStore]. + `DataStore + `__. Returns: Callable[[~.ListSessionsRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/conversational_search_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/conversational_search_service/transports/grpc_asyncio.py index 5b47516e8e9e..647c8c8bdf0c 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/conversational_search_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/conversational_search_service/transports/grpc_asyncio.py @@ -379,9 +379,10 @@ def create_conversation( Creates a Conversation. - If the - [Conversation][google.cloud.discoveryengine.v1.Conversation] to - create already exists, an ALREADY_EXISTS error is returned. + If the `Conversation + `__ to + create already exists, an ALREADY_EXISTS error is + returned. Returns: Callable[[~.CreateConversationRequest], @@ -412,8 +413,8 @@ def delete_conversation( Deletes a Conversation. - If the - [Conversation][google.cloud.discoveryengine.v1.Conversation] to + If the `Conversation + `__ to delete does not exist, a NOT_FOUND error is returned. Returns: @@ -445,9 +446,11 @@ def update_conversation( Updates a Conversation. - [Conversation][google.cloud.discoveryengine.v1.Conversation] - action type cannot be changed. If the - [Conversation][google.cloud.discoveryengine.v1.Conversation] to + `Conversation + `__ action + type cannot be changed. If the + `Conversation + `__ to update does not exist, a NOT_FOUND error is returned. Returns: @@ -507,7 +510,8 @@ def list_conversations( r"""Return a callable for the list conversations method over gRPC. Lists all Conversations by their parent - [DataStore][google.cloud.discoveryengine.v1.DataStore]. + `DataStore + `__. Returns: Callable[[~.ListConversationsRequest], @@ -568,9 +572,11 @@ def stream_answer_query( Answer query method (streaming). It takes one - [AnswerQueryRequest][google.cloud.discoveryengine.v1.AnswerQueryRequest] + `AnswerQueryRequest + `__ and returns multiple - [AnswerQueryResponse][google.cloud.discoveryengine.v1.AnswerQueryResponse] + `AnswerQueryResponse + `__ messages in a stream. Returns: @@ -630,8 +636,9 @@ def create_session( Creates a Session. - If the [Session][google.cloud.discoveryengine.v1.Session] to - create already exists, an ALREADY_EXISTS error is returned. + If the `Session + `__ to create + already exists, an ALREADY_EXISTS error is returned. Returns: Callable[[~.CreateSessionRequest], @@ -661,8 +668,9 @@ def delete_session( Deletes a Session. - If the [Session][google.cloud.discoveryengine.v1.Session] to - delete does not exist, a NOT_FOUND error is returned. + If the `Session + `__ to delete + does not exist, a NOT_FOUND error is returned. Returns: Callable[[~.DeleteSessionRequest], @@ -693,9 +701,9 @@ def update_session( Updates a Session. - [Session][google.cloud.discoveryengine.v1.Session] action type - cannot be changed. If the - [Session][google.cloud.discoveryengine.v1.Session] to update + `Session `__ + action type cannot be changed. If the `Session + `__ to update does not exist, a NOT_FOUND error is returned. Returns: @@ -754,7 +762,8 @@ def list_sessions( r"""Return a callable for the list sessions method over gRPC. Lists all Sessions by their parent - [DataStore][google.cloud.discoveryengine.v1.DataStore]. + `DataStore + `__. Returns: Callable[[~.ListSessionsRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/conversational_search_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/conversational_search_service/transports/rest.py index ea6e8130b173..218e1c86dbc7 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/conversational_search_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/conversational_search_service/transports/rest.py @@ -1018,7 +1018,8 @@ def __call__( Args: request (~.conversational_search_service.AnswerQueryRequest): The request object. Request message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1.ConversationalSearchService.AnswerQuery] + `ConversationalSearchService.AnswerQuery + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1031,7 +1032,8 @@ def __call__( Returns: ~.conversational_search_service.AnswerQueryResponse: Response message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1.ConversationalSearchService.AnswerQuery] + `ConversationalSearchService.AnswerQuery + `__ method. """ @@ -1180,7 +1182,8 @@ def __call__( Args: request (~.conversational_search_service.ConverseConversationRequest): The request object. Request message for - [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1.ConversationalSearchService.ConverseConversation] + `ConversationalSearchService.ConverseConversation + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1193,7 +1196,8 @@ def __call__( Returns: ~.conversational_search_service.ConverseConversationResponse: Response message for - [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1.ConversationalSearchService.ConverseConversation] + `ConversationalSearchService.ConverseConversation + `__ method. """ @@ -2620,7 +2624,8 @@ def __call__( Args: request (~.conversational_search_service.AnswerQueryRequest): The request object. Request message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1.ConversationalSearchService.AnswerQuery] + `ConversationalSearchService.AnswerQuery + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2633,7 +2638,8 @@ def __call__( Returns: ~.conversational_search_service.AnswerQueryResponse: Response message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1.ConversationalSearchService.AnswerQuery] + `ConversationalSearchService.AnswerQuery + `__ method. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/data_store_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/data_store_service/async_client.py index 3dc9595013f9..b837a6200cdb 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/data_store_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/data_store_service/async_client.py @@ -77,9 +77,8 @@ class DataStoreServiceAsyncClient: - """Service for managing - [DataStore][google.cloud.discoveryengine.v1.DataStore] - configuration. + """Service for managing `DataStore + `__ configuration. """ _client: DataStoreServiceClient @@ -346,14 +345,14 @@ async def create_data_store( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Creates a - [DataStore][google.cloud.discoveryengine.v1.DataStore]. - + r"""Creates a `DataStore + `__. DataStore is for storing - [Documents][google.cloud.discoveryengine.v1.Document]. To serve - these documents for Search, or Recommendation use case, an - [Engine][google.cloud.discoveryengine.v1.Engine] needs to be - created separately. + `Documents + `__. To serve + these documents for Search, or Recommendation use case, + an `Engine `__ + needs to be created separately. .. code-block:: python @@ -394,18 +393,20 @@ async def sample_create_data_store(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.CreateDataStoreRequest, dict]]): The request object. Request for - [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1.DataStoreService.CreateDataStore] + `DataStoreService.CreateDataStore + `__ method. parent (:class:`str`): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. data_store (:class:`google.cloud.discoveryengine_v1.types.DataStore`): - Required. The - [DataStore][google.cloud.discoveryengine.v1.DataStore] + Required. The `DataStore + `__ to create. This corresponds to the ``data_store`` field @@ -413,15 +414,19 @@ async def sample_create_data_store(): should not be set. data_store_id (:class:`str`): Required. The ID to use for the - [DataStore][google.cloud.discoveryengine.v1.DataStore], - which will become the final component of the - [DataStore][google.cloud.discoveryengine.v1.DataStore]'s + `DataStore + `__, + which will become the final component of + the + `DataStore + `__'s resource name. - This field must conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. - Otherwise, an INVALID_ARGUMENT error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 + characters. Otherwise, an + INVALID_ARGUMENT error is returned. This corresponds to the ``data_store_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -436,12 +441,13 @@ async def sample_create_data_store(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1.types.DataStore` - DataStore captures global settings and configs at the - DataStore level. + DataStore captures global settings and + configs at the DataStore level. """ # Create or coerce a protobuf request object. @@ -514,7 +520,8 @@ async def get_data_store( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> data_store.DataStore: - r"""Gets a [DataStore][google.cloud.discoveryengine.v1.DataStore]. + r"""Gets a `DataStore + `__. .. code-block:: python @@ -545,22 +552,26 @@ async def sample_get_data_store(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.GetDataStoreRequest, dict]]): The request object. Request message for - [DataStoreService.GetDataStore][google.cloud.discoveryengine.v1.DataStoreService.GetDataStore] + `DataStoreService.GetDataStore + `__ method. name (:class:`str`): Required. Full resource name of - [DataStore][google.cloud.discoveryengine.v1.DataStore], + `DataStore + `__, such as ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. - If the caller does not have permission to access the - [DataStore][google.cloud.discoveryengine.v1.DataStore], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `DataStore + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the requested - [DataStore][google.cloud.discoveryengine.v1.DataStore] - does not exist, a NOT_FOUND error is returned. + If the requested `DataStore + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -637,8 +648,8 @@ async def list_data_stores( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListDataStoresAsyncPager: - r"""Lists all the - [DataStore][google.cloud.discoveryengine.v1.DataStore]s + r"""Lists all the `DataStore + `__s associated with the project. .. code-block:: python @@ -671,17 +682,20 @@ async def sample_list_data_stores(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.ListDataStoresRequest, dict]]): The request object. Request message for - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores] + `DataStoreService.ListDataStores + `__ method. parent (:class:`str`): - Required. The parent branch resource name, such as + Required. The parent branch resource + name, such as ``projects/{project}/locations/{location}/collections/{collection_id}``. - If the caller does not have permission to list - [DataStore][google.cloud.discoveryengine.v1.DataStore]s - under this location, regardless of whether or not this - data store exists, a PERMISSION_DENIED error is - returned. + If the caller does not have permission + to list `DataStore + `__s + under this location, regardless of + whether or not this data store exists, a + PERMISSION_DENIED error is returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -697,11 +711,13 @@ async def sample_list_data_stores(): Returns: google.cloud.discoveryengine_v1.services.data_store_service.pagers.ListDataStoresAsyncPager: Response message for - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores] - method. + `DataStoreService.ListDataStores + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -775,8 +791,8 @@ async def delete_data_store( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Deletes a - [DataStore][google.cloud.discoveryengine.v1.DataStore]. + r"""Deletes a `DataStore + `__. .. code-block:: python @@ -811,22 +827,26 @@ async def sample_delete_data_store(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.DeleteDataStoreRequest, dict]]): The request object. Request message for - [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1.DataStoreService.DeleteDataStore] + `DataStoreService.DeleteDataStore + `__ method. name (:class:`str`): Required. Full resource name of - [DataStore][google.cloud.discoveryengine.v1.DataStore], + `DataStore + `__, such as ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. - If the caller does not have permission to delete the - [DataStore][google.cloud.discoveryengine.v1.DataStore], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to delete the `DataStore + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the - [DataStore][google.cloud.discoveryengine.v1.DataStore] - to delete does not exist, a NOT_FOUND error is returned. + If the `DataStore + `__ + to delete does not exist, a NOT_FOUND + error is returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -841,18 +861,21 @@ async def sample_delete_data_store(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. @@ -924,7 +947,8 @@ async def update_data_store( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_data_store.DataStore: - r"""Updates a [DataStore][google.cloud.discoveryengine.v1.DataStore] + r"""Updates a `DataStore + `__ .. code-block:: python @@ -958,32 +982,37 @@ async def sample_update_data_store(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.UpdateDataStoreRequest, dict]]): The request object. Request message for - [DataStoreService.UpdateDataStore][google.cloud.discoveryengine.v1.DataStoreService.UpdateDataStore] + `DataStoreService.UpdateDataStore + `__ method. data_store (:class:`google.cloud.discoveryengine_v1.types.DataStore`): - Required. The - [DataStore][google.cloud.discoveryengine.v1.DataStore] + Required. The `DataStore + `__ to update. - If the caller does not have permission to update the - [DataStore][google.cloud.discoveryengine.v1.DataStore], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to update the `DataStore + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the - [DataStore][google.cloud.discoveryengine.v1.DataStore] - to update does not exist, a NOT_FOUND error is returned. + If the `DataStore + `__ + to update does not exist, a NOT_FOUND + error is returned. This corresponds to the ``data_store`` field on the ``request`` instance; if ``request`` is provided, this should not be set. update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): Indicates which fields in the provided - [DataStore][google.cloud.discoveryengine.v1.DataStore] + `DataStore + `__ to update. - If an unsupported or unknown field is provided, an - INVALID_ARGUMENT error is returned. + If an unsupported or unknown field is + provided, an INVALID_ARGUMENT error is + returned. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/data_store_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/data_store_service/client.py index 0339b982d45a..5866208b53ef 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/data_store_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/data_store_service/client.py @@ -123,9 +123,8 @@ def get_transport_class( class DataStoreServiceClient(metaclass=DataStoreServiceClientMeta): - """Service for managing - [DataStore][google.cloud.discoveryengine.v1.DataStore] - configuration. + """Service for managing `DataStore + `__ configuration. """ @staticmethod @@ -905,14 +904,14 @@ def create_data_store( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Creates a - [DataStore][google.cloud.discoveryengine.v1.DataStore]. - + r"""Creates a `DataStore + `__. DataStore is for storing - [Documents][google.cloud.discoveryengine.v1.Document]. To serve - these documents for Search, or Recommendation use case, an - [Engine][google.cloud.discoveryengine.v1.Engine] needs to be - created separately. + `Documents + `__. To serve + these documents for Search, or Recommendation use case, + an `Engine `__ + needs to be created separately. .. code-block:: python @@ -953,18 +952,20 @@ def sample_create_data_store(): Args: request (Union[google.cloud.discoveryengine_v1.types.CreateDataStoreRequest, dict]): The request object. Request for - [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1.DataStoreService.CreateDataStore] + `DataStoreService.CreateDataStore + `__ method. parent (str): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. data_store (google.cloud.discoveryengine_v1.types.DataStore): - Required. The - [DataStore][google.cloud.discoveryengine.v1.DataStore] + Required. The `DataStore + `__ to create. This corresponds to the ``data_store`` field @@ -972,15 +973,19 @@ def sample_create_data_store(): should not be set. data_store_id (str): Required. The ID to use for the - [DataStore][google.cloud.discoveryengine.v1.DataStore], - which will become the final component of the - [DataStore][google.cloud.discoveryengine.v1.DataStore]'s + `DataStore + `__, + which will become the final component of + the + `DataStore + `__'s resource name. - This field must conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. - Otherwise, an INVALID_ARGUMENT error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 + characters. Otherwise, an + INVALID_ARGUMENT error is returned. This corresponds to the ``data_store_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -995,12 +1000,13 @@ def sample_create_data_store(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1.types.DataStore` - DataStore captures global settings and configs at the - DataStore level. + DataStore captures global settings and + configs at the DataStore level. """ # Create or coerce a protobuf request object. @@ -1070,7 +1076,8 @@ def get_data_store( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> data_store.DataStore: - r"""Gets a [DataStore][google.cloud.discoveryengine.v1.DataStore]. + r"""Gets a `DataStore + `__. .. code-block:: python @@ -1101,22 +1108,26 @@ def sample_get_data_store(): Args: request (Union[google.cloud.discoveryengine_v1.types.GetDataStoreRequest, dict]): The request object. Request message for - [DataStoreService.GetDataStore][google.cloud.discoveryengine.v1.DataStoreService.GetDataStore] + `DataStoreService.GetDataStore + `__ method. name (str): Required. Full resource name of - [DataStore][google.cloud.discoveryengine.v1.DataStore], + `DataStore + `__, such as ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. - If the caller does not have permission to access the - [DataStore][google.cloud.discoveryengine.v1.DataStore], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `DataStore + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the requested - [DataStore][google.cloud.discoveryengine.v1.DataStore] - does not exist, a NOT_FOUND error is returned. + If the requested `DataStore + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -1190,8 +1201,8 @@ def list_data_stores( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListDataStoresPager: - r"""Lists all the - [DataStore][google.cloud.discoveryengine.v1.DataStore]s + r"""Lists all the `DataStore + `__s associated with the project. .. code-block:: python @@ -1224,17 +1235,20 @@ def sample_list_data_stores(): Args: request (Union[google.cloud.discoveryengine_v1.types.ListDataStoresRequest, dict]): The request object. Request message for - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores] + `DataStoreService.ListDataStores + `__ method. parent (str): - Required. The parent branch resource name, such as + Required. The parent branch resource + name, such as ``projects/{project}/locations/{location}/collections/{collection_id}``. - If the caller does not have permission to list - [DataStore][google.cloud.discoveryengine.v1.DataStore]s - under this location, regardless of whether or not this - data store exists, a PERMISSION_DENIED error is - returned. + If the caller does not have permission + to list `DataStore + `__s + under this location, regardless of + whether or not this data store exists, a + PERMISSION_DENIED error is returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -1250,11 +1264,13 @@ def sample_list_data_stores(): Returns: google.cloud.discoveryengine_v1.services.data_store_service.pagers.ListDataStoresPager: Response message for - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores] - method. + `DataStoreService.ListDataStores + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -1325,8 +1341,8 @@ def delete_data_store( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Deletes a - [DataStore][google.cloud.discoveryengine.v1.DataStore]. + r"""Deletes a `DataStore + `__. .. code-block:: python @@ -1361,22 +1377,26 @@ def sample_delete_data_store(): Args: request (Union[google.cloud.discoveryengine_v1.types.DeleteDataStoreRequest, dict]): The request object. Request message for - [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1.DataStoreService.DeleteDataStore] + `DataStoreService.DeleteDataStore + `__ method. name (str): Required. Full resource name of - [DataStore][google.cloud.discoveryengine.v1.DataStore], + `DataStore + `__, such as ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. - If the caller does not have permission to delete the - [DataStore][google.cloud.discoveryengine.v1.DataStore], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to delete the `DataStore + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the - [DataStore][google.cloud.discoveryengine.v1.DataStore] - to delete does not exist, a NOT_FOUND error is returned. + If the `DataStore + `__ + to delete does not exist, a NOT_FOUND + error is returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -1391,18 +1411,21 @@ def sample_delete_data_store(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. @@ -1471,7 +1494,8 @@ def update_data_store( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_data_store.DataStore: - r"""Updates a [DataStore][google.cloud.discoveryengine.v1.DataStore] + r"""Updates a `DataStore + `__ .. code-block:: python @@ -1505,32 +1529,37 @@ def sample_update_data_store(): Args: request (Union[google.cloud.discoveryengine_v1.types.UpdateDataStoreRequest, dict]): The request object. Request message for - [DataStoreService.UpdateDataStore][google.cloud.discoveryengine.v1.DataStoreService.UpdateDataStore] + `DataStoreService.UpdateDataStore + `__ method. data_store (google.cloud.discoveryengine_v1.types.DataStore): - Required. The - [DataStore][google.cloud.discoveryengine.v1.DataStore] + Required. The `DataStore + `__ to update. - If the caller does not have permission to update the - [DataStore][google.cloud.discoveryengine.v1.DataStore], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to update the `DataStore + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the - [DataStore][google.cloud.discoveryengine.v1.DataStore] - to update does not exist, a NOT_FOUND error is returned. + If the `DataStore + `__ + to update does not exist, a NOT_FOUND + error is returned. This corresponds to the ``data_store`` field on the ``request`` instance; if ``request`` is provided, this should not be set. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [DataStore][google.cloud.discoveryengine.v1.DataStore] + `DataStore + `__ to update. - If an unsupported or unknown field is provided, an - INVALID_ARGUMENT error is returned. + If an unsupported or unknown field is + provided, an INVALID_ARGUMENT error is + returned. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/data_store_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/data_store_service/transports/grpc.py index 1912e521bbea..db9ba149f511 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/data_store_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/data_store_service/transports/grpc.py @@ -114,9 +114,8 @@ def intercept_unary_unary(self, continuation, client_call_details, request): class DataStoreServiceGrpcTransport(DataStoreServiceTransport): """gRPC backend transport for DataStoreService. - Service for managing - [DataStore][google.cloud.discoveryengine.v1.DataStore] - configuration. + Service for managing `DataStore + `__ configuration. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -352,14 +351,14 @@ def create_data_store( ]: r"""Return a callable for the create data store method over gRPC. - Creates a - [DataStore][google.cloud.discoveryengine.v1.DataStore]. - + Creates a `DataStore + `__. DataStore is for storing - [Documents][google.cloud.discoveryengine.v1.Document]. To serve - these documents for Search, or Recommendation use case, an - [Engine][google.cloud.discoveryengine.v1.Engine] needs to be - created separately. + `Documents + `__. To serve + these documents for Search, or Recommendation use case, + an `Engine `__ + needs to be created separately. Returns: Callable[[~.CreateDataStoreRequest], @@ -385,7 +384,8 @@ def get_data_store( ) -> Callable[[data_store_service.GetDataStoreRequest], data_store.DataStore]: r"""Return a callable for the get data store method over gRPC. - Gets a [DataStore][google.cloud.discoveryengine.v1.DataStore]. + Gets a `DataStore + `__. Returns: Callable[[~.GetDataStoreRequest], @@ -414,8 +414,8 @@ def list_data_stores( ]: r"""Return a callable for the list data stores method over gRPC. - Lists all the - [DataStore][google.cloud.discoveryengine.v1.DataStore]s + Lists all the `DataStore + `__s associated with the project. Returns: @@ -444,8 +444,8 @@ def delete_data_store( ]: r"""Return a callable for the delete data store method over gRPC. - Deletes a - [DataStore][google.cloud.discoveryengine.v1.DataStore]. + Deletes a `DataStore + `__. Returns: Callable[[~.DeleteDataStoreRequest], @@ -473,7 +473,8 @@ def update_data_store( ]: r"""Return a callable for the update data store method over gRPC. - Updates a [DataStore][google.cloud.discoveryengine.v1.DataStore] + Updates a `DataStore + `__ Returns: Callable[[~.UpdateDataStoreRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/data_store_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/data_store_service/transports/grpc_asyncio.py index 28891d658dc4..4eb086368dda 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/data_store_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/data_store_service/transports/grpc_asyncio.py @@ -120,9 +120,8 @@ async def intercept_unary_unary(self, continuation, client_call_details, request class DataStoreServiceGrpcAsyncIOTransport(DataStoreServiceTransport): """gRPC AsyncIO backend transport for DataStoreService. - Service for managing - [DataStore][google.cloud.discoveryengine.v1.DataStore] - configuration. + Service for managing `DataStore + `__ configuration. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -360,14 +359,14 @@ def create_data_store( ]: r"""Return a callable for the create data store method over gRPC. - Creates a - [DataStore][google.cloud.discoveryengine.v1.DataStore]. - + Creates a `DataStore + `__. DataStore is for storing - [Documents][google.cloud.discoveryengine.v1.Document]. To serve - these documents for Search, or Recommendation use case, an - [Engine][google.cloud.discoveryengine.v1.Engine] needs to be - created separately. + `Documents + `__. To serve + these documents for Search, or Recommendation use case, + an `Engine `__ + needs to be created separately. Returns: Callable[[~.CreateDataStoreRequest], @@ -395,7 +394,8 @@ def get_data_store( ]: r"""Return a callable for the get data store method over gRPC. - Gets a [DataStore][google.cloud.discoveryengine.v1.DataStore]. + Gets a `DataStore + `__. Returns: Callable[[~.GetDataStoreRequest], @@ -424,8 +424,8 @@ def list_data_stores( ]: r"""Return a callable for the list data stores method over gRPC. - Lists all the - [DataStore][google.cloud.discoveryengine.v1.DataStore]s + Lists all the `DataStore + `__s associated with the project. Returns: @@ -454,8 +454,8 @@ def delete_data_store( ]: r"""Return a callable for the delete data store method over gRPC. - Deletes a - [DataStore][google.cloud.discoveryengine.v1.DataStore]. + Deletes a `DataStore + `__. Returns: Callable[[~.DeleteDataStoreRequest], @@ -483,7 +483,8 @@ def update_data_store( ]: r"""Return a callable for the update data store method over gRPC. - Updates a [DataStore][google.cloud.discoveryengine.v1.DataStore] + Updates a `DataStore + `__ Returns: Callable[[~.UpdateDataStoreRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/data_store_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/data_store_service/transports/rest.py index 39d47ff88a08..3e9f058dc26c 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/data_store_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/data_store_service/transports/rest.py @@ -453,9 +453,8 @@ class DataStoreServiceRestStub: class DataStoreServiceRestTransport(_BaseDataStoreServiceRestTransport): """REST backend synchronous transport for DataStoreService. - Service for managing - [DataStore][google.cloud.discoveryengine.v1.DataStore] - configuration. + Service for managing `DataStore + `__ configuration. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -758,7 +757,8 @@ def __call__( Args: request (~.data_store_service.CreateDataStoreRequest): The request object. Request for - [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1.DataStoreService.CreateDataStore] + `DataStoreService.CreateDataStore + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -913,7 +913,8 @@ def __call__( Args: request (~.data_store_service.DeleteDataStoreRequest): The request object. Request message for - [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1.DataStoreService.DeleteDataStore] + `DataStoreService.DeleteDataStore + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1062,7 +1063,8 @@ def __call__( Args: request (~.data_store_service.GetDataStoreRequest): The request object. Request message for - [DataStoreService.GetDataStore][google.cloud.discoveryengine.v1.DataStoreService.GetDataStore] + `DataStoreService.GetDataStore + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1210,7 +1212,8 @@ def __call__( Args: request (~.data_store_service.ListDataStoresRequest): The request object. Request message for - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores] + `DataStoreService.ListDataStores + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1223,7 +1226,8 @@ def __call__( Returns: ~.data_store_service.ListDataStoresResponse: Response message for - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores] + `DataStoreService.ListDataStores + `__ method. """ @@ -1365,7 +1369,8 @@ def __call__( Args: request (~.data_store_service.UpdateDataStoreRequest): The request object. Request message for - [DataStoreService.UpdateDataStore][google.cloud.discoveryengine.v1.DataStoreService.UpdateDataStore] + `DataStoreService.UpdateDataStore + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/document_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/document_service/async_client.py index 71054e73c44d..224d01a15be2 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/document_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/document_service/async_client.py @@ -76,9 +76,9 @@ class DocumentServiceAsyncClient: - """Service for ingesting - [Document][google.cloud.discoveryengine.v1.Document] information of - the customer's website. + """Service for ingesting `Document + `__ information of the + customer's website. """ _client: DocumentServiceClient @@ -323,7 +323,8 @@ async def get_document( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> document.Document: - r"""Gets a [Document][google.cloud.discoveryengine.v1.Document]. + r"""Gets a `Document + `__. .. code-block:: python @@ -354,22 +355,27 @@ async def sample_get_document(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.GetDocumentRequest, dict]]): The request object. Request message for - [DocumentService.GetDocument][google.cloud.discoveryengine.v1.DocumentService.GetDocument] + `DocumentService.GetDocument + `__ method. name (:class:`str`): Required. Full resource name of - [Document][google.cloud.discoveryengine.v1.Document], + `Document + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}``. - If the caller does not have permission to access the - [Document][google.cloud.discoveryengine.v1.Document], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + If the caller does not have permission + to access the `Document + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. - If the requested - [Document][google.cloud.discoveryengine.v1.Document] - does not exist, a ``NOT_FOUND`` error is returned. + If the requested `Document + `__ + does not exist, a ``NOT_FOUND`` error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -447,8 +453,8 @@ async def list_documents( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListDocumentsAsyncPager: - r"""Gets a list of - [Document][google.cloud.discoveryengine.v1.Document]s. + r"""Gets a list of `Document + `__s. .. code-block:: python @@ -480,19 +486,23 @@ async def sample_list_documents(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.ListDocumentsRequest, dict]]): The request object. Request message for - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments] + `DocumentService.ListDocuments + `__ method. parent (:class:`str`): - Required. The parent branch resource name, such as + Required. The parent branch resource + name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. - Use ``default_branch`` as the branch ID, to list - documents under the default branch. - - If the caller does not have permission to list - [Document][google.cloud.discoveryengine.v1.Document]s - under this branch, regardless of whether or not this - branch exists, a ``PERMISSION_DENIED`` error is - returned. + Use ``default_branch`` as the branch ID, + to list documents under the default + branch. + + If the caller does not have permission + to list `Document + `__s + under this branch, regardless of whether + or not this branch exists, a + ``PERMISSION_DENIED`` error is returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -508,11 +518,13 @@ async def sample_list_documents(): Returns: google.cloud.discoveryengine_v1.services.document_service.pagers.ListDocumentsAsyncPager: Response message for - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments] - method. + `DocumentService.ListDocuments + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -586,7 +598,8 @@ async def create_document( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_document.Document: - r"""Creates a [Document][google.cloud.discoveryengine.v1.Document]. + r"""Creates a `Document + `__. .. code-block:: python @@ -618,44 +631,53 @@ async def sample_create_document(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.CreateDocumentRequest, dict]]): The request object. Request message for - [DocumentService.CreateDocument][google.cloud.discoveryengine.v1.DocumentService.CreateDocument] + `DocumentService.CreateDocument + `__ method. parent (:class:`str`): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. document (:class:`google.cloud.discoveryengine_v1.types.Document`): - Required. The - [Document][google.cloud.discoveryengine.v1.Document] to - create. + Required. The `Document + `__ + to create. This corresponds to the ``document`` field on the ``request`` instance; if ``request`` is provided, this should not be set. document_id (:class:`str`): Required. The ID to use for the - [Document][google.cloud.discoveryengine.v1.Document], + `Document + `__, which becomes the final component of the - [Document.name][google.cloud.discoveryengine.v1.Document.name]. - - If the caller does not have permission to create the - [Document][google.cloud.discoveryengine.v1.Document], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + `Document.name + `__. + + If the caller does not have permission + to create the `Document + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. This field must be unique among all - [Document][google.cloud.discoveryengine.v1.Document]s - with the same - [parent][google.cloud.discoveryengine.v1.CreateDocumentRequest.parent]. - Otherwise, an ``ALREADY_EXISTS`` error is returned. - - This field must conform to - `RFC-1034 `__ - standard with a length limit of 128 characters. - Otherwise, an ``INVALID_ARGUMENT`` error is returned. + `Document + `__s + with the same `parent + `__. + Otherwise, an ``ALREADY_EXISTS`` error + is returned. + + This field must conform to `RFC-1034 + `__ + standard with a length limit of 128 + characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. This corresponds to the ``document_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -738,7 +760,8 @@ async def update_document( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_document.Document: - r"""Updates a [Document][google.cloud.discoveryengine.v1.Document]. + r"""Updates a `Document + `__. .. code-block:: python @@ -768,21 +791,26 @@ async def sample_update_document(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.UpdateDocumentRequest, dict]]): The request object. Request message for - [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1.DocumentService.UpdateDocument] + `DocumentService.UpdateDocument + `__ method. document (:class:`google.cloud.discoveryengine_v1.types.Document`): Required. The document to update/create. - If the caller does not have permission to update the - [Document][google.cloud.discoveryengine.v1.Document], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + If the caller does not have permission + to update the `Document + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. - If the - [Document][google.cloud.discoveryengine.v1.Document] to - update does not exist and - [allow_missing][google.cloud.discoveryengine.v1.UpdateDocumentRequest.allow_missing] - is not set, a ``NOT_FOUND`` error is returned. + If the `Document + `__ + to update does not exist and + `allow_missing + `__ + is not set, a ``NOT_FOUND`` error is + returned. This corresponds to the ``document`` field on the ``request`` instance; if ``request`` is provided, this @@ -873,7 +901,8 @@ async def delete_document( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> None: - r"""Deletes a [Document][google.cloud.discoveryengine.v1.Document]. + r"""Deletes a `Document + `__. .. code-block:: python @@ -901,24 +930,28 @@ async def sample_delete_document(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.DeleteDocumentRequest, dict]]): The request object. Request message for - [DocumentService.DeleteDocument][google.cloud.discoveryengine.v1.DocumentService.DeleteDocument] + `DocumentService.DeleteDocument + `__ method. name (:class:`str`): Required. Full resource name of - [Document][google.cloud.discoveryengine.v1.Document], + `Document + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}``. - If the caller does not have permission to delete the - [Document][google.cloud.discoveryengine.v1.Document], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. - - If the - [Document][google.cloud.discoveryengine.v1.Document] to - delete does not exist, a ``NOT_FOUND`` error is + If the caller does not have permission + to delete the `Document + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is returned. + If the `Document + `__ + to delete does not exist, a + ``NOT_FOUND`` error is returned. + This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this should not be set. @@ -985,12 +1018,14 @@ async def import_documents( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: r"""Bulk import of multiple - [Document][google.cloud.discoveryengine.v1.Document]s. Request - processing may be synchronous. Non-existing items are created. + `Document + `__s. Request + processing may be synchronous. Non-existing items are + created. Note: It is possible for a subset of the - [Document][google.cloud.discoveryengine.v1.Document]s to be - successfully updated. + `Document `__s + to be successfully updated. .. code-block:: python @@ -1035,14 +1070,17 @@ async def sample_import_documents(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.ImportDocumentsResponse` Response of the - [ImportDocumentsRequest][google.cloud.discoveryengine.v1.ImportDocumentsRequest]. - If the long running operation is done, then this - message is returned by the - google.longrunning.Operations.response field if the - operation was successful. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.ImportDocumentsResponse` + Response of the `ImportDocumentsRequest + `__. + If the long running operation is done, + then this message is returned by the + google.longrunning.Operations.response + field if the operation was successful. """ # Create or coerce a protobuf request object. @@ -1094,23 +1132,26 @@ async def purge_documents( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: r"""Permanently deletes all selected - [Document][google.cloud.discoveryengine.v1.Document]s in a - branch. + `Document `__s + in a branch. This process is asynchronous. Depending on the number of - [Document][google.cloud.discoveryengine.v1.Document]s to be - deleted, this operation can take hours to complete. Before the - delete operation completes, some - [Document][google.cloud.discoveryengine.v1.Document]s might - still be returned by - [DocumentService.GetDocument][google.cloud.discoveryengine.v1.DocumentService.GetDocument] + `Document `__s + to be deleted, this operation can take hours to + complete. Before the delete operation completes, some + `Document `__s + might still be returned by + `DocumentService.GetDocument + `__ or - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments]. + `DocumentService.ListDocuments + `__. - To get a list of the - [Document][google.cloud.discoveryengine.v1.Document]s to be + To get a list of the `Document + `__s to be deleted, set - [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1.PurgeDocumentsRequest.force] + `PurgeDocumentsRequest.force + `__ to false. .. code-block:: python @@ -1151,7 +1192,8 @@ async def sample_purge_documents(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.PurgeDocumentsRequest, dict]]): The request object. Request message for - [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1.DocumentService.PurgeDocuments] + `DocumentService.PurgeDocuments + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -1163,13 +1205,19 @@ async def sample_purge_documents(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.PurgeDocumentsResponse` Response message for - [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1.DocumentService.PurgeDocuments] - method. If the long running operation is successfully - done, then this message is returned by the - google.longrunning.Operations.response field. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.PurgeDocumentsResponse` + Response message for + `DocumentService.PurgeDocuments + `__ + method. If the long running operation is + successfully done, then this message is + returned by the + google.longrunning.Operations.response + field. """ # Create or coerce a protobuf request object. @@ -1224,8 +1272,9 @@ async def batch_get_documents_metadata( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> document_service.BatchGetDocumentsMetadataResponse: r"""Gets index freshness metadata for - [Document][google.cloud.discoveryengine.v1.Document]s. Supported - for website search only. + `Document + `__s. + Supported for website search only. .. code-block:: python @@ -1256,10 +1305,12 @@ async def sample_batch_get_documents_metadata(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.BatchGetDocumentsMetadataRequest, dict]]): The request object. Request message for - [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1.DocumentService.BatchGetDocumentsMetadata] + `DocumentService.BatchGetDocumentsMetadata + `__ method. parent (:class:`str`): - Required. The parent branch resource name, such as + Required. The parent branch resource + name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. This corresponds to the ``parent`` field @@ -1276,8 +1327,9 @@ async def sample_batch_get_documents_metadata(): Returns: google.cloud.discoveryengine_v1.types.BatchGetDocumentsMetadataResponse: Response message for - [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1.DocumentService.BatchGetDocumentsMetadata] - method. + `DocumentService.BatchGetDocumentsMetadata + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/document_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/document_service/client.py index 1b4043d931d9..36f0a2f0f3e9 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/document_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/document_service/client.py @@ -122,9 +122,9 @@ def get_transport_class( class DocumentServiceClient(metaclass=DocumentServiceClientMeta): - """Service for ingesting - [Document][google.cloud.discoveryengine.v1.Document] information of - the customer's website. + """Service for ingesting `Document + `__ information of the + customer's website. """ @staticmethod @@ -818,7 +818,8 @@ def get_document( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> document.Document: - r"""Gets a [Document][google.cloud.discoveryengine.v1.Document]. + r"""Gets a `Document + `__. .. code-block:: python @@ -849,22 +850,27 @@ def sample_get_document(): Args: request (Union[google.cloud.discoveryengine_v1.types.GetDocumentRequest, dict]): The request object. Request message for - [DocumentService.GetDocument][google.cloud.discoveryengine.v1.DocumentService.GetDocument] + `DocumentService.GetDocument + `__ method. name (str): Required. Full resource name of - [Document][google.cloud.discoveryengine.v1.Document], + `Document + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}``. - If the caller does not have permission to access the - [Document][google.cloud.discoveryengine.v1.Document], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + If the caller does not have permission + to access the `Document + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. - If the requested - [Document][google.cloud.discoveryengine.v1.Document] - does not exist, a ``NOT_FOUND`` error is returned. + If the requested `Document + `__ + does not exist, a ``NOT_FOUND`` error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -939,8 +945,8 @@ def list_documents( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListDocumentsPager: - r"""Gets a list of - [Document][google.cloud.discoveryengine.v1.Document]s. + r"""Gets a list of `Document + `__s. .. code-block:: python @@ -972,19 +978,23 @@ def sample_list_documents(): Args: request (Union[google.cloud.discoveryengine_v1.types.ListDocumentsRequest, dict]): The request object. Request message for - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments] + `DocumentService.ListDocuments + `__ method. parent (str): - Required. The parent branch resource name, such as + Required. The parent branch resource + name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. - Use ``default_branch`` as the branch ID, to list - documents under the default branch. - - If the caller does not have permission to list - [Document][google.cloud.discoveryengine.v1.Document]s - under this branch, regardless of whether or not this - branch exists, a ``PERMISSION_DENIED`` error is - returned. + Use ``default_branch`` as the branch ID, + to list documents under the default + branch. + + If the caller does not have permission + to list `Document + `__s + under this branch, regardless of whether + or not this branch exists, a + ``PERMISSION_DENIED`` error is returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -1000,11 +1010,13 @@ def sample_list_documents(): Returns: google.cloud.discoveryengine_v1.services.document_service.pagers.ListDocumentsPager: Response message for - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments] - method. + `DocumentService.ListDocuments + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -1075,7 +1087,8 @@ def create_document( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_document.Document: - r"""Creates a [Document][google.cloud.discoveryengine.v1.Document]. + r"""Creates a `Document + `__. .. code-block:: python @@ -1107,44 +1120,53 @@ def sample_create_document(): Args: request (Union[google.cloud.discoveryengine_v1.types.CreateDocumentRequest, dict]): The request object. Request message for - [DocumentService.CreateDocument][google.cloud.discoveryengine.v1.DocumentService.CreateDocument] + `DocumentService.CreateDocument + `__ method. parent (str): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. document (google.cloud.discoveryengine_v1.types.Document): - Required. The - [Document][google.cloud.discoveryengine.v1.Document] to - create. + Required. The `Document + `__ + to create. This corresponds to the ``document`` field on the ``request`` instance; if ``request`` is provided, this should not be set. document_id (str): Required. The ID to use for the - [Document][google.cloud.discoveryengine.v1.Document], + `Document + `__, which becomes the final component of the - [Document.name][google.cloud.discoveryengine.v1.Document.name]. - - If the caller does not have permission to create the - [Document][google.cloud.discoveryengine.v1.Document], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + `Document.name + `__. + + If the caller does not have permission + to create the `Document + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. This field must be unique among all - [Document][google.cloud.discoveryengine.v1.Document]s - with the same - [parent][google.cloud.discoveryengine.v1.CreateDocumentRequest.parent]. - Otherwise, an ``ALREADY_EXISTS`` error is returned. - - This field must conform to - `RFC-1034 `__ - standard with a length limit of 128 characters. - Otherwise, an ``INVALID_ARGUMENT`` error is returned. + `Document + `__s + with the same `parent + `__. + Otherwise, an ``ALREADY_EXISTS`` error + is returned. + + This field must conform to `RFC-1034 + `__ + standard with a length limit of 128 + characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. This corresponds to the ``document_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -1224,7 +1246,8 @@ def update_document( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_document.Document: - r"""Updates a [Document][google.cloud.discoveryengine.v1.Document]. + r"""Updates a `Document + `__. .. code-block:: python @@ -1254,21 +1277,26 @@ def sample_update_document(): Args: request (Union[google.cloud.discoveryengine_v1.types.UpdateDocumentRequest, dict]): The request object. Request message for - [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1.DocumentService.UpdateDocument] + `DocumentService.UpdateDocument + `__ method. document (google.cloud.discoveryengine_v1.types.Document): Required. The document to update/create. - If the caller does not have permission to update the - [Document][google.cloud.discoveryengine.v1.Document], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + If the caller does not have permission + to update the `Document + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. - If the - [Document][google.cloud.discoveryengine.v1.Document] to - update does not exist and - [allow_missing][google.cloud.discoveryengine.v1.UpdateDocumentRequest.allow_missing] - is not set, a ``NOT_FOUND`` error is returned. + If the `Document + `__ + to update does not exist and + `allow_missing + `__ + is not set, a ``NOT_FOUND`` error is + returned. This corresponds to the ``document`` field on the ``request`` instance; if ``request`` is provided, this @@ -1356,7 +1384,8 @@ def delete_document( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> None: - r"""Deletes a [Document][google.cloud.discoveryengine.v1.Document]. + r"""Deletes a `Document + `__. .. code-block:: python @@ -1384,24 +1413,28 @@ def sample_delete_document(): Args: request (Union[google.cloud.discoveryengine_v1.types.DeleteDocumentRequest, dict]): The request object. Request message for - [DocumentService.DeleteDocument][google.cloud.discoveryengine.v1.DocumentService.DeleteDocument] + `DocumentService.DeleteDocument + `__ method. name (str): Required. Full resource name of - [Document][google.cloud.discoveryengine.v1.Document], + `Document + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}``. - If the caller does not have permission to delete the - [Document][google.cloud.discoveryengine.v1.Document], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. - - If the - [Document][google.cloud.discoveryengine.v1.Document] to - delete does not exist, a ``NOT_FOUND`` error is + If the caller does not have permission + to delete the `Document + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is returned. + If the `Document + `__ + to delete does not exist, a + ``NOT_FOUND`` error is returned. + This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this should not be set. @@ -1465,12 +1498,14 @@ def import_documents( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: r"""Bulk import of multiple - [Document][google.cloud.discoveryengine.v1.Document]s. Request - processing may be synchronous. Non-existing items are created. + `Document + `__s. Request + processing may be synchronous. Non-existing items are + created. Note: It is possible for a subset of the - [Document][google.cloud.discoveryengine.v1.Document]s to be - successfully updated. + `Document `__s + to be successfully updated. .. code-block:: python @@ -1515,14 +1550,17 @@ def sample_import_documents(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.ImportDocumentsResponse` Response of the - [ImportDocumentsRequest][google.cloud.discoveryengine.v1.ImportDocumentsRequest]. - If the long running operation is done, then this - message is returned by the - google.longrunning.Operations.response field if the - operation was successful. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.ImportDocumentsResponse` + Response of the `ImportDocumentsRequest + `__. + If the long running operation is done, + then this message is returned by the + google.longrunning.Operations.response + field if the operation was successful. """ # Create or coerce a protobuf request object. @@ -1572,23 +1610,26 @@ def purge_documents( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: r"""Permanently deletes all selected - [Document][google.cloud.discoveryengine.v1.Document]s in a - branch. + `Document `__s + in a branch. This process is asynchronous. Depending on the number of - [Document][google.cloud.discoveryengine.v1.Document]s to be - deleted, this operation can take hours to complete. Before the - delete operation completes, some - [Document][google.cloud.discoveryengine.v1.Document]s might - still be returned by - [DocumentService.GetDocument][google.cloud.discoveryengine.v1.DocumentService.GetDocument] + `Document `__s + to be deleted, this operation can take hours to + complete. Before the delete operation completes, some + `Document `__s + might still be returned by + `DocumentService.GetDocument + `__ or - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments]. + `DocumentService.ListDocuments + `__. - To get a list of the - [Document][google.cloud.discoveryengine.v1.Document]s to be + To get a list of the `Document + `__s to be deleted, set - [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1.PurgeDocumentsRequest.force] + `PurgeDocumentsRequest.force + `__ to false. .. code-block:: python @@ -1629,7 +1670,8 @@ def sample_purge_documents(): Args: request (Union[google.cloud.discoveryengine_v1.types.PurgeDocumentsRequest, dict]): The request object. Request message for - [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1.DocumentService.PurgeDocuments] + `DocumentService.PurgeDocuments + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1641,13 +1683,19 @@ def sample_purge_documents(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.PurgeDocumentsResponse` Response message for - [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1.DocumentService.PurgeDocuments] - method. If the long running operation is successfully - done, then this message is returned by the - google.longrunning.Operations.response field. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.PurgeDocumentsResponse` + Response message for + `DocumentService.PurgeDocuments + `__ + method. If the long running operation is + successfully done, then this message is + returned by the + google.longrunning.Operations.response + field. """ # Create or coerce a protobuf request object. @@ -1700,8 +1748,9 @@ def batch_get_documents_metadata( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> document_service.BatchGetDocumentsMetadataResponse: r"""Gets index freshness metadata for - [Document][google.cloud.discoveryengine.v1.Document]s. Supported - for website search only. + `Document + `__s. + Supported for website search only. .. code-block:: python @@ -1732,10 +1781,12 @@ def sample_batch_get_documents_metadata(): Args: request (Union[google.cloud.discoveryengine_v1.types.BatchGetDocumentsMetadataRequest, dict]): The request object. Request message for - [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1.DocumentService.BatchGetDocumentsMetadata] + `DocumentService.BatchGetDocumentsMetadata + `__ method. parent (str): - Required. The parent branch resource name, such as + Required. The parent branch resource + name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. This corresponds to the ``parent`` field @@ -1752,8 +1803,9 @@ def sample_batch_get_documents_metadata(): Returns: google.cloud.discoveryengine_v1.types.BatchGetDocumentsMetadataResponse: Response message for - [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1.DocumentService.BatchGetDocumentsMetadata] - method. + `DocumentService.BatchGetDocumentsMetadata + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/document_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/document_service/transports/grpc.py index 05e0a2d3f1d3..fc132a105b3a 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/document_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/document_service/transports/grpc.py @@ -119,9 +119,9 @@ def intercept_unary_unary(self, continuation, client_call_details, request): class DocumentServiceGrpcTransport(DocumentServiceTransport): """gRPC backend transport for DocumentService. - Service for ingesting - [Document][google.cloud.discoveryengine.v1.Document] information of - the customer's website. + Service for ingesting `Document + `__ information of the + customer's website. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -355,7 +355,8 @@ def get_document( ) -> Callable[[document_service.GetDocumentRequest], document.Document]: r"""Return a callable for the get document method over gRPC. - Gets a [Document][google.cloud.discoveryengine.v1.Document]. + Gets a `Document + `__. Returns: Callable[[~.GetDocumentRequest], @@ -383,8 +384,8 @@ def list_documents( ]: r"""Return a callable for the list documents method over gRPC. - Gets a list of - [Document][google.cloud.discoveryengine.v1.Document]s. + Gets a list of `Document + `__s. Returns: Callable[[~.ListDocumentsRequest], @@ -410,7 +411,8 @@ def create_document( ) -> Callable[[document_service.CreateDocumentRequest], gcd_document.Document]: r"""Return a callable for the create document method over gRPC. - Creates a [Document][google.cloud.discoveryengine.v1.Document]. + Creates a `Document + `__. Returns: Callable[[~.CreateDocumentRequest], @@ -436,7 +438,8 @@ def update_document( ) -> Callable[[document_service.UpdateDocumentRequest], gcd_document.Document]: r"""Return a callable for the update document method over gRPC. - Updates a [Document][google.cloud.discoveryengine.v1.Document]. + Updates a `Document + `__. Returns: Callable[[~.UpdateDocumentRequest], @@ -462,7 +465,8 @@ def delete_document( ) -> Callable[[document_service.DeleteDocumentRequest], empty_pb2.Empty]: r"""Return a callable for the delete document method over gRPC. - Deletes a [Document][google.cloud.discoveryengine.v1.Document]. + Deletes a `Document + `__. Returns: Callable[[~.DeleteDocumentRequest], @@ -489,12 +493,14 @@ def import_documents( r"""Return a callable for the import documents method over gRPC. Bulk import of multiple - [Document][google.cloud.discoveryengine.v1.Document]s. Request - processing may be synchronous. Non-existing items are created. + `Document + `__s. Request + processing may be synchronous. Non-existing items are + created. Note: It is possible for a subset of the - [Document][google.cloud.discoveryengine.v1.Document]s to be - successfully updated. + `Document `__s + to be successfully updated. Returns: Callable[[~.ImportDocumentsRequest], @@ -521,23 +527,26 @@ def purge_documents( r"""Return a callable for the purge documents method over gRPC. Permanently deletes all selected - [Document][google.cloud.discoveryengine.v1.Document]s in a - branch. + `Document `__s + in a branch. This process is asynchronous. Depending on the number of - [Document][google.cloud.discoveryengine.v1.Document]s to be - deleted, this operation can take hours to complete. Before the - delete operation completes, some - [Document][google.cloud.discoveryengine.v1.Document]s might - still be returned by - [DocumentService.GetDocument][google.cloud.discoveryengine.v1.DocumentService.GetDocument] + `Document `__s + to be deleted, this operation can take hours to + complete. Before the delete operation completes, some + `Document `__s + might still be returned by + `DocumentService.GetDocument + `__ or - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments]. + `DocumentService.ListDocuments + `__. - To get a list of the - [Document][google.cloud.discoveryengine.v1.Document]s to be + To get a list of the `Document + `__s to be deleted, set - [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1.PurgeDocumentsRequest.force] + `PurgeDocumentsRequest.force + `__ to false. Returns: @@ -568,8 +577,9 @@ def batch_get_documents_metadata( r"""Return a callable for the batch get documents metadata method over gRPC. Gets index freshness metadata for - [Document][google.cloud.discoveryengine.v1.Document]s. Supported - for website search only. + `Document + `__s. + Supported for website search only. Returns: Callable[[~.BatchGetDocumentsMetadataRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/document_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/document_service/transports/grpc_asyncio.py index 77f762d0e1d3..d9af31ec0683 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/document_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/document_service/transports/grpc_asyncio.py @@ -125,9 +125,9 @@ async def intercept_unary_unary(self, continuation, client_call_details, request class DocumentServiceGrpcAsyncIOTransport(DocumentServiceTransport): """gRPC AsyncIO backend transport for DocumentService. - Service for ingesting - [Document][google.cloud.discoveryengine.v1.Document] information of - the customer's website. + Service for ingesting `Document + `__ information of the + customer's website. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -363,7 +363,8 @@ def get_document( ) -> Callable[[document_service.GetDocumentRequest], Awaitable[document.Document]]: r"""Return a callable for the get document method over gRPC. - Gets a [Document][google.cloud.discoveryengine.v1.Document]. + Gets a `Document + `__. Returns: Callable[[~.GetDocumentRequest], @@ -392,8 +393,8 @@ def list_documents( ]: r"""Return a callable for the list documents method over gRPC. - Gets a list of - [Document][google.cloud.discoveryengine.v1.Document]s. + Gets a list of `Document + `__s. Returns: Callable[[~.ListDocumentsRequest], @@ -421,7 +422,8 @@ def create_document( ]: r"""Return a callable for the create document method over gRPC. - Creates a [Document][google.cloud.discoveryengine.v1.Document]. + Creates a `Document + `__. Returns: Callable[[~.CreateDocumentRequest], @@ -449,7 +451,8 @@ def update_document( ]: r"""Return a callable for the update document method over gRPC. - Updates a [Document][google.cloud.discoveryengine.v1.Document]. + Updates a `Document + `__. Returns: Callable[[~.UpdateDocumentRequest], @@ -475,7 +478,8 @@ def delete_document( ) -> Callable[[document_service.DeleteDocumentRequest], Awaitable[empty_pb2.Empty]]: r"""Return a callable for the delete document method over gRPC. - Deletes a [Document][google.cloud.discoveryengine.v1.Document]. + Deletes a `Document + `__. Returns: Callable[[~.DeleteDocumentRequest], @@ -504,12 +508,14 @@ def import_documents( r"""Return a callable for the import documents method over gRPC. Bulk import of multiple - [Document][google.cloud.discoveryengine.v1.Document]s. Request - processing may be synchronous. Non-existing items are created. + `Document + `__s. Request + processing may be synchronous. Non-existing items are + created. Note: It is possible for a subset of the - [Document][google.cloud.discoveryengine.v1.Document]s to be - successfully updated. + `Document `__s + to be successfully updated. Returns: Callable[[~.ImportDocumentsRequest], @@ -538,23 +544,26 @@ def purge_documents( r"""Return a callable for the purge documents method over gRPC. Permanently deletes all selected - [Document][google.cloud.discoveryengine.v1.Document]s in a - branch. + `Document `__s + in a branch. This process is asynchronous. Depending on the number of - [Document][google.cloud.discoveryengine.v1.Document]s to be - deleted, this operation can take hours to complete. Before the - delete operation completes, some - [Document][google.cloud.discoveryengine.v1.Document]s might - still be returned by - [DocumentService.GetDocument][google.cloud.discoveryengine.v1.DocumentService.GetDocument] + `Document `__s + to be deleted, this operation can take hours to + complete. Before the delete operation completes, some + `Document `__s + might still be returned by + `DocumentService.GetDocument + `__ or - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments]. + `DocumentService.ListDocuments + `__. - To get a list of the - [Document][google.cloud.discoveryengine.v1.Document]s to be + To get a list of the `Document + `__s to be deleted, set - [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1.PurgeDocumentsRequest.force] + `PurgeDocumentsRequest.force + `__ to false. Returns: @@ -585,8 +594,9 @@ def batch_get_documents_metadata( r"""Return a callable for the batch get documents metadata method over gRPC. Gets index freshness metadata for - [Document][google.cloud.discoveryengine.v1.Document]s. Supported - for website search only. + `Document + `__s. + Supported for website search only. Returns: Callable[[~.BatchGetDocumentsMetadataRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/document_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/document_service/transports/rest.py index 50a4d46dde6f..15487b320251 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/document_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/document_service/transports/rest.py @@ -585,9 +585,9 @@ class DocumentServiceRestStub: class DocumentServiceRestTransport(_BaseDocumentServiceRestTransport): """REST backend synchronous transport for DocumentService. - Service for ingesting - [Document][google.cloud.discoveryengine.v1.Document] information of - the customer's website. + Service for ingesting `Document + `__ information of the + customer's website. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -890,7 +890,8 @@ def __call__( Args: request (~.document_service.BatchGetDocumentsMetadataRequest): The request object. Request message for - [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1.DocumentService.BatchGetDocumentsMetadata] + `DocumentService.BatchGetDocumentsMetadata + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -903,7 +904,8 @@ def __call__( Returns: ~.document_service.BatchGetDocumentsMetadataResponse: Response message for - [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1.DocumentService.BatchGetDocumentsMetadata] + `DocumentService.BatchGetDocumentsMetadata + `__ method. """ @@ -1048,7 +1050,8 @@ def __call__( Args: request (~.document_service.CreateDocumentRequest): The request object. Request message for - [DocumentService.CreateDocument][google.cloud.discoveryengine.v1.DocumentService.CreateDocument] + `DocumentService.CreateDocument + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1202,7 +1205,8 @@ def __call__( Args: request (~.document_service.DeleteDocumentRequest): The request object. Request message for - [DocumentService.DeleteDocument][google.cloud.discoveryengine.v1.DocumentService.DeleteDocument] + `DocumentService.DeleteDocument + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1310,7 +1314,8 @@ def __call__( Args: request (~.document_service.GetDocumentRequest): The request object. Request message for - [DocumentService.GetDocument][google.cloud.discoveryengine.v1.DocumentService.GetDocument] + `DocumentService.GetDocument + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1612,7 +1617,8 @@ def __call__( Args: request (~.document_service.ListDocumentsRequest): The request object. Request message for - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments] + `DocumentService.ListDocuments + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1625,7 +1631,8 @@ def __call__( Returns: ~.document_service.ListDocumentsResponse: Response message for - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments] + `DocumentService.ListDocuments + `__ method. """ @@ -1764,7 +1771,8 @@ def __call__( Args: request (~.purge_config.PurgeDocumentsRequest): The request object. Request message for - [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1.DocumentService.PurgeDocuments] + `DocumentService.PurgeDocuments + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1917,7 +1925,8 @@ def __call__( Args: request (~.document_service.UpdateDocumentRequest): The request object. Request message for - [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1.DocumentService.UpdateDocument] + `DocumentService.UpdateDocument + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/engine_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/engine_service/async_client.py index 925b30d7dfeb..a65436064ad6 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/engine_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/engine_service/async_client.py @@ -73,8 +73,8 @@ class EngineServiceAsyncClient: - """Service for managing - [Engine][google.cloud.discoveryengine.v1.Engine] configuration. + """Service for managing `Engine + `__ configuration. """ _client: EngineServiceClient @@ -313,7 +313,8 @@ async def create_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Creates a [Engine][google.cloud.discoveryengine.v1.Engine]. + r"""Creates a `Engine + `__. .. code-block:: python @@ -354,34 +355,39 @@ async def sample_create_engine(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.CreateEngineRequest, dict]]): The request object. Request for - [EngineService.CreateEngine][google.cloud.discoveryengine.v1.EngineService.CreateEngine] + `EngineService.CreateEngine + `__ method. parent (:class:`str`): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. engine (:class:`google.cloud.discoveryengine_v1.types.Engine`): - Required. The - [Engine][google.cloud.discoveryengine.v1.Engine] to - create. + Required. The `Engine + `__ + to create. This corresponds to the ``engine`` field on the ``request`` instance; if ``request`` is provided, this should not be set. engine_id (:class:`str`): Required. The ID to use for the - [Engine][google.cloud.discoveryengine.v1.Engine], which - will become the final component of the - [Engine][google.cloud.discoveryengine.v1.Engine]'s + `Engine + `__, + which will become the final component of + the `Engine + `__'s resource name. - This field must conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. - Otherwise, an INVALID_ARGUMENT error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 + characters. Otherwise, an + INVALID_ARGUMENT error is returned. This corresponds to the ``engine_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -396,10 +402,14 @@ async def sample_create_engine(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.Engine` Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1.Engine]. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.Engine` + Metadata that describes the training and + serving parameters of an `Engine + `__. """ # Create or coerce a protobuf request object. @@ -472,7 +482,8 @@ async def delete_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Deletes a [Engine][google.cloud.discoveryengine.v1.Engine]. + r"""Deletes a `Engine + `__. .. code-block:: python @@ -507,21 +518,26 @@ async def sample_delete_engine(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.DeleteEngineRequest, dict]]): The request object. Request message for - [EngineService.DeleteEngine][google.cloud.discoveryengine.v1.EngineService.DeleteEngine] + `EngineService.DeleteEngine + `__ method. name (:class:`str`): Required. Full resource name of - [Engine][google.cloud.discoveryengine.v1.Engine], such - as + `Engine + `__, + such as ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. - If the caller does not have permission to delete the - [Engine][google.cloud.discoveryengine.v1.Engine], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to delete the `Engine + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the [Engine][google.cloud.discoveryengine.v1.Engine] - to delete does not exist, a NOT_FOUND error is returned. + If the `Engine + `__ + to delete does not exist, a NOT_FOUND + error is returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -536,18 +552,21 @@ async def sample_delete_engine(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. @@ -617,7 +636,8 @@ async def update_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_engine.Engine: - r"""Updates an [Engine][google.cloud.discoveryengine.v1.Engine] + r"""Updates an `Engine + `__ .. code-block:: python @@ -652,31 +672,35 @@ async def sample_update_engine(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.UpdateEngineRequest, dict]]): The request object. Request message for - [EngineService.UpdateEngine][google.cloud.discoveryengine.v1.EngineService.UpdateEngine] + `EngineService.UpdateEngine + `__ method. engine (:class:`google.cloud.discoveryengine_v1.types.Engine`): - Required. The - [Engine][google.cloud.discoveryengine.v1.Engine] to - update. - - If the caller does not have permission to update the - [Engine][google.cloud.discoveryengine.v1.Engine], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. - - If the [Engine][google.cloud.discoveryengine.v1.Engine] - to update does not exist, a NOT_FOUND error is returned. + Required. The `Engine + `__ + to update. If the caller does not have + permission to update the `Engine + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. + + If the `Engine + `__ + to update does not exist, a NOT_FOUND + error is returned. This corresponds to the ``engine`` field on the ``request`` instance; if ``request`` is provided, this should not be set. update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): Indicates which fields in the provided - [Engine][google.cloud.discoveryengine.v1.Engine] to - update. + `Engine + `__ + to update. - If an unsupported or unknown field is provided, an - INVALID_ARGUMENT error is returned. + If an unsupported or unknown field is + provided, an INVALID_ARGUMENT error is + returned. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -691,8 +715,9 @@ async def sample_update_engine(): Returns: google.cloud.discoveryengine_v1.types.Engine: - Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ # Create or coerce a protobuf request object. @@ -757,7 +782,8 @@ async def get_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> engine.Engine: - r"""Gets a [Engine][google.cloud.discoveryengine.v1.Engine]. + r"""Gets a `Engine + `__. .. code-block:: python @@ -788,12 +814,14 @@ async def sample_get_engine(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.GetEngineRequest, dict]]): The request object. Request message for - [EngineService.GetEngine][google.cloud.discoveryengine.v1.EngineService.GetEngine] + `EngineService.GetEngine + `__ method. name (:class:`str`): Required. Full resource name of - [Engine][google.cloud.discoveryengine.v1.Engine], such - as + `Engine + `__, + such as ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. This corresponds to the ``name`` field @@ -809,8 +837,9 @@ async def sample_get_engine(): Returns: google.cloud.discoveryengine_v1.types.Engine: - Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ # Create or coerce a protobuf request object. @@ -871,8 +900,9 @@ async def list_engines( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListEnginesAsyncPager: - r"""Lists all the [Engine][google.cloud.discoveryengine.v1.Engine]s - associated with the project. + r"""Lists all the `Engine + `__s associated + with the project. .. code-block:: python @@ -904,10 +934,12 @@ async def sample_list_engines(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.ListEnginesRequest, dict]]): The request object. Request message for - [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines] + `EngineService.ListEngines + `__ method. parent (:class:`str`): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/collections/{collection_id}``. This corresponds to the ``parent`` field @@ -924,11 +956,13 @@ async def sample_list_engines(): Returns: google.cloud.discoveryengine_v1.services.engine_service.pagers.ListEnginesAsyncPager: Response message for - [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines] - method. + `EngineService.ListEngines + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/engine_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/engine_service/client.py index 4254996f18bd..6737a1008e4f 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/engine_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/engine_service/client.py @@ -117,8 +117,8 @@ def get_transport_class( class EngineServiceClient(metaclass=EngineServiceClientMeta): - """Service for managing - [Engine][google.cloud.discoveryengine.v1.Engine] configuration. + """Service for managing `Engine + `__ configuration. """ @staticmethod @@ -758,7 +758,8 @@ def create_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Creates a [Engine][google.cloud.discoveryengine.v1.Engine]. + r"""Creates a `Engine + `__. .. code-block:: python @@ -799,34 +800,39 @@ def sample_create_engine(): Args: request (Union[google.cloud.discoveryengine_v1.types.CreateEngineRequest, dict]): The request object. Request for - [EngineService.CreateEngine][google.cloud.discoveryengine.v1.EngineService.CreateEngine] + `EngineService.CreateEngine + `__ method. parent (str): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. engine (google.cloud.discoveryengine_v1.types.Engine): - Required. The - [Engine][google.cloud.discoveryengine.v1.Engine] to - create. + Required. The `Engine + `__ + to create. This corresponds to the ``engine`` field on the ``request`` instance; if ``request`` is provided, this should not be set. engine_id (str): Required. The ID to use for the - [Engine][google.cloud.discoveryengine.v1.Engine], which - will become the final component of the - [Engine][google.cloud.discoveryengine.v1.Engine]'s + `Engine + `__, + which will become the final component of + the `Engine + `__'s resource name. - This field must conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. - Otherwise, an INVALID_ARGUMENT error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 + characters. Otherwise, an + INVALID_ARGUMENT error is returned. This corresponds to the ``engine_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -841,10 +847,14 @@ def sample_create_engine(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.Engine` Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1.Engine]. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.Engine` + Metadata that describes the training and + serving parameters of an `Engine + `__. """ # Create or coerce a protobuf request object. @@ -914,7 +924,8 @@ def delete_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Deletes a [Engine][google.cloud.discoveryengine.v1.Engine]. + r"""Deletes a `Engine + `__. .. code-block:: python @@ -949,21 +960,26 @@ def sample_delete_engine(): Args: request (Union[google.cloud.discoveryengine_v1.types.DeleteEngineRequest, dict]): The request object. Request message for - [EngineService.DeleteEngine][google.cloud.discoveryengine.v1.EngineService.DeleteEngine] + `EngineService.DeleteEngine + `__ method. name (str): Required. Full resource name of - [Engine][google.cloud.discoveryengine.v1.Engine], such - as + `Engine + `__, + such as ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. - If the caller does not have permission to delete the - [Engine][google.cloud.discoveryengine.v1.Engine], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to delete the `Engine + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the [Engine][google.cloud.discoveryengine.v1.Engine] - to delete does not exist, a NOT_FOUND error is returned. + If the `Engine + `__ + to delete does not exist, a NOT_FOUND + error is returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -978,18 +994,21 @@ def sample_delete_engine(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. @@ -1056,7 +1075,8 @@ def update_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_engine.Engine: - r"""Updates an [Engine][google.cloud.discoveryengine.v1.Engine] + r"""Updates an `Engine + `__ .. code-block:: python @@ -1091,31 +1111,35 @@ def sample_update_engine(): Args: request (Union[google.cloud.discoveryengine_v1.types.UpdateEngineRequest, dict]): The request object. Request message for - [EngineService.UpdateEngine][google.cloud.discoveryengine.v1.EngineService.UpdateEngine] + `EngineService.UpdateEngine + `__ method. engine (google.cloud.discoveryengine_v1.types.Engine): - Required. The - [Engine][google.cloud.discoveryengine.v1.Engine] to - update. - - If the caller does not have permission to update the - [Engine][google.cloud.discoveryengine.v1.Engine], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. - - If the [Engine][google.cloud.discoveryengine.v1.Engine] - to update does not exist, a NOT_FOUND error is returned. + Required. The `Engine + `__ + to update. If the caller does not have + permission to update the `Engine + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. + + If the `Engine + `__ + to update does not exist, a NOT_FOUND + error is returned. This corresponds to the ``engine`` field on the ``request`` instance; if ``request`` is provided, this should not be set. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [Engine][google.cloud.discoveryengine.v1.Engine] to - update. + `Engine + `__ + to update. - If an unsupported or unknown field is provided, an - INVALID_ARGUMENT error is returned. + If an unsupported or unknown field is + provided, an INVALID_ARGUMENT error is + returned. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -1130,8 +1154,9 @@ def sample_update_engine(): Returns: google.cloud.discoveryengine_v1.types.Engine: - Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ # Create or coerce a protobuf request object. @@ -1193,7 +1218,8 @@ def get_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> engine.Engine: - r"""Gets a [Engine][google.cloud.discoveryengine.v1.Engine]. + r"""Gets a `Engine + `__. .. code-block:: python @@ -1224,12 +1250,14 @@ def sample_get_engine(): Args: request (Union[google.cloud.discoveryengine_v1.types.GetEngineRequest, dict]): The request object. Request message for - [EngineService.GetEngine][google.cloud.discoveryengine.v1.EngineService.GetEngine] + `EngineService.GetEngine + `__ method. name (str): Required. Full resource name of - [Engine][google.cloud.discoveryengine.v1.Engine], such - as + `Engine + `__, + such as ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. This corresponds to the ``name`` field @@ -1245,8 +1273,9 @@ def sample_get_engine(): Returns: google.cloud.discoveryengine_v1.types.Engine: - Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ # Create or coerce a protobuf request object. @@ -1304,8 +1333,9 @@ def list_engines( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListEnginesPager: - r"""Lists all the [Engine][google.cloud.discoveryengine.v1.Engine]s - associated with the project. + r"""Lists all the `Engine + `__s associated + with the project. .. code-block:: python @@ -1337,10 +1367,12 @@ def sample_list_engines(): Args: request (Union[google.cloud.discoveryengine_v1.types.ListEnginesRequest, dict]): The request object. Request message for - [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines] + `EngineService.ListEngines + `__ method. parent (str): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/collections/{collection_id}``. This corresponds to the ``parent`` field @@ -1357,11 +1389,13 @@ def sample_list_engines(): Returns: google.cloud.discoveryengine_v1.services.engine_service.pagers.ListEnginesPager: Response message for - [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines] - method. + `EngineService.ListEngines + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/engine_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/engine_service/transports/grpc.py index c3cfe00e1a7c..702256588298 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/engine_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/engine_service/transports/grpc.py @@ -114,8 +114,8 @@ def intercept_unary_unary(self, continuation, client_call_details, request): class EngineServiceGrpcTransport(EngineServiceTransport): """gRPC backend transport for EngineService. - Service for managing - [Engine][google.cloud.discoveryengine.v1.Engine] configuration. + Service for managing `Engine + `__ configuration. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -349,7 +349,8 @@ def create_engine( ) -> Callable[[engine_service.CreateEngineRequest], operations_pb2.Operation]: r"""Return a callable for the create engine method over gRPC. - Creates a [Engine][google.cloud.discoveryengine.v1.Engine]. + Creates a `Engine + `__. Returns: Callable[[~.CreateEngineRequest], @@ -375,7 +376,8 @@ def delete_engine( ) -> Callable[[engine_service.DeleteEngineRequest], operations_pb2.Operation]: r"""Return a callable for the delete engine method over gRPC. - Deletes a [Engine][google.cloud.discoveryengine.v1.Engine]. + Deletes a `Engine + `__. Returns: Callable[[~.DeleteEngineRequest], @@ -401,7 +403,8 @@ def update_engine( ) -> Callable[[engine_service.UpdateEngineRequest], gcd_engine.Engine]: r"""Return a callable for the update engine method over gRPC. - Updates an [Engine][google.cloud.discoveryengine.v1.Engine] + Updates an `Engine + `__ Returns: Callable[[~.UpdateEngineRequest], @@ -425,7 +428,8 @@ def update_engine( def get_engine(self) -> Callable[[engine_service.GetEngineRequest], engine.Engine]: r"""Return a callable for the get engine method over gRPC. - Gets a [Engine][google.cloud.discoveryengine.v1.Engine]. + Gets a `Engine + `__. Returns: Callable[[~.GetEngineRequest], @@ -453,8 +457,9 @@ def list_engines( ]: r"""Return a callable for the list engines method over gRPC. - Lists all the [Engine][google.cloud.discoveryengine.v1.Engine]s - associated with the project. + Lists all the `Engine + `__s associated + with the project. Returns: Callable[[~.ListEnginesRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/engine_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/engine_service/transports/grpc_asyncio.py index af710f3f1ef7..da8765164075 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/engine_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/engine_service/transports/grpc_asyncio.py @@ -120,8 +120,8 @@ async def intercept_unary_unary(self, continuation, client_call_details, request class EngineServiceGrpcAsyncIOTransport(EngineServiceTransport): """gRPC AsyncIO backend transport for EngineService. - Service for managing - [Engine][google.cloud.discoveryengine.v1.Engine] configuration. + Service for managing `Engine + `__ configuration. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -359,7 +359,8 @@ def create_engine( ]: r"""Return a callable for the create engine method over gRPC. - Creates a [Engine][google.cloud.discoveryengine.v1.Engine]. + Creates a `Engine + `__. Returns: Callable[[~.CreateEngineRequest], @@ -387,7 +388,8 @@ def delete_engine( ]: r"""Return a callable for the delete engine method over gRPC. - Deletes a [Engine][google.cloud.discoveryengine.v1.Engine]. + Deletes a `Engine + `__. Returns: Callable[[~.DeleteEngineRequest], @@ -413,7 +415,8 @@ def update_engine( ) -> Callable[[engine_service.UpdateEngineRequest], Awaitable[gcd_engine.Engine]]: r"""Return a callable for the update engine method over gRPC. - Updates an [Engine][google.cloud.discoveryengine.v1.Engine] + Updates an `Engine + `__ Returns: Callable[[~.UpdateEngineRequest], @@ -439,7 +442,8 @@ def get_engine( ) -> Callable[[engine_service.GetEngineRequest], Awaitable[engine.Engine]]: r"""Return a callable for the get engine method over gRPC. - Gets a [Engine][google.cloud.discoveryengine.v1.Engine]. + Gets a `Engine + `__. Returns: Callable[[~.GetEngineRequest], @@ -468,8 +472,9 @@ def list_engines( ]: r"""Return a callable for the list engines method over gRPC. - Lists all the [Engine][google.cloud.discoveryengine.v1.Engine]s - associated with the project. + Lists all the `Engine + `__s associated + with the project. Returns: Callable[[~.ListEnginesRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/engine_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/engine_service/transports/rest.py index 5db6c2f5a8fe..12669f290f4b 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/engine_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/engine_service/transports/rest.py @@ -442,8 +442,8 @@ class EngineServiceRestStub: class EngineServiceRestTransport(_BaseEngineServiceRestTransport): """REST backend synchronous transport for EngineService. - Service for managing - [Engine][google.cloud.discoveryengine.v1.Engine] configuration. + Service for managing `Engine + `__ configuration. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -745,7 +745,8 @@ def __call__( Args: request (~.engine_service.CreateEngineRequest): The request object. Request for - [EngineService.CreateEngine][google.cloud.discoveryengine.v1.EngineService.CreateEngine] + `EngineService.CreateEngine + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -897,7 +898,8 @@ def __call__( Args: request (~.engine_service.DeleteEngineRequest): The request object. Request message for - [EngineService.DeleteEngine][google.cloud.discoveryengine.v1.EngineService.DeleteEngine] + `EngineService.DeleteEngine + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1044,7 +1046,8 @@ def __call__( Args: request (~.engine_service.GetEngineRequest): The request object. Request message for - [EngineService.GetEngine][google.cloud.discoveryengine.v1.EngineService.GetEngine] + `EngineService.GetEngine + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1056,9 +1059,9 @@ def __call__( Returns: ~.engine.Engine: - Metadata that describes the training and serving - parameters of an - [Engine][google.cloud.discoveryengine.v1.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ @@ -1197,7 +1200,8 @@ def __call__( Args: request (~.engine_service.ListEnginesRequest): The request object. Request message for - [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines] + `EngineService.ListEngines + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1210,7 +1214,8 @@ def __call__( Returns: ~.engine_service.ListEnginesResponse: Response message for - [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines] + `EngineService.ListEngines + `__ method. """ @@ -1351,7 +1356,8 @@ def __call__( Args: request (~.engine_service.UpdateEngineRequest): The request object. Request message for - [EngineService.UpdateEngine][google.cloud.discoveryengine.v1.EngineService.UpdateEngine] + `EngineService.UpdateEngine + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1363,9 +1369,9 @@ def __call__( Returns: ~.gcd_engine.Engine: - Metadata that describes the training and serving - parameters of an - [Engine][google.cloud.discoveryengine.v1.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/grounded_generation_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/grounded_generation_service/async_client.py index f6720459006b..962a1a9cd7de 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/grounded_generation_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/grounded_generation_service/async_client.py @@ -371,8 +371,8 @@ def request_generator(): Args: requests (AsyncIterator[`google.cloud.discoveryengine_v1.types.GenerateGroundedContentRequest`]): - The request object AsyncIterator. Top-level message sent by the client for the - ``GenerateGroundedContent`` method. + The request object AsyncIterator. Top-level message sent by the client for + the ``GenerateGroundedContent`` method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -383,7 +383,9 @@ def request_generator(): Returns: AsyncIterable[google.cloud.discoveryengine_v1.types.GenerateGroundedContentResponse]: - Response for the GenerateGroundedContent method. + Response for the + ``GenerateGroundedContent`` method. + """ # Wrap the RPC method; this adds retry and timeout information, @@ -450,8 +452,8 @@ async def sample_generate_grounded_content(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.GenerateGroundedContentRequest, dict]]): - The request object. Top-level message sent by the client for the - ``GenerateGroundedContent`` method. + The request object. Top-level message sent by the client for + the ``GenerateGroundedContent`` method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -462,7 +464,9 @@ async def sample_generate_grounded_content(): Returns: google.cloud.discoveryengine_v1.types.GenerateGroundedContentResponse: - Response for the GenerateGroundedContent method. + Response for the + ``GenerateGroundedContent`` method. + """ # Create or coerce a protobuf request object. # - Use the request object if provided (there's no risk of modifying the input as @@ -541,7 +545,8 @@ async def sample_check_grounding(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.CheckGroundingRequest, dict]]): The request object. Request message for - [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1.GroundedGenerationService.CheckGrounding] + `GroundedGenerationService.CheckGrounding + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -554,8 +559,9 @@ async def sample_check_grounding(): Returns: google.cloud.discoveryengine_v1.types.CheckGroundingResponse: Response message for the - [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1.GroundedGenerationService.CheckGrounding] - method. + `GroundedGenerationService.CheckGrounding + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/grounded_generation_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/grounded_generation_service/client.py index d1e36741fd1a..84d4f5d711a3 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/grounded_generation_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/grounded_generation_service/client.py @@ -815,8 +815,8 @@ def request_generator(): Args: requests (Iterator[google.cloud.discoveryengine_v1.types.GenerateGroundedContentRequest]): - The request object iterator. Top-level message sent by the client for the - ``GenerateGroundedContent`` method. + The request object iterator. Top-level message sent by the client for + the ``GenerateGroundedContent`` method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -827,7 +827,9 @@ def request_generator(): Returns: Iterable[google.cloud.discoveryengine_v1.types.GenerateGroundedContentResponse]: - Response for the GenerateGroundedContent method. + Response for the + ``GenerateGroundedContent`` method. + """ # Wrap the RPC method; this adds retry and timeout information, @@ -894,8 +896,8 @@ def sample_generate_grounded_content(): Args: request (Union[google.cloud.discoveryengine_v1.types.GenerateGroundedContentRequest, dict]): - The request object. Top-level message sent by the client for the - ``GenerateGroundedContent`` method. + The request object. Top-level message sent by the client for + the ``GenerateGroundedContent`` method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -906,7 +908,9 @@ def sample_generate_grounded_content(): Returns: google.cloud.discoveryengine_v1.types.GenerateGroundedContentResponse: - Response for the GenerateGroundedContent method. + Response for the + ``GenerateGroundedContent`` method. + """ # Create or coerce a protobuf request object. # - Use the request object if provided (there's no risk of modifying the input as @@ -985,7 +989,8 @@ def sample_check_grounding(): Args: request (Union[google.cloud.discoveryengine_v1.types.CheckGroundingRequest, dict]): The request object. Request message for - [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1.GroundedGenerationService.CheckGrounding] + `GroundedGenerationService.CheckGrounding + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -998,8 +1003,9 @@ def sample_check_grounding(): Returns: google.cloud.discoveryengine_v1.types.CheckGroundingResponse: Response message for the - [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1.GroundedGenerationService.CheckGrounding] - method. + `GroundedGenerationService.CheckGrounding + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/grounded_generation_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/grounded_generation_service/transports/rest.py index 85d027c4ce30..a22409469578 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/grounded_generation_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/grounded_generation_service/transports/rest.py @@ -406,7 +406,8 @@ def __call__( Args: request (~.grounded_generation_service.CheckGroundingRequest): The request object. Request message for - [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1.GroundedGenerationService.CheckGrounding] + `GroundedGenerationService.CheckGrounding + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -419,7 +420,8 @@ def __call__( Returns: ~.grounded_generation_service.CheckGroundingResponse: Response message for the - [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1.GroundedGenerationService.CheckGrounding] + `GroundedGenerationService.CheckGrounding + `__ method. """ @@ -569,8 +571,8 @@ def __call__( Args: request (~.grounded_generation_service.GenerateGroundedContentRequest): - The request object. Top-level message sent by the client for the - ``GenerateGroundedContent`` method. + The request object. Top-level message sent by the client for + the ``GenerateGroundedContent`` method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -581,7 +583,9 @@ def __call__( Returns: ~.grounded_generation_service.GenerateGroundedContentResponse: - Response for the ``GenerateGroundedContent`` method. + Response for the + ``GenerateGroundedContent`` method. + """ http_options = ( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/identity_mapping_store_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/identity_mapping_store_service/async_client.py index 68b258cafda5..8c1b2865d314 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/identity_mapping_store_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/identity_mapping_store_service/async_client.py @@ -384,9 +384,11 @@ async def sample_create_identity_mapping_store(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.CreateIdentityMappingStoreRequest, dict]]): The request object. Request message for - [IdentityMappingStoreService.CreateIdentityMappingStore][google.cloud.discoveryengine.v1.IdentityMappingStoreService.CreateIdentityMappingStore] + `IdentityMappingStoreService.CreateIdentityMappingStore + `__ parent (:class:`str`): - Required. The parent collection resource name, such as + Required. The parent collection resource + name, such as ``projects/{project}/locations/{location}``. This corresponds to the ``parent`` field @@ -400,12 +402,12 @@ async def sample_create_identity_mapping_store(): on the ``request`` instance; if ``request`` is provided, this should not be set. identity_mapping_store_id (:class:`str`): - Required. The ID of the Identity Mapping Store to - create. - - The ID must contain only letters (a-z, A-Z), numbers - (0-9), underscores (\_), and hyphens (-). The maximum - length is 63 characters. + Required. The ID of the Identity Mapping + Store to create. + The ID must contain only letters (a-z, + A-Z), numbers (0-9), underscores (_), + and hyphens (-). The maximum length is + 63 characters. This corresponds to the ``identity_mapping_store_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -523,10 +525,12 @@ async def sample_get_identity_mapping_store(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.GetIdentityMappingStoreRequest, dict]]): The request object. Request message for - [IdentityMappingStoreService.GetIdentityMappingStore][google.cloud.discoveryengine.v1.IdentityMappingStoreService.GetIdentityMappingStore] + `IdentityMappingStoreService.GetIdentityMappingStore + `__ name (:class:`str`): - Required. The name of the Identity Mapping Store to get. - Format: + Required. The name of the Identity + Mapping Store to get. Format: + ``projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`` This corresponds to the ``name`` field @@ -647,10 +651,12 @@ async def sample_delete_identity_mapping_store(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.DeleteIdentityMappingStoreRequest, dict]]): The request object. Request message for - [IdentityMappingStoreService.DeleteIdentityMappingStore][google.cloud.discoveryengine.v1.IdentityMappingStoreService.DeleteIdentityMappingStore] + `IdentityMappingStoreService.DeleteIdentityMappingStore + `__ name (:class:`str`): - Required. The name of the Identity Mapping Store to - delete. Format: + Required. The name of the Identity + Mapping Store to delete. Format: + ``projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`` This corresponds to the ``name`` field @@ -666,18 +672,21 @@ async def sample_delete_identity_mapping_store(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. @@ -787,7 +796,8 @@ async def sample_import_identity_mappings(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.ImportIdentityMappingsRequest, dict]]): The request object. Request message for - [IdentityMappingStoreService.ImportIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ImportIdentityMappings] + `IdentityMappingStoreService.ImportIdentityMappings + `__ retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -798,10 +808,14 @@ async def sample_import_identity_mappings(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.ImportIdentityMappingsResponse` Response message for - [IdentityMappingStoreService.ImportIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ImportIdentityMappings] + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.ImportIdentityMappingsResponse` + Response message for + `IdentityMappingStoreService.ImportIdentityMappings + `__ """ # Create or coerce a protobuf request object. @@ -896,7 +910,8 @@ async def sample_purge_identity_mappings(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.PurgeIdentityMappingsRequest, dict]]): The request object. Request message for - [IdentityMappingStoreService.PurgeIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.PurgeIdentityMappings] + `IdentityMappingStoreService.PurgeIdentityMappings + `__ retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -907,18 +922,21 @@ async def sample_purge_identity_mappings(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. @@ -1009,7 +1027,8 @@ async def sample_list_identity_mappings(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.ListIdentityMappingsRequest, dict]]): The request object. Request message for - [IdentityMappingStoreService.ListIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ListIdentityMappings] + `IdentityMappingStoreService.ListIdentityMappings + `__ retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -1021,10 +1040,12 @@ async def sample_list_identity_mappings(): Returns: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.pagers.ListIdentityMappingsAsyncPager: Response message for - [IdentityMappingStoreService.ListIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ListIdentityMappings] + `IdentityMappingStoreService.ListIdentityMappings + `__ - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -1119,10 +1140,12 @@ async def sample_list_identity_mapping_stores(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.ListIdentityMappingStoresRequest, dict]]): The request object. Request message for - [IdentityMappingStoreService.ListIdentityMappingStores][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ListIdentityMappingStores] + `IdentityMappingStoreService.ListIdentityMappingStores + `__ parent (:class:`str`): - Required. The parent of the Identity Mapping Stores to - list. Format: + Required. The parent of the Identity + Mapping Stores to list. Format: + ``projects/{project}/locations/{location}``. This corresponds to the ``parent`` field @@ -1139,10 +1162,12 @@ async def sample_list_identity_mapping_stores(): Returns: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.pagers.ListIdentityMappingStoresAsyncPager: Response message for - [IdentityMappingStoreService.ListIdentityMappingStores][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ListIdentityMappingStores] + `IdentityMappingStoreService.ListIdentityMappingStores + `__ - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/identity_mapping_store_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/identity_mapping_store_service/client.py index 0c75fcee6117..5019b0edabfa 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/identity_mapping_store_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/identity_mapping_store_service/client.py @@ -874,9 +874,11 @@ def sample_create_identity_mapping_store(): Args: request (Union[google.cloud.discoveryengine_v1.types.CreateIdentityMappingStoreRequest, dict]): The request object. Request message for - [IdentityMappingStoreService.CreateIdentityMappingStore][google.cloud.discoveryengine.v1.IdentityMappingStoreService.CreateIdentityMappingStore] + `IdentityMappingStoreService.CreateIdentityMappingStore + `__ parent (str): - Required. The parent collection resource name, such as + Required. The parent collection resource + name, such as ``projects/{project}/locations/{location}``. This corresponds to the ``parent`` field @@ -890,12 +892,12 @@ def sample_create_identity_mapping_store(): on the ``request`` instance; if ``request`` is provided, this should not be set. identity_mapping_store_id (str): - Required. The ID of the Identity Mapping Store to - create. - - The ID must contain only letters (a-z, A-Z), numbers - (0-9), underscores (\_), and hyphens (-). The maximum - length is 63 characters. + Required. The ID of the Identity Mapping + Store to create. + The ID must contain only letters (a-z, + A-Z), numbers (0-9), underscores (_), + and hyphens (-). The maximum length is + 63 characters. This corresponds to the ``identity_mapping_store_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -1012,10 +1014,12 @@ def sample_get_identity_mapping_store(): Args: request (Union[google.cloud.discoveryengine_v1.types.GetIdentityMappingStoreRequest, dict]): The request object. Request message for - [IdentityMappingStoreService.GetIdentityMappingStore][google.cloud.discoveryengine.v1.IdentityMappingStoreService.GetIdentityMappingStore] + `IdentityMappingStoreService.GetIdentityMappingStore + `__ name (str): - Required. The name of the Identity Mapping Store to get. - Format: + Required. The name of the Identity + Mapping Store to get. Format: + ``projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`` This corresponds to the ``name`` field @@ -1135,10 +1139,12 @@ def sample_delete_identity_mapping_store(): Args: request (Union[google.cloud.discoveryengine_v1.types.DeleteIdentityMappingStoreRequest, dict]): The request object. Request message for - [IdentityMappingStoreService.DeleteIdentityMappingStore][google.cloud.discoveryengine.v1.IdentityMappingStoreService.DeleteIdentityMappingStore] + `IdentityMappingStoreService.DeleteIdentityMappingStore + `__ name (str): - Required. The name of the Identity Mapping Store to - delete. Format: + Required. The name of the Identity + Mapping Store to delete. Format: + ``projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`` This corresponds to the ``name`` field @@ -1154,18 +1160,21 @@ def sample_delete_identity_mapping_store(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. @@ -1274,7 +1283,8 @@ def sample_import_identity_mappings(): Args: request (Union[google.cloud.discoveryengine_v1.types.ImportIdentityMappingsRequest, dict]): The request object. Request message for - [IdentityMappingStoreService.ImportIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ImportIdentityMappings] + `IdentityMappingStoreService.ImportIdentityMappings + `__ retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -1285,10 +1295,14 @@ def sample_import_identity_mappings(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.ImportIdentityMappingsResponse` Response message for - [IdentityMappingStoreService.ImportIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ImportIdentityMappings] + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.ImportIdentityMappingsResponse` + Response message for + `IdentityMappingStoreService.ImportIdentityMappings + `__ """ # Create or coerce a protobuf request object. @@ -1381,7 +1395,8 @@ def sample_purge_identity_mappings(): Args: request (Union[google.cloud.discoveryengine_v1.types.PurgeIdentityMappingsRequest, dict]): The request object. Request message for - [IdentityMappingStoreService.PurgeIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.PurgeIdentityMappings] + `IdentityMappingStoreService.PurgeIdentityMappings + `__ retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -1392,18 +1407,21 @@ def sample_purge_identity_mappings(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. @@ -1492,7 +1510,8 @@ def sample_list_identity_mappings(): Args: request (Union[google.cloud.discoveryengine_v1.types.ListIdentityMappingsRequest, dict]): The request object. Request message for - [IdentityMappingStoreService.ListIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ListIdentityMappings] + `IdentityMappingStoreService.ListIdentityMappings + `__ retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -1504,10 +1523,12 @@ def sample_list_identity_mappings(): Returns: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.pagers.ListIdentityMappingsPager: Response message for - [IdentityMappingStoreService.ListIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ListIdentityMappings] + `IdentityMappingStoreService.ListIdentityMappings + `__ - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -1600,10 +1621,12 @@ def sample_list_identity_mapping_stores(): Args: request (Union[google.cloud.discoveryengine_v1.types.ListIdentityMappingStoresRequest, dict]): The request object. Request message for - [IdentityMappingStoreService.ListIdentityMappingStores][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ListIdentityMappingStores] + `IdentityMappingStoreService.ListIdentityMappingStores + `__ parent (str): - Required. The parent of the Identity Mapping Stores to - list. Format: + Required. The parent of the Identity + Mapping Stores to list. Format: + ``projects/{project}/locations/{location}``. This corresponds to the ``parent`` field @@ -1620,10 +1643,12 @@ def sample_list_identity_mapping_stores(): Returns: google.cloud.discoveryengine_v1.services.identity_mapping_store_service.pagers.ListIdentityMappingStoresPager: Response message for - [IdentityMappingStoreService.ListIdentityMappingStores][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ListIdentityMappingStores] + `IdentityMappingStoreService.ListIdentityMappingStores + `__ - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/identity_mapping_store_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/identity_mapping_store_service/transports/rest.py index 96444f77f638..76f237570330 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/identity_mapping_store_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/identity_mapping_store_service/transports/rest.py @@ -887,7 +887,8 @@ def __call__( Args: request (~.identity_mapping_store_service.CreateIdentityMappingStoreRequest): The request object. Request message for - [IdentityMappingStoreService.CreateIdentityMappingStore][google.cloud.discoveryengine.v1.IdentityMappingStoreService.CreateIdentityMappingStore] + `IdentityMappingStoreService.CreateIdentityMappingStore + `__ retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -1052,7 +1053,8 @@ def __call__( Args: request (~.identity_mapping_store_service.DeleteIdentityMappingStoreRequest): The request object. Request message for - [IdentityMappingStoreService.DeleteIdentityMappingStore][google.cloud.discoveryengine.v1.IdentityMappingStoreService.DeleteIdentityMappingStore] + `IdentityMappingStoreService.DeleteIdentityMappingStore + `__ retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -1207,7 +1209,8 @@ def __call__( Args: request (~.identity_mapping_store_service.GetIdentityMappingStoreRequest): The request object. Request message for - [IdentityMappingStoreService.GetIdentityMappingStore][google.cloud.discoveryengine.v1.IdentityMappingStoreService.GetIdentityMappingStore] + `IdentityMappingStoreService.GetIdentityMappingStore + `__ retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -1362,7 +1365,8 @@ def __call__( Args: request (~.identity_mapping_store_service.ImportIdentityMappingsRequest): The request object. Request message for - [IdentityMappingStoreService.ImportIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ImportIdentityMappings] + `IdentityMappingStoreService.ImportIdentityMappings + `__ retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -1516,7 +1520,8 @@ def __call__( Args: request (~.identity_mapping_store_service.ListIdentityMappingsRequest): The request object. Request message for - [IdentityMappingStoreService.ListIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ListIdentityMappings] + `IdentityMappingStoreService.ListIdentityMappings + `__ retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -1528,7 +1533,8 @@ def __call__( Returns: ~.identity_mapping_store_service.ListIdentityMappingsResponse: Response message for - [IdentityMappingStoreService.ListIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ListIdentityMappings] + `IdentityMappingStoreService.ListIdentityMappings + `__ """ @@ -1673,7 +1679,8 @@ def __call__( Args: request (~.identity_mapping_store_service.ListIdentityMappingStoresRequest): The request object. Request message for - [IdentityMappingStoreService.ListIdentityMappingStores][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ListIdentityMappingStores] + `IdentityMappingStoreService.ListIdentityMappingStores + `__ retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -1685,7 +1692,8 @@ def __call__( Returns: ~.identity_mapping_store_service.ListIdentityMappingStoresResponse: Response message for - [IdentityMappingStoreService.ListIdentityMappingStores][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ListIdentityMappingStores] + `IdentityMappingStoreService.ListIdentityMappingStores + `__ """ @@ -1832,7 +1840,8 @@ def __call__( Args: request (~.identity_mapping_store_service.PurgeIdentityMappingsRequest): The request object. Request message for - [IdentityMappingStoreService.PurgeIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.PurgeIdentityMappings] + `IdentityMappingStoreService.PurgeIdentityMappings + `__ retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/project_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/project_service/async_client.py index 70d0d80a8504..338d88c56940 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/project_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/project_service/async_client.py @@ -67,7 +67,7 @@ class ProjectServiceAsyncClient: """Service for operations on the - [Project][google.cloud.discoveryengine.v1.Project]. + `Project `__. """ _client: ProjectServiceClient @@ -302,13 +302,14 @@ async def provision_project( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Provisions the project resource. During the process, related - systems will get prepared and initialized. + r"""Provisions the project resource. During the + process, related systems will get prepared and + initialized. Caller must read the `Terms for data - use `__, and - optionally specify in request to provide consent to that service - terms. + use `__, + and optionally specify in request to provide consent to + that service terms. .. code-block:: python @@ -345,12 +346,15 @@ async def sample_provision_project(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.ProvisionProjectRequest, dict]]): The request object. Request for - [ProjectService.ProvisionProject][google.cloud.discoveryengine.v1.ProjectService.ProvisionProject] + `ProjectService.ProvisionProject + `__ method. name (:class:`str`): Required. Full resource name of a - [Project][google.cloud.discoveryengine.v1.Project], such - as ``projects/{project_id_or_number}``. + `Project + `__, + such as + ``projects/{project_id_or_number}``. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -365,12 +369,13 @@ async def sample_provision_project(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1.types.Project` - Metadata and configurations for a Google Cloud project - in the service. + Metadata and configurations for a Google + Cloud project in the service. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/project_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/project_service/client.py index af3d906d848f..076b0fa2721e 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/project_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/project_service/client.py @@ -113,7 +113,7 @@ def get_transport_class( class ProjectServiceClient(metaclass=ProjectServiceClientMeta): """Service for operations on the - [Project][google.cloud.discoveryengine.v1.Project]. + `Project `__. """ @staticmethod @@ -718,13 +718,14 @@ def provision_project( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Provisions the project resource. During the process, related - systems will get prepared and initialized. + r"""Provisions the project resource. During the + process, related systems will get prepared and + initialized. Caller must read the `Terms for data - use `__, and - optionally specify in request to provide consent to that service - terms. + use `__, + and optionally specify in request to provide consent to + that service terms. .. code-block:: python @@ -761,12 +762,15 @@ def sample_provision_project(): Args: request (Union[google.cloud.discoveryengine_v1.types.ProvisionProjectRequest, dict]): The request object. Request for - [ProjectService.ProvisionProject][google.cloud.discoveryengine.v1.ProjectService.ProvisionProject] + `ProjectService.ProvisionProject + `__ method. name (str): Required. Full resource name of a - [Project][google.cloud.discoveryengine.v1.Project], such - as ``projects/{project_id_or_number}``. + `Project + `__, + such as + ``projects/{project_id_or_number}``. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -781,12 +785,13 @@ def sample_provision_project(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1.types.Project` - Metadata and configurations for a Google Cloud project - in the service. + Metadata and configurations for a Google + Cloud project in the service. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/project_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/project_service/transports/grpc.py index f34176357d51..58ab8161151f 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/project_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/project_service/transports/grpc.py @@ -113,7 +113,7 @@ class ProjectServiceGrpcTransport(ProjectServiceTransport): """gRPC backend transport for ProjectService. Service for operations on the - [Project][google.cloud.discoveryengine.v1.Project]. + `Project `__. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -347,13 +347,14 @@ def provision_project( ) -> Callable[[project_service.ProvisionProjectRequest], operations_pb2.Operation]: r"""Return a callable for the provision project method over gRPC. - Provisions the project resource. During the process, related - systems will get prepared and initialized. + Provisions the project resource. During the + process, related systems will get prepared and + initialized. Caller must read the `Terms for data - use `__, and - optionally specify in request to provide consent to that service - terms. + use `__, + and optionally specify in request to provide consent to + that service terms. Returns: Callable[[~.ProvisionProjectRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/project_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/project_service/transports/grpc_asyncio.py index 4b559d1624d2..949101e682a6 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/project_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/project_service/transports/grpc_asyncio.py @@ -119,7 +119,7 @@ class ProjectServiceGrpcAsyncIOTransport(ProjectServiceTransport): """gRPC AsyncIO backend transport for ProjectService. Service for operations on the - [Project][google.cloud.discoveryengine.v1.Project]. + `Project `__. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -357,13 +357,14 @@ def provision_project( ]: r"""Return a callable for the provision project method over gRPC. - Provisions the project resource. During the process, related - systems will get prepared and initialized. + Provisions the project resource. During the + process, related systems will get prepared and + initialized. Caller must read the `Terms for data - use `__, and - optionally specify in request to provide consent to that service - terms. + use `__, + and optionally specify in request to provide consent to + that service terms. Returns: Callable[[~.ProvisionProjectRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/project_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/project_service/transports/rest.py index 0a0653653735..cc8fdcf7602a 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/project_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/project_service/transports/rest.py @@ -221,7 +221,7 @@ class ProjectServiceRestTransport(_BaseProjectServiceRestTransport): """REST backend synchronous transport for ProjectService. Service for operations on the - [Project][google.cloud.discoveryengine.v1.Project]. + `Project `__. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -523,7 +523,8 @@ def __call__( Args: request (~.project_service.ProvisionProjectRequest): The request object. Request for - [ProjectService.ProvisionProject][google.cloud.discoveryengine.v1.ProjectService.ProvisionProject] + `ProjectService.ProvisionProject + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/rank_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/rank_service/async_client.py index bc75f18dbbf6..012707eee7f0 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/rank_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/rank_service/async_client.py @@ -327,7 +327,8 @@ async def sample_rank(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.RankRequest, dict]]): The request object. Request message for - [RankService.Rank][google.cloud.discoveryengine.v1.RankService.Rank] + `RankService.Rank + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -340,8 +341,9 @@ async def sample_rank(): Returns: google.cloud.discoveryengine_v1.types.RankResponse: Response message for - [RankService.Rank][google.cloud.discoveryengine.v1.RankService.Rank] - method. + `RankService.Rank + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/rank_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/rank_service/client.py index 601055c28dcb..909269cbfdc4 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/rank_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/rank_service/client.py @@ -747,7 +747,8 @@ def sample_rank(): Args: request (Union[google.cloud.discoveryengine_v1.types.RankRequest, dict]): The request object. Request message for - [RankService.Rank][google.cloud.discoveryengine.v1.RankService.Rank] + `RankService.Rank + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -760,8 +761,9 @@ def sample_rank(): Returns: google.cloud.discoveryengine_v1.types.RankResponse: Response message for - [RankService.Rank][google.cloud.discoveryengine.v1.RankService.Rank] - method. + `RankService.Rank + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/rank_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/rank_service/transports/rest.py index ec034858eae5..7be08e2673ff 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/rank_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/rank_service/transports/rest.py @@ -335,7 +335,8 @@ def __call__( Args: request (~.rank_service.RankRequest): The request object. Request message for - [RankService.Rank][google.cloud.discoveryengine.v1.RankService.Rank] + `RankService.Rank + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -348,7 +349,8 @@ def __call__( Returns: ~.rank_service.RankResponse: Response message for - [RankService.Rank][google.cloud.discoveryengine.v1.RankService.Rank] + `RankService.Rank + `__ method. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/schema_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/schema_service/async_client.py index cae8913850a8..944931e59f84 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/schema_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/schema_service/async_client.py @@ -71,8 +71,8 @@ class SchemaServiceAsyncClient: - """Service for managing - [Schema][google.cloud.discoveryengine.v1.Schema]s. + """Service for managing `Schema + `__s. """ _client: SchemaServiceClient @@ -309,7 +309,8 @@ async def get_schema( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> schema.Schema: - r"""Gets a [Schema][google.cloud.discoveryengine.v1.Schema]. + r"""Gets a `Schema + `__. .. code-block:: python @@ -340,11 +341,12 @@ async def sample_get_schema(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.GetSchemaRequest, dict]]): The request object. Request message for - [SchemaService.GetSchema][google.cloud.discoveryengine.v1.SchemaService.GetSchema] + `SchemaService.GetSchema + `__ method. name (:class:`str`): - Required. The full resource name of the schema, in the - format of + Required. The full resource name of the + schema, in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}``. This corresponds to the ``name`` field @@ -422,8 +424,8 @@ async def list_schemas( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListSchemasAsyncPager: - r"""Gets a list of - [Schema][google.cloud.discoveryengine.v1.Schema]s. + r"""Gets a list of `Schema + `__s. .. code-block:: python @@ -455,11 +457,12 @@ async def sample_list_schemas(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.ListSchemasRequest, dict]]): The request object. Request message for - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1.SchemaService.ListSchemas] + `SchemaService.ListSchemas + `__ method. parent (:class:`str`): - Required. The parent data store resource name, in the - format of + Required. The parent data store resource + name, in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}``. This corresponds to the ``parent`` field @@ -476,11 +479,13 @@ async def sample_list_schemas(): Returns: google.cloud.discoveryengine_v1.services.schema_service.pagers.ListSchemasAsyncPager: Response message for - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1.SchemaService.ListSchemas] - method. + `SchemaService.ListSchemas + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -554,7 +559,8 @@ async def create_schema( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Creates a [Schema][google.cloud.discoveryengine.v1.Schema]. + r"""Creates a `Schema + `__. .. code-block:: python @@ -590,33 +596,38 @@ async def sample_create_schema(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.CreateSchemaRequest, dict]]): The request object. Request message for - [SchemaService.CreateSchema][google.cloud.discoveryengine.v1.SchemaService.CreateSchema] + `SchemaService.CreateSchema + `__ method. parent (:class:`str`): - Required. The parent data store resource name, in the - format of + Required. The parent data store resource + name, in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. schema (:class:`google.cloud.discoveryengine_v1.types.Schema`): - Required. The - [Schema][google.cloud.discoveryengine.v1.Schema] to - create. + Required. The `Schema + `__ + to create. This corresponds to the ``schema`` field on the ``request`` instance; if ``request`` is provided, this should not be set. schema_id (:class:`str`): Required. The ID to use for the - [Schema][google.cloud.discoveryengine.v1.Schema], which - becomes the final component of the - [Schema.name][google.cloud.discoveryengine.v1.Schema.name]. + `Schema + `__, + which becomes the final component of the + `Schema.name + `__. This field should conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. + `RFC-1034 + `__ + standard with a length limit of 63 + characters. This corresponds to the ``schema_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -631,12 +642,13 @@ async def sample_create_schema(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1.types.Schema` - Defines the structure and layout of a type of document - data. + Defines the structure and layout of a + type of document data. """ # Create or coerce a protobuf request object. @@ -708,7 +720,8 @@ async def update_schema( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Updates a [Schema][google.cloud.discoveryengine.v1.Schema]. + r"""Updates a `Schema + `__. .. code-block:: python @@ -742,7 +755,8 @@ async def sample_update_schema(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.UpdateSchemaRequest, dict]]): The request object. Request message for - [SchemaService.UpdateSchema][google.cloud.discoveryengine.v1.SchemaService.UpdateSchema] + `SchemaService.UpdateSchema + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -754,12 +768,13 @@ async def sample_update_schema(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1.types.Schema` - Defines the structure and layout of a type of document - data. + Defines the structure and layout of a + type of document data. """ # Create or coerce a protobuf request object. @@ -813,7 +828,8 @@ async def delete_schema( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Deletes a [Schema][google.cloud.discoveryengine.v1.Schema]. + r"""Deletes a `Schema + `__. .. code-block:: python @@ -848,11 +864,12 @@ async def sample_delete_schema(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.DeleteSchemaRequest, dict]]): The request object. Request message for - [SchemaService.DeleteSchema][google.cloud.discoveryengine.v1.SchemaService.DeleteSchema] + `SchemaService.DeleteSchema + `__ method. name (:class:`str`): - Required. The full resource name of the schema, in the - format of + Required. The full resource name of the + schema, in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}``. This corresponds to the ``name`` field @@ -868,18 +885,21 @@ async def sample_delete_schema(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/schema_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/schema_service/client.py index 0f5b6397db4d..5a188a421dcc 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/schema_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/schema_service/client.py @@ -115,8 +115,8 @@ def get_transport_class( class SchemaServiceClient(metaclass=SchemaServiceClientMeta): - """Service for managing - [Schema][google.cloud.discoveryengine.v1.Schema]s. + """Service for managing `Schema + `__s. """ @staticmethod @@ -752,7 +752,8 @@ def get_schema( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> schema.Schema: - r"""Gets a [Schema][google.cloud.discoveryengine.v1.Schema]. + r"""Gets a `Schema + `__. .. code-block:: python @@ -783,11 +784,12 @@ def sample_get_schema(): Args: request (Union[google.cloud.discoveryengine_v1.types.GetSchemaRequest, dict]): The request object. Request message for - [SchemaService.GetSchema][google.cloud.discoveryengine.v1.SchemaService.GetSchema] + `SchemaService.GetSchema + `__ method. name (str): - Required. The full resource name of the schema, in the - format of + Required. The full resource name of the + schema, in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}``. This corresponds to the ``name`` field @@ -862,8 +864,8 @@ def list_schemas( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListSchemasPager: - r"""Gets a list of - [Schema][google.cloud.discoveryengine.v1.Schema]s. + r"""Gets a list of `Schema + `__s. .. code-block:: python @@ -895,11 +897,12 @@ def sample_list_schemas(): Args: request (Union[google.cloud.discoveryengine_v1.types.ListSchemasRequest, dict]): The request object. Request message for - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1.SchemaService.ListSchemas] + `SchemaService.ListSchemas + `__ method. parent (str): - Required. The parent data store resource name, in the - format of + Required. The parent data store resource + name, in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}``. This corresponds to the ``parent`` field @@ -916,11 +919,13 @@ def sample_list_schemas(): Returns: google.cloud.discoveryengine_v1.services.schema_service.pagers.ListSchemasPager: Response message for - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1.SchemaService.ListSchemas] - method. + `SchemaService.ListSchemas + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -991,7 +996,8 @@ def create_schema( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Creates a [Schema][google.cloud.discoveryengine.v1.Schema]. + r"""Creates a `Schema + `__. .. code-block:: python @@ -1027,33 +1033,38 @@ def sample_create_schema(): Args: request (Union[google.cloud.discoveryengine_v1.types.CreateSchemaRequest, dict]): The request object. Request message for - [SchemaService.CreateSchema][google.cloud.discoveryengine.v1.SchemaService.CreateSchema] + `SchemaService.CreateSchema + `__ method. parent (str): - Required. The parent data store resource name, in the - format of + Required. The parent data store resource + name, in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. schema (google.cloud.discoveryengine_v1.types.Schema): - Required. The - [Schema][google.cloud.discoveryengine.v1.Schema] to - create. + Required. The `Schema + `__ + to create. This corresponds to the ``schema`` field on the ``request`` instance; if ``request`` is provided, this should not be set. schema_id (str): Required. The ID to use for the - [Schema][google.cloud.discoveryengine.v1.Schema], which - becomes the final component of the - [Schema.name][google.cloud.discoveryengine.v1.Schema.name]. + `Schema + `__, + which becomes the final component of the + `Schema.name + `__. This field should conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. + `RFC-1034 + `__ + standard with a length limit of 63 + characters. This corresponds to the ``schema_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -1068,12 +1079,13 @@ def sample_create_schema(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1.types.Schema` - Defines the structure and layout of a type of document - data. + Defines the structure and layout of a + type of document data. """ # Create or coerce a protobuf request object. @@ -1142,7 +1154,8 @@ def update_schema( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Updates a [Schema][google.cloud.discoveryengine.v1.Schema]. + r"""Updates a `Schema + `__. .. code-block:: python @@ -1176,7 +1189,8 @@ def sample_update_schema(): Args: request (Union[google.cloud.discoveryengine_v1.types.UpdateSchemaRequest, dict]): The request object. Request message for - [SchemaService.UpdateSchema][google.cloud.discoveryengine.v1.SchemaService.UpdateSchema] + `SchemaService.UpdateSchema + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1188,12 +1202,13 @@ def sample_update_schema(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1.types.Schema` - Defines the structure and layout of a type of document - data. + Defines the structure and layout of a + type of document data. """ # Create or coerce a protobuf request object. @@ -1245,7 +1260,8 @@ def delete_schema( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Deletes a [Schema][google.cloud.discoveryengine.v1.Schema]. + r"""Deletes a `Schema + `__. .. code-block:: python @@ -1280,11 +1296,12 @@ def sample_delete_schema(): Args: request (Union[google.cloud.discoveryengine_v1.types.DeleteSchemaRequest, dict]): The request object. Request message for - [SchemaService.DeleteSchema][google.cloud.discoveryengine.v1.SchemaService.DeleteSchema] + `SchemaService.DeleteSchema + `__ method. name (str): - Required. The full resource name of the schema, in the - format of + Required. The full resource name of the + schema, in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}``. This corresponds to the ``name`` field @@ -1300,18 +1317,21 @@ def sample_delete_schema(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/schema_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/schema_service/transports/grpc.py index ff6e12c5ed53..b6eadaf0e17c 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/schema_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/schema_service/transports/grpc.py @@ -112,8 +112,8 @@ def intercept_unary_unary(self, continuation, client_call_details, request): class SchemaServiceGrpcTransport(SchemaServiceTransport): """gRPC backend transport for SchemaService. - Service for managing - [Schema][google.cloud.discoveryengine.v1.Schema]s. + Service for managing `Schema + `__s. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -345,7 +345,8 @@ def operations_client(self) -> operations_v1.OperationsClient: def get_schema(self) -> Callable[[schema_service.GetSchemaRequest], schema.Schema]: r"""Return a callable for the get schema method over gRPC. - Gets a [Schema][google.cloud.discoveryengine.v1.Schema]. + Gets a `Schema + `__. Returns: Callable[[~.GetSchemaRequest], @@ -373,8 +374,8 @@ def list_schemas( ]: r"""Return a callable for the list schemas method over gRPC. - Gets a list of - [Schema][google.cloud.discoveryengine.v1.Schema]s. + Gets a list of `Schema + `__s. Returns: Callable[[~.ListSchemasRequest], @@ -400,7 +401,8 @@ def create_schema( ) -> Callable[[schema_service.CreateSchemaRequest], operations_pb2.Operation]: r"""Return a callable for the create schema method over gRPC. - Creates a [Schema][google.cloud.discoveryengine.v1.Schema]. + Creates a `Schema + `__. Returns: Callable[[~.CreateSchemaRequest], @@ -426,7 +428,8 @@ def update_schema( ) -> Callable[[schema_service.UpdateSchemaRequest], operations_pb2.Operation]: r"""Return a callable for the update schema method over gRPC. - Updates a [Schema][google.cloud.discoveryengine.v1.Schema]. + Updates a `Schema + `__. Returns: Callable[[~.UpdateSchemaRequest], @@ -452,7 +455,8 @@ def delete_schema( ) -> Callable[[schema_service.DeleteSchemaRequest], operations_pb2.Operation]: r"""Return a callable for the delete schema method over gRPC. - Deletes a [Schema][google.cloud.discoveryengine.v1.Schema]. + Deletes a `Schema + `__. Returns: Callable[[~.DeleteSchemaRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/schema_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/schema_service/transports/grpc_asyncio.py index 86e834072ee1..422c522fad2b 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/schema_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/schema_service/transports/grpc_asyncio.py @@ -118,8 +118,8 @@ async def intercept_unary_unary(self, continuation, client_call_details, request class SchemaServiceGrpcAsyncIOTransport(SchemaServiceTransport): """gRPC AsyncIO backend transport for SchemaService. - Service for managing - [Schema][google.cloud.discoveryengine.v1.Schema]s. + Service for managing `Schema + `__s. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -355,7 +355,8 @@ def get_schema( ) -> Callable[[schema_service.GetSchemaRequest], Awaitable[schema.Schema]]: r"""Return a callable for the get schema method over gRPC. - Gets a [Schema][google.cloud.discoveryengine.v1.Schema]. + Gets a `Schema + `__. Returns: Callable[[~.GetSchemaRequest], @@ -384,8 +385,8 @@ def list_schemas( ]: r"""Return a callable for the list schemas method over gRPC. - Gets a list of - [Schema][google.cloud.discoveryengine.v1.Schema]s. + Gets a list of `Schema + `__s. Returns: Callable[[~.ListSchemasRequest], @@ -413,7 +414,8 @@ def create_schema( ]: r"""Return a callable for the create schema method over gRPC. - Creates a [Schema][google.cloud.discoveryengine.v1.Schema]. + Creates a `Schema + `__. Returns: Callable[[~.CreateSchemaRequest], @@ -441,7 +443,8 @@ def update_schema( ]: r"""Return a callable for the update schema method over gRPC. - Updates a [Schema][google.cloud.discoveryengine.v1.Schema]. + Updates a `Schema + `__. Returns: Callable[[~.UpdateSchemaRequest], @@ -469,7 +472,8 @@ def delete_schema( ]: r"""Return a callable for the delete schema method over gRPC. - Deletes a [Schema][google.cloud.discoveryengine.v1.Schema]. + Deletes a `Schema + `__. Returns: Callable[[~.DeleteSchemaRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/schema_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/schema_service/transports/rest.py index 55873e594a9c..4b0a63e60152 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/schema_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/schema_service/transports/rest.py @@ -442,8 +442,8 @@ class SchemaServiceRestStub: class SchemaServiceRestTransport(_BaseSchemaServiceRestTransport): """REST backend synchronous transport for SchemaService. - Service for managing - [Schema][google.cloud.discoveryengine.v1.Schema]s. + Service for managing `Schema + `__s. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -745,7 +745,8 @@ def __call__( Args: request (~.schema_service.CreateSchemaRequest): The request object. Request message for - [SchemaService.CreateSchema][google.cloud.discoveryengine.v1.SchemaService.CreateSchema] + `SchemaService.CreateSchema + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -897,7 +898,8 @@ def __call__( Args: request (~.schema_service.DeleteSchemaRequest): The request object. Request message for - [SchemaService.DeleteSchema][google.cloud.discoveryengine.v1.SchemaService.DeleteSchema] + `SchemaService.DeleteSchema + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1044,7 +1046,8 @@ def __call__( Args: request (~.schema_service.GetSchemaRequest): The request object. Request message for - [SchemaService.GetSchema][google.cloud.discoveryengine.v1.SchemaService.GetSchema] + `SchemaService.GetSchema + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1196,7 +1199,8 @@ def __call__( Args: request (~.schema_service.ListSchemasRequest): The request object. Request message for - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1.SchemaService.ListSchemas] + `SchemaService.ListSchemas + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1209,7 +1213,8 @@ def __call__( Returns: ~.schema_service.ListSchemasResponse: Response message for - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1.SchemaService.ListSchemas] + `SchemaService.ListSchemas + `__ method. """ @@ -1350,7 +1355,8 @@ def __call__( Args: request (~.schema_service.UpdateSchemaRequest): The request object. Request message for - [SchemaService.UpdateSchema][google.cloud.discoveryengine.v1.SchemaService.UpdateSchema] + `SchemaService.UpdateSchema + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_service/async_client.py index 29a56caccd71..6ddb2179bd8e 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_service/async_client.py @@ -342,7 +342,8 @@ async def sample_search(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.SearchRequest, dict]]): The request object. Request message for - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] + `SearchService.Search + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -355,11 +356,13 @@ async def sample_search(): Returns: google.cloud.discoveryengine_v1.services.search_service.pagers.SearchAsyncPager: Response message for - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] - method. + `SearchService.Search + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -414,20 +417,23 @@ async def search_lite( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.SearchLiteAsyncPager: r"""Performs a search. Similar to the - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] + `SearchService.Search + `__ method, but a lite version that allows API key for - authentication, where OAuth and IAM checks are not required. + authentication, where OAuth and IAM checks are not + required. - Only public website search is supported by this method. If data - stores and engines not associated with public website search are - specified, a ``FAILED_PRECONDITION`` error is returned. + Only public website search is supported by this method. + If data stores and engines not associated with public + website search are specified, a ``FAILED_PRECONDITION`` + error is returned. - This method can be used for easy onboarding without having to - implement an authentication backend. However, it is strongly - recommended to use - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] - instead with required OAuth and IAM checks to provide better - data security. + This method can be used for easy onboarding without + having to implement an authentication backend. However, + it is strongly recommended to use `SearchService.Search + `__ + instead with required OAuth and IAM checks to provide + better data security. .. code-block:: python @@ -459,7 +465,8 @@ async def sample_search_lite(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.SearchRequest, dict]]): The request object. Request message for - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] + `SearchService.Search + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -472,11 +479,13 @@ async def sample_search_lite(): Returns: google.cloud.discoveryengine_v1.services.search_service.pagers.SearchLiteAsyncPager: Response message for - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] - method. + `SearchService.Search + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_service/client.py index cbdc72272d57..717a1af60fbd 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_service/client.py @@ -877,7 +877,8 @@ def sample_search(): Args: request (Union[google.cloud.discoveryengine_v1.types.SearchRequest, dict]): The request object. Request message for - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] + `SearchService.Search + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -890,11 +891,13 @@ def sample_search(): Returns: google.cloud.discoveryengine_v1.services.search_service.pagers.SearchPager: Response message for - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] - method. + `SearchService.Search + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -949,20 +952,23 @@ def search_lite( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.SearchLitePager: r"""Performs a search. Similar to the - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] + `SearchService.Search + `__ method, but a lite version that allows API key for - authentication, where OAuth and IAM checks are not required. + authentication, where OAuth and IAM checks are not + required. - Only public website search is supported by this method. If data - stores and engines not associated with public website search are - specified, a ``FAILED_PRECONDITION`` error is returned. + Only public website search is supported by this method. + If data stores and engines not associated with public + website search are specified, a ``FAILED_PRECONDITION`` + error is returned. - This method can be used for easy onboarding without having to - implement an authentication backend. However, it is strongly - recommended to use - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] - instead with required OAuth and IAM checks to provide better - data security. + This method can be used for easy onboarding without + having to implement an authentication backend. However, + it is strongly recommended to use `SearchService.Search + `__ + instead with required OAuth and IAM checks to provide + better data security. .. code-block:: python @@ -994,7 +1000,8 @@ def sample_search_lite(): Args: request (Union[google.cloud.discoveryengine_v1.types.SearchRequest, dict]): The request object. Request message for - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] + `SearchService.Search + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1007,11 +1014,13 @@ def sample_search_lite(): Returns: google.cloud.discoveryengine_v1.services.search_service.pagers.SearchLitePager: Response message for - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] - method. + `SearchService.Search + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_service/transports/grpc.py index 75d3d2e6b966..2a4e6b18e27b 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_service/transports/grpc.py @@ -356,20 +356,23 @@ def search_lite( r"""Return a callable for the search lite method over gRPC. Performs a search. Similar to the - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] + `SearchService.Search + `__ method, but a lite version that allows API key for - authentication, where OAuth and IAM checks are not required. - - Only public website search is supported by this method. If data - stores and engines not associated with public website search are - specified, a ``FAILED_PRECONDITION`` error is returned. - - This method can be used for easy onboarding without having to - implement an authentication backend. However, it is strongly - recommended to use - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] - instead with required OAuth and IAM checks to provide better - data security. + authentication, where OAuth and IAM checks are not + required. + + Only public website search is supported by this method. + If data stores and engines not associated with public + website search are specified, a ``FAILED_PRECONDITION`` + error is returned. + + This method can be used for easy onboarding without + having to implement an authentication backend. However, + it is strongly recommended to use `SearchService.Search + `__ + instead with required OAuth and IAM checks to provide + better data security. Returns: Callable[[~.SearchRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_service/transports/grpc_asyncio.py index ce258458a3c8..f7a213afea4c 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_service/transports/grpc_asyncio.py @@ -368,20 +368,23 @@ def search_lite( r"""Return a callable for the search lite method over gRPC. Performs a search. Similar to the - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] + `SearchService.Search + `__ method, but a lite version that allows API key for - authentication, where OAuth and IAM checks are not required. - - Only public website search is supported by this method. If data - stores and engines not associated with public website search are - specified, a ``FAILED_PRECONDITION`` error is returned. - - This method can be used for easy onboarding without having to - implement an authentication backend. However, it is strongly - recommended to use - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] - instead with required OAuth and IAM checks to provide better - data security. + authentication, where OAuth and IAM checks are not + required. + + Only public website search is supported by this method. + If data stores and engines not associated with public + website search are specified, a ``FAILED_PRECONDITION`` + error is returned. + + This method can be used for easy onboarding without + having to implement an authentication backend. However, + it is strongly recommended to use `SearchService.Search + `__ + instead with required OAuth and IAM checks to provide + better data security. Returns: Callable[[~.SearchRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_service/transports/rest.py index 202f27b30213..f88926cdf91d 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_service/transports/rest.py @@ -389,7 +389,8 @@ def __call__( Args: request (~.search_service.SearchRequest): The request object. Request message for - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] + `SearchService.Search + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -402,7 +403,8 @@ def __call__( Returns: ~.search_service.SearchResponse: Response message for - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] + `SearchService.Search + `__ method. """ @@ -548,7 +550,8 @@ def __call__( Args: request (~.search_service.SearchRequest): The request object. Request message for - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] + `SearchService.Search + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -561,7 +564,8 @@ def __call__( Returns: ~.search_service.SearchResponse: Response message for - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] + `SearchService.Search + `__ method. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_tuning_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_tuning_service/async_client.py index b1641981be86..7184bdcd477b 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_tuning_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_tuning_service/async_client.py @@ -351,7 +351,8 @@ async def sample_train_custom_model(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.TrainCustomModelRequest, dict]]): The request object. Request message for - [SearchTuningService.TrainCustomModel][google.cloud.discoveryengine.v1.SearchTuningService.TrainCustomModel] + `SearchTuningService.TrainCustomModel + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -363,12 +364,16 @@ async def sample_train_custom_model(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.TrainCustomModelResponse` Response of the - [TrainCustomModelRequest][google.cloud.discoveryengine.v1.TrainCustomModelRequest]. - This message is returned by the - google.longrunning.Operations.response field. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.TrainCustomModelResponse` + Response of the `TrainCustomModelRequest + `__. + This message is returned by the + google.longrunning.Operations.response + field. """ # Create or coerce a protobuf request object. @@ -454,7 +459,8 @@ async def sample_list_custom_models(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.ListCustomModelsRequest, dict]]): The request object. Request message for - [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1.SearchTuningService.ListCustomModels] + `SearchTuningService.ListCustomModels + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -467,8 +473,9 @@ async def sample_list_custom_models(): Returns: google.cloud.discoveryengine_v1.types.ListCustomModelsResponse: Response message for - [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1.SearchTuningService.ListCustomModels] - method. + `SearchTuningService.ListCustomModels + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_tuning_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_tuning_service/client.py index caa806592de5..229a041aecf8 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_tuning_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_tuning_service/client.py @@ -791,7 +791,8 @@ def sample_train_custom_model(): Args: request (Union[google.cloud.discoveryengine_v1.types.TrainCustomModelRequest, dict]): The request object. Request message for - [SearchTuningService.TrainCustomModel][google.cloud.discoveryengine.v1.SearchTuningService.TrainCustomModel] + `SearchTuningService.TrainCustomModel + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -803,12 +804,16 @@ def sample_train_custom_model(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.TrainCustomModelResponse` Response of the - [TrainCustomModelRequest][google.cloud.discoveryengine.v1.TrainCustomModelRequest]. - This message is returned by the - google.longrunning.Operations.response field. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.TrainCustomModelResponse` + Response of the `TrainCustomModelRequest + `__. + This message is returned by the + google.longrunning.Operations.response + field. """ # Create or coerce a protobuf request object. @@ -892,7 +897,8 @@ def sample_list_custom_models(): Args: request (Union[google.cloud.discoveryengine_v1.types.ListCustomModelsRequest, dict]): The request object. Request message for - [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1.SearchTuningService.ListCustomModels] + `SearchTuningService.ListCustomModels + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -905,8 +911,9 @@ def sample_list_custom_models(): Returns: google.cloud.discoveryengine_v1.types.ListCustomModelsResponse: Response message for - [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1.SearchTuningService.ListCustomModels] - method. + `SearchTuningService.ListCustomModels + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_tuning_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_tuning_service/transports/rest.py index 381276207316..aecbfd05de01 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_tuning_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/search_tuning_service/transports/rest.py @@ -583,7 +583,8 @@ def __call__( Args: request (~.search_tuning_service.ListCustomModelsRequest): The request object. Request message for - [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1.SearchTuningService.ListCustomModels] + `SearchTuningService.ListCustomModels + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -596,7 +597,8 @@ def __call__( Returns: ~.search_tuning_service.ListCustomModelsResponse: Response message for - [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1.SearchTuningService.ListCustomModels] + `SearchTuningService.ListCustomModels + `__ method. """ @@ -738,7 +740,8 @@ def __call__( Args: request (~.search_tuning_service.TrainCustomModelRequest): The request object. Request message for - [SearchTuningService.TrainCustomModel][google.cloud.discoveryengine.v1.SearchTuningService.TrainCustomModel] + `SearchTuningService.TrainCustomModel + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/serving_config_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/serving_config_service/async_client.py index 3ae0776e9c27..275b669d1d25 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/serving_config_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/serving_config_service/async_client.py @@ -69,7 +69,8 @@ class ServingConfigServiceAsyncClient: """Service for operations related to - [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig]. + `ServingConfig + `__. """ _client: ServingConfigServiceClient @@ -315,7 +316,8 @@ async def update_serving_config( ) -> gcd_serving_config.ServingConfig: r"""Updates a ServingConfig. - Returns a NOT_FOUND error if the ServingConfig does not exist. + Returns a NOT_FOUND error if the ServingConfig does not + exist. .. code-block:: python @@ -361,12 +363,16 @@ async def sample_update_serving_config(): should not be set. update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): Indicates which fields in the provided - [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] - to update. The following are NOT supported: + `ServingConfig + `__ + to update. The following are NOT + supported: - - [ServingConfig.name][google.cloud.discoveryengine.v1.ServingConfig.name] + * `ServingConfig.name + `__ - If not set, all supported fields are updated. + If not set, all supported fields are + updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/serving_config_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/serving_config_service/client.py index 3d7b8bf969b2..b1dbaf215421 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/serving_config_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/serving_config_service/client.py @@ -115,7 +115,8 @@ def get_transport_class( class ServingConfigServiceClient(metaclass=ServingConfigServiceClientMeta): """Service for operations related to - [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig]. + `ServingConfig + `__. """ @staticmethod @@ -739,7 +740,8 @@ def update_serving_config( ) -> gcd_serving_config.ServingConfig: r"""Updates a ServingConfig. - Returns a NOT_FOUND error if the ServingConfig does not exist. + Returns a NOT_FOUND error if the ServingConfig does not + exist. .. code-block:: python @@ -785,12 +787,16 @@ def sample_update_serving_config(): should not be set. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] - to update. The following are NOT supported: + `ServingConfig + `__ + to update. The following are NOT + supported: - - [ServingConfig.name][google.cloud.discoveryengine.v1.ServingConfig.name] + * `ServingConfig.name + `__ - If not set, all supported fields are updated. + If not set, all supported fields are + updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/serving_config_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/serving_config_service/transports/grpc.py index d1c6a2fa0b24..9a5af472b255 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/serving_config_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/serving_config_service/transports/grpc.py @@ -114,7 +114,8 @@ class ServingConfigServiceGrpcTransport(ServingConfigServiceTransport): """gRPC backend transport for ServingConfigService. Service for operations related to - [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig]. + `ServingConfig + `__. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -336,7 +337,8 @@ def update_serving_config( Updates a ServingConfig. - Returns a NOT_FOUND error if the ServingConfig does not exist. + Returns a NOT_FOUND error if the ServingConfig does not + exist. Returns: Callable[[~.UpdateServingConfigRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/serving_config_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/serving_config_service/transports/grpc_asyncio.py index a4f8d822aa90..894d6c5845c2 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/serving_config_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/serving_config_service/transports/grpc_asyncio.py @@ -120,7 +120,8 @@ class ServingConfigServiceGrpcAsyncIOTransport(ServingConfigServiceTransport): """gRPC AsyncIO backend transport for ServingConfigService. Service for operations related to - [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig]. + `ServingConfig + `__. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -344,7 +345,8 @@ def update_serving_config( Updates a ServingConfig. - Returns a NOT_FOUND error if the ServingConfig does not exist. + Returns a NOT_FOUND error if the ServingConfig does not + exist. Returns: Callable[[~.UpdateServingConfigRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/serving_config_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/serving_config_service/transports/rest.py index 308ca01f41d5..afc549887f06 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/serving_config_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/serving_config_service/transports/rest.py @@ -225,7 +225,8 @@ class ServingConfigServiceRestTransport(_BaseServingConfigServiceRestTransport): """REST backend synchronous transport for ServingConfigService. Service for operations related to - [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig]. + `ServingConfig + `__. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/session_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/session_service/async_client.py index b347e794ea27..b83418a35fe8 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/session_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/session_service/async_client.py @@ -320,8 +320,9 @@ async def create_session( ) -> gcd_session.Session: r"""Creates a Session. - If the [Session][google.cloud.discoveryengine.v1.Session] to - create already exists, an ALREADY_EXISTS error is returned. + If the `Session + `__ to create + already exists, an ALREADY_EXISTS error is returned. .. code-block:: python @@ -353,8 +354,8 @@ async def sample_create_session(): request (Optional[Union[google.cloud.discoveryengine_v1.types.CreateSessionRequest, dict]]): The request object. Request for CreateSession method. parent (:class:`str`): - Required. Full resource name of parent data store. - Format: + Required. Full resource name of parent + data store. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field @@ -441,8 +442,9 @@ async def delete_session( ) -> None: r"""Deletes a Session. - If the [Session][google.cloud.discoveryengine.v1.Session] to - delete does not exist, a NOT_FOUND error is returned. + If the `Session + `__ to delete + does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -471,8 +473,8 @@ async def sample_delete_session(): request (Optional[Union[google.cloud.discoveryengine_v1.types.DeleteSessionRequest, dict]]): The request object. Request for DeleteSession method. name (:class:`str`): - Required. The resource name of the Session to delete. - Format: + Required. The resource name of the + Session to delete. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` This corresponds to the ``name`` field @@ -546,9 +548,9 @@ async def update_session( ) -> gcd_session.Session: r"""Updates a Session. - [Session][google.cloud.discoveryengine.v1.Session] action type - cannot be changed. If the - [Session][google.cloud.discoveryengine.v1.Session] to update + `Session `__ + action type cannot be changed. If the `Session + `__ to update does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -586,12 +588,16 @@ async def sample_update_session(): should not be set. update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): Indicates which fields in the provided - [Session][google.cloud.discoveryengine.v1.Session] to - update. The following are NOT supported: + `Session + `__ + to update. The following are NOT + supported: - - [Session.name][google.cloud.discoveryengine.v1.Session.name] + * `Session.name + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported + fields are updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -704,8 +710,8 @@ async def sample_get_session(): request (Optional[Union[google.cloud.discoveryengine_v1.types.GetSessionRequest, dict]]): The request object. Request for GetSession method. name (:class:`str`): - Required. The resource name of the Session to get. - Format: + Required. The resource name of the + Session to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` This corresponds to the ``name`` field @@ -784,7 +790,8 @@ async def list_sessions( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListSessionsAsyncPager: r"""Lists all Sessions by their parent - [DataStore][google.cloud.discoveryengine.v1.DataStore]. + `DataStore + `__. .. code-block:: python @@ -817,7 +824,8 @@ async def sample_list_sessions(): request (Optional[Union[google.cloud.discoveryengine_v1.types.ListSessionsRequest, dict]]): The request object. Request for ListSessions method. parent (:class:`str`): - Required. The data store resource name. Format: + Required. The data store resource name. + Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/session_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/session_service/client.py index c1e4e7041229..34f6286e4cc5 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/session_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/session_service/client.py @@ -863,8 +863,9 @@ def create_session( ) -> gcd_session.Session: r"""Creates a Session. - If the [Session][google.cloud.discoveryengine.v1.Session] to - create already exists, an ALREADY_EXISTS error is returned. + If the `Session + `__ to create + already exists, an ALREADY_EXISTS error is returned. .. code-block:: python @@ -896,8 +897,8 @@ def sample_create_session(): request (Union[google.cloud.discoveryengine_v1.types.CreateSessionRequest, dict]): The request object. Request for CreateSession method. parent (str): - Required. Full resource name of parent data store. - Format: + Required. Full resource name of parent + data store. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field @@ -981,8 +982,9 @@ def delete_session( ) -> None: r"""Deletes a Session. - If the [Session][google.cloud.discoveryengine.v1.Session] to - delete does not exist, a NOT_FOUND error is returned. + If the `Session + `__ to delete + does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -1011,8 +1013,8 @@ def sample_delete_session(): request (Union[google.cloud.discoveryengine_v1.types.DeleteSessionRequest, dict]): The request object. Request for DeleteSession method. name (str): - Required. The resource name of the Session to delete. - Format: + Required. The resource name of the + Session to delete. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` This corresponds to the ``name`` field @@ -1083,9 +1085,9 @@ def update_session( ) -> gcd_session.Session: r"""Updates a Session. - [Session][google.cloud.discoveryengine.v1.Session] action type - cannot be changed. If the - [Session][google.cloud.discoveryengine.v1.Session] to update + `Session `__ + action type cannot be changed. If the `Session + `__ to update does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -1123,12 +1125,16 @@ def sample_update_session(): should not be set. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [Session][google.cloud.discoveryengine.v1.Session] to - update. The following are NOT supported: + `Session + `__ + to update. The following are NOT + supported: - - [Session.name][google.cloud.discoveryengine.v1.Session.name] + * `Session.name + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported + fields are updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -1238,8 +1244,8 @@ def sample_get_session(): request (Union[google.cloud.discoveryengine_v1.types.GetSessionRequest, dict]): The request object. Request for GetSession method. name (str): - Required. The resource name of the Session to get. - Format: + Required. The resource name of the + Session to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` This corresponds to the ``name`` field @@ -1315,7 +1321,8 @@ def list_sessions( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListSessionsPager: r"""Lists all Sessions by their parent - [DataStore][google.cloud.discoveryengine.v1.DataStore]. + `DataStore + `__. .. code-block:: python @@ -1348,7 +1355,8 @@ def sample_list_sessions(): request (Union[google.cloud.discoveryengine_v1.types.ListSessionsRequest, dict]): The request object. Request for ListSessions method. parent (str): - Required. The data store resource name. Format: + Required. The data store resource name. + Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/session_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/session_service/transports/grpc.py index 8b0fc2b575ea..442fc6f9bf18 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/session_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/session_service/transports/grpc.py @@ -336,8 +336,9 @@ def create_session( Creates a Session. - If the [Session][google.cloud.discoveryengine.v1.Session] to - create already exists, an ALREADY_EXISTS error is returned. + If the `Session + `__ to create + already exists, an ALREADY_EXISTS error is returned. Returns: Callable[[~.CreateSessionRequest], @@ -367,8 +368,9 @@ def delete_session( Deletes a Session. - If the [Session][google.cloud.discoveryengine.v1.Session] to - delete does not exist, a NOT_FOUND error is returned. + If the `Session + `__ to delete + does not exist, a NOT_FOUND error is returned. Returns: Callable[[~.DeleteSessionRequest], @@ -398,9 +400,9 @@ def update_session( Updates a Session. - [Session][google.cloud.discoveryengine.v1.Session] action type - cannot be changed. If the - [Session][google.cloud.discoveryengine.v1.Session] to update + `Session `__ + action type cannot be changed. If the `Session + `__ to update does not exist, a NOT_FOUND error is returned. Returns: @@ -457,7 +459,8 @@ def list_sessions( r"""Return a callable for the list sessions method over gRPC. Lists all Sessions by their parent - [DataStore][google.cloud.discoveryengine.v1.DataStore]. + `DataStore + `__. Returns: Callable[[~.ListSessionsRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/session_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/session_service/transports/grpc_asyncio.py index b25a483d8ec6..805573400289 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/session_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/session_service/transports/grpc_asyncio.py @@ -345,8 +345,9 @@ def create_session( Creates a Session. - If the [Session][google.cloud.discoveryengine.v1.Session] to - create already exists, an ALREADY_EXISTS error is returned. + If the `Session + `__ to create + already exists, an ALREADY_EXISTS error is returned. Returns: Callable[[~.CreateSessionRequest], @@ -376,8 +377,9 @@ def delete_session( Deletes a Session. - If the [Session][google.cloud.discoveryengine.v1.Session] to - delete does not exist, a NOT_FOUND error is returned. + If the `Session + `__ to delete + does not exist, a NOT_FOUND error is returned. Returns: Callable[[~.DeleteSessionRequest], @@ -408,9 +410,9 @@ def update_session( Updates a Session. - [Session][google.cloud.discoveryengine.v1.Session] action type - cannot be changed. If the - [Session][google.cloud.discoveryengine.v1.Session] to update + `Session `__ + action type cannot be changed. If the `Session + `__ to update does not exist, a NOT_FOUND error is returned. Returns: @@ -469,7 +471,8 @@ def list_sessions( r"""Return a callable for the list sessions method over gRPC. Lists all Sessions by their parent - [DataStore][google.cloud.discoveryengine.v1.DataStore]. + `DataStore + `__. Returns: Callable[[~.ListSessionsRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/site_search_engine_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/site_search_engine_service/async_client.py index 1dd928221c4d..de51e00ff7c2 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/site_search_engine_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/site_search_engine_service/async_client.py @@ -329,7 +329,8 @@ async def get_site_search_engine( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> site_search_engine.SiteSearchEngine: r"""Gets the - [SiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngine]. + `SiteSearchEngine + `__. .. code-block:: python @@ -360,17 +361,20 @@ async def sample_get_site_search_engine(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.GetSiteSearchEngineRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.GetSiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngineService.GetSiteSearchEngine] + `SiteSearchEngineService.GetSiteSearchEngine + `__ method. name (:class:`str`): Required. Resource name of - [SiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. - If the caller does not have permission to access the - [SiteSearchEngine], regardless of whether or not it - exists, a PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the [SiteSearchEngine], + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -454,8 +458,8 @@ async def create_target_site( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Creates a - [TargetSite][google.cloud.discoveryengine.v1.TargetSite]. + r"""Creates a `TargetSite + `__. .. code-block:: python @@ -494,11 +498,13 @@ async def sample_create_target_site(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.CreateTargetSiteRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.CreateTargetSite] + `SiteSearchEngineService.CreateTargetSite + `__ method. parent (:class:`str`): Required. Parent resource name of - [TargetSite][google.cloud.discoveryengine.v1.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. @@ -506,8 +512,8 @@ async def sample_create_target_site(): on the ``request`` instance; if ``request`` is provided, this should not be set. target_site (:class:`google.cloud.discoveryengine_v1.types.TargetSite`): - Required. The - [TargetSite][google.cloud.discoveryengine.v1.TargetSite] + Required. The `TargetSite + `__ to create. This corresponds to the ``target_site`` field @@ -523,9 +529,10 @@ async def sample_create_target_site(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1.types.TargetSite` A target site for the SiteSearchEngine. @@ -599,8 +606,9 @@ async def batch_create_target_sites( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Creates [TargetSite][google.cloud.discoveryengine.v1.TargetSite] - in a batch. + r"""Creates `TargetSite + `__ in a + batch. .. code-block:: python @@ -640,7 +648,8 @@ async def sample_batch_create_target_sites(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.BatchCreateTargetSitesRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchCreateTargetSites] + `SiteSearchEngineService.BatchCreateTargetSites + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -652,11 +661,15 @@ async def sample_batch_create_target_sites(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.BatchCreateTargetSitesResponse` Response message for - [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchCreateTargetSites] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.BatchCreateTargetSitesResponse` + Response message for + `SiteSearchEngineService.BatchCreateTargetSites + `__ + method. """ # Create or coerce a protobuf request object. @@ -712,7 +725,8 @@ async def get_target_site( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> site_search_engine.TargetSite: - r"""Gets a [TargetSite][google.cloud.discoveryengine.v1.TargetSite]. + r"""Gets a `TargetSite + `__. .. code-block:: python @@ -743,22 +757,26 @@ async def sample_get_target_site(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.GetTargetSiteRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.GetTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.GetTargetSite] + `SiteSearchEngineService.GetTargetSite + `__ method. name (:class:`str`): Required. Full resource name of - [TargetSite][google.cloud.discoveryengine.v1.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}``. - If the caller does not have permission to access the - [TargetSite][google.cloud.discoveryengine.v1.TargetSite], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `TargetSite + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the requested - [TargetSite][google.cloud.discoveryengine.v1.TargetSite] - does not exist, a NOT_FOUND error is returned. + If the requested `TargetSite + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -837,8 +855,8 @@ async def update_target_site( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Updates a - [TargetSite][google.cloud.discoveryengine.v1.TargetSite]. + r"""Updates a `TargetSite + `__. .. code-block:: python @@ -876,18 +894,21 @@ async def sample_update_target_site(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.UpdateTargetSiteRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.UpdateTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.UpdateTargetSite] + `SiteSearchEngineService.UpdateTargetSite + `__ method. target_site (:class:`google.cloud.discoveryengine_v1.types.TargetSite`): - Required. The target site to update. If the caller does - not have permission to update the - [TargetSite][google.cloud.discoveryengine.v1.TargetSite], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. - - If the - [TargetSite][google.cloud.discoveryengine.v1.TargetSite] - to update does not exist, a NOT_FOUND error is returned. + Required. The target site to update. + If the caller does not have permission + to update the `TargetSite + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. + + If the `TargetSite + `__ + to update does not exist, a NOT_FOUND + error is returned. This corresponds to the ``target_site`` field on the ``request`` instance; if ``request`` is provided, this @@ -902,9 +923,10 @@ async def sample_update_target_site(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1.types.TargetSite` A target site for the SiteSearchEngine. @@ -979,8 +1001,8 @@ async def delete_target_site( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Deletes a - [TargetSite][google.cloud.discoveryengine.v1.TargetSite]. + r"""Deletes a `TargetSite + `__. .. code-block:: python @@ -1015,22 +1037,26 @@ async def sample_delete_target_site(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.DeleteTargetSiteRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.DeleteTargetSite] + `SiteSearchEngineService.DeleteTargetSite + `__ method. name (:class:`str`): Required. Full resource name of - [TargetSite][google.cloud.discoveryengine.v1.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}``. - If the caller does not have permission to access the - [TargetSite][google.cloud.discoveryengine.v1.TargetSite], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `TargetSite + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the requested - [TargetSite][google.cloud.discoveryengine.v1.TargetSite] - does not exist, a NOT_FOUND error is returned. + If the requested `TargetSite + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -1045,18 +1071,21 @@ async def sample_delete_target_site(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. @@ -1127,8 +1156,8 @@ async def list_target_sites( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListTargetSitesAsyncPager: - r"""Gets a list of - [TargetSite][google.cloud.discoveryengine.v1.TargetSite]s. + r"""Gets a list of `TargetSite + `__s. .. code-block:: python @@ -1160,17 +1189,20 @@ async def sample_list_target_sites(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.ListTargetSitesRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.ListTargetSites] + `SiteSearchEngineService.ListTargetSites + `__ method. parent (:class:`str`): - Required. The parent site search engine resource name, - such as + Required. The parent site search engine + resource name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. - If the caller does not have permission to list - [TargetSite][google.cloud.discoveryengine.v1.TargetSite]s - under this site search engine, regardless of whether or - not this branch exists, a PERMISSION_DENIED error is + If the caller does not have permission + to list `TargetSite + `__s + under this site search engine, + regardless of whether or not this branch + exists, a PERMISSION_DENIED error is returned. This corresponds to the ``parent`` field @@ -1187,11 +1219,13 @@ async def sample_list_target_sites(): Returns: google.cloud.discoveryengine_v1.services.site_search_engine_service.pagers.ListTargetSitesAsyncPager: Response message for - [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.ListTargetSites] - method. + `SiteSearchEngineService.ListTargetSites + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -1266,7 +1300,8 @@ async def create_sitemap( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Creates a [Sitemap][google.cloud.discoveryengine.v1.Sitemap]. + r"""Creates a `Sitemap + `__. .. code-block:: python @@ -1305,11 +1340,13 @@ async def sample_create_sitemap(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.CreateSitemapRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.CreateSitemap][google.cloud.discoveryengine.v1.SiteSearchEngineService.CreateSitemap] + `SiteSearchEngineService.CreateSitemap + `__ method. parent (:class:`str`): Required. Parent resource name of the - [SiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine``. @@ -1317,9 +1354,9 @@ async def sample_create_sitemap(): on the ``request`` instance; if ``request`` is provided, this should not be set. sitemap (:class:`google.cloud.discoveryengine_v1.types.Sitemap`): - Required. The - [Sitemap][google.cloud.discoveryengine.v1.Sitemap] to - create. + Required. The `Sitemap + `__ + to create. This corresponds to the ``sitemap`` field on the ``request`` instance; if ``request`` is provided, this @@ -1334,11 +1371,12 @@ async def sample_create_sitemap(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be - :class:`google.cloud.discoveryengine_v1.types.Sitemap` A - sitemap for the SiteSearchEngine. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.Sitemap` + A sitemap for the SiteSearchEngine. """ # Create or coerce a protobuf request object. @@ -1411,7 +1449,8 @@ async def delete_sitemap( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Deletes a [Sitemap][google.cloud.discoveryengine.v1.Sitemap]. + r"""Deletes a `Sitemap + `__. .. code-block:: python @@ -1446,22 +1485,26 @@ async def sample_delete_sitemap(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.DeleteSitemapRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.DeleteSitemap][google.cloud.discoveryengine.v1.SiteSearchEngineService.DeleteSitemap] + `SiteSearchEngineService.DeleteSitemap + `__ method. name (:class:`str`): Required. Full resource name of - [Sitemap][google.cloud.discoveryengine.v1.Sitemap], such - as + `Sitemap + `__, + such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}``. - If the caller does not have permission to access the - [Sitemap][google.cloud.discoveryengine.v1.Sitemap], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `Sitemap + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the requested - [Sitemap][google.cloud.discoveryengine.v1.Sitemap] does - not exist, a NOT_FOUND error is returned. + If the requested `Sitemap + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -1476,18 +1519,21 @@ async def sample_delete_sitemap(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. @@ -1558,8 +1604,10 @@ async def fetch_sitemaps( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> site_search_engine_service.FetchSitemapsResponse: - r"""Fetch [Sitemap][google.cloud.discoveryengine.v1.Sitemap]s in a - [DataStore][google.cloud.discoveryengine.v1.DataStore]. + r"""Fetch `Sitemap + `__s in a + `DataStore + `__. .. code-block:: python @@ -1590,11 +1638,13 @@ async def sample_fetch_sitemaps(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.FetchSitemapsRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.FetchSitemaps][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchSitemaps] + `SiteSearchEngineService.FetchSitemaps + `__ method. parent (:class:`str`): Required. Parent resource name of the - [SiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine``. @@ -1612,8 +1662,9 @@ async def sample_fetch_sitemaps(): Returns: google.cloud.discoveryengine_v1.types.FetchSitemapsResponse: Response message for - [SiteSearchEngineService.FetchSitemaps][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchSitemaps] - method. + `SiteSearchEngineService.FetchSitemaps + `__ + method. """ # Create or coerce a protobuf request object. @@ -1711,7 +1762,8 @@ async def sample_enable_advanced_site_search(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.EnableAdvancedSiteSearchRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.EnableAdvancedSiteSearch] + `SiteSearchEngineService.EnableAdvancedSiteSearch + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -1723,11 +1775,15 @@ async def sample_enable_advanced_site_search(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.EnableAdvancedSiteSearchResponse` Response message for - [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.EnableAdvancedSiteSearch] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.EnableAdvancedSiteSearchResponse` + Response message for + `SiteSearchEngineService.EnableAdvancedSiteSearch + `__ + method. """ # Create or coerce a protobuf request object. @@ -1822,7 +1878,8 @@ async def sample_disable_advanced_site_search(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.DisableAdvancedSiteSearchRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.DisableAdvancedSiteSearch] + `SiteSearchEngineService.DisableAdvancedSiteSearch + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -1834,11 +1891,15 @@ async def sample_disable_advanced_site_search(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.DisableAdvancedSiteSearchResponse` Response message for - [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.DisableAdvancedSiteSearch] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.DisableAdvancedSiteSearchResponse` + Response message for + `SiteSearchEngineService.DisableAdvancedSiteSearch + `__ + method. """ # Create or coerce a protobuf request object. @@ -1933,7 +1994,8 @@ async def sample_recrawl_uris(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.RecrawlUrisRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1.SiteSearchEngineService.RecrawlUris] + `SiteSearchEngineService.RecrawlUris + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -1945,11 +2007,15 @@ async def sample_recrawl_uris(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.RecrawlUrisResponse` Response message for - [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1.SiteSearchEngineService.RecrawlUris] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.RecrawlUrisResponse` + Response message for + `SiteSearchEngineService.RecrawlUris + `__ + method. """ # Create or coerce a protobuf request object. @@ -2041,7 +2107,8 @@ async def sample_batch_verify_target_sites(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.BatchVerifyTargetSitesRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchVerifyTargetSites] + `SiteSearchEngineService.BatchVerifyTargetSites + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -2053,11 +2120,15 @@ async def sample_batch_verify_target_sites(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.BatchVerifyTargetSitesResponse` Response message for - [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchVerifyTargetSites] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.BatchVerifyTargetSitesResponse` + Response message for + `SiteSearchEngineService.BatchVerifyTargetSites + `__ + method. """ # Create or coerce a protobuf request object. @@ -2112,9 +2183,10 @@ async def fetch_domain_verification_status( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.FetchDomainVerificationStatusAsyncPager: - r"""Returns list of target sites with its domain verification - status. This method can only be called under data store with - BASIC_SITE_SEARCH state at the moment. + r"""Returns list of target sites with its domain + verification status. This method can only be called + under data store with BASIC_SITE_SEARCH state at the + moment. .. code-block:: python @@ -2146,7 +2218,8 @@ async def sample_fetch_domain_verification_status(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.FetchDomainVerificationStatusRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchDomainVerificationStatus] + `SiteSearchEngineService.FetchDomainVerificationStatus + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -2159,11 +2232,13 @@ async def sample_fetch_domain_verification_status(): Returns: google.cloud.discoveryengine_v1.services.site_search_engine_service.pagers.FetchDomainVerificationStatusAsyncPager: Response message for - [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchDomainVerificationStatus] - method. + `SiteSearchEngineService.FetchDomainVerificationStatus + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/site_search_engine_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/site_search_engine_service/client.py index f8b1fcf5ad26..1016a8fbb235 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/site_search_engine_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/site_search_engine_service/client.py @@ -789,7 +789,8 @@ def get_site_search_engine( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> site_search_engine.SiteSearchEngine: r"""Gets the - [SiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngine]. + `SiteSearchEngine + `__. .. code-block:: python @@ -820,17 +821,20 @@ def sample_get_site_search_engine(): Args: request (Union[google.cloud.discoveryengine_v1.types.GetSiteSearchEngineRequest, dict]): The request object. Request message for - [SiteSearchEngineService.GetSiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngineService.GetSiteSearchEngine] + `SiteSearchEngineService.GetSiteSearchEngine + `__ method. name (str): Required. Resource name of - [SiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. - If the caller does not have permission to access the - [SiteSearchEngine], regardless of whether or not it - exists, a PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the [SiteSearchEngine], + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -911,8 +915,8 @@ def create_target_site( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Creates a - [TargetSite][google.cloud.discoveryengine.v1.TargetSite]. + r"""Creates a `TargetSite + `__. .. code-block:: python @@ -951,11 +955,13 @@ def sample_create_target_site(): Args: request (Union[google.cloud.discoveryengine_v1.types.CreateTargetSiteRequest, dict]): The request object. Request message for - [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.CreateTargetSite] + `SiteSearchEngineService.CreateTargetSite + `__ method. parent (str): Required. Parent resource name of - [TargetSite][google.cloud.discoveryengine.v1.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. @@ -963,8 +969,8 @@ def sample_create_target_site(): on the ``request`` instance; if ``request`` is provided, this should not be set. target_site (google.cloud.discoveryengine_v1.types.TargetSite): - Required. The - [TargetSite][google.cloud.discoveryengine.v1.TargetSite] + Required. The `TargetSite + `__ to create. This corresponds to the ``target_site`` field @@ -980,9 +986,10 @@ def sample_create_target_site(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1.types.TargetSite` A target site for the SiteSearchEngine. @@ -1053,8 +1060,9 @@ def batch_create_target_sites( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Creates [TargetSite][google.cloud.discoveryengine.v1.TargetSite] - in a batch. + r"""Creates `TargetSite + `__ in a + batch. .. code-block:: python @@ -1094,7 +1102,8 @@ def sample_batch_create_target_sites(): Args: request (Union[google.cloud.discoveryengine_v1.types.BatchCreateTargetSitesRequest, dict]): The request object. Request message for - [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchCreateTargetSites] + `SiteSearchEngineService.BatchCreateTargetSites + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1106,11 +1115,15 @@ def sample_batch_create_target_sites(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.BatchCreateTargetSitesResponse` Response message for - [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchCreateTargetSites] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.BatchCreateTargetSitesResponse` + Response message for + `SiteSearchEngineService.BatchCreateTargetSites + `__ + method. """ # Create or coerce a protobuf request object. @@ -1166,7 +1179,8 @@ def get_target_site( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> site_search_engine.TargetSite: - r"""Gets a [TargetSite][google.cloud.discoveryengine.v1.TargetSite]. + r"""Gets a `TargetSite + `__. .. code-block:: python @@ -1197,22 +1211,26 @@ def sample_get_target_site(): Args: request (Union[google.cloud.discoveryengine_v1.types.GetTargetSiteRequest, dict]): The request object. Request message for - [SiteSearchEngineService.GetTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.GetTargetSite] + `SiteSearchEngineService.GetTargetSite + `__ method. name (str): Required. Full resource name of - [TargetSite][google.cloud.discoveryengine.v1.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}``. - If the caller does not have permission to access the - [TargetSite][google.cloud.discoveryengine.v1.TargetSite], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `TargetSite + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the requested - [TargetSite][google.cloud.discoveryengine.v1.TargetSite] - does not exist, a NOT_FOUND error is returned. + If the requested `TargetSite + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -1288,8 +1306,8 @@ def update_target_site( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Updates a - [TargetSite][google.cloud.discoveryengine.v1.TargetSite]. + r"""Updates a `TargetSite + `__. .. code-block:: python @@ -1327,18 +1345,21 @@ def sample_update_target_site(): Args: request (Union[google.cloud.discoveryengine_v1.types.UpdateTargetSiteRequest, dict]): The request object. Request message for - [SiteSearchEngineService.UpdateTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.UpdateTargetSite] + `SiteSearchEngineService.UpdateTargetSite + `__ method. target_site (google.cloud.discoveryengine_v1.types.TargetSite): - Required. The target site to update. If the caller does - not have permission to update the - [TargetSite][google.cloud.discoveryengine.v1.TargetSite], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. - - If the - [TargetSite][google.cloud.discoveryengine.v1.TargetSite] - to update does not exist, a NOT_FOUND error is returned. + Required. The target site to update. + If the caller does not have permission + to update the `TargetSite + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. + + If the `TargetSite + `__ + to update does not exist, a NOT_FOUND + error is returned. This corresponds to the ``target_site`` field on the ``request`` instance; if ``request`` is provided, this @@ -1353,9 +1374,10 @@ def sample_update_target_site(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1.types.TargetSite` A target site for the SiteSearchEngine. @@ -1427,8 +1449,8 @@ def delete_target_site( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Deletes a - [TargetSite][google.cloud.discoveryengine.v1.TargetSite]. + r"""Deletes a `TargetSite + `__. .. code-block:: python @@ -1463,22 +1485,26 @@ def sample_delete_target_site(): Args: request (Union[google.cloud.discoveryengine_v1.types.DeleteTargetSiteRequest, dict]): The request object. Request message for - [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.DeleteTargetSite] + `SiteSearchEngineService.DeleteTargetSite + `__ method. name (str): Required. Full resource name of - [TargetSite][google.cloud.discoveryengine.v1.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}``. - If the caller does not have permission to access the - [TargetSite][google.cloud.discoveryengine.v1.TargetSite], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `TargetSite + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the requested - [TargetSite][google.cloud.discoveryengine.v1.TargetSite] - does not exist, a NOT_FOUND error is returned. + If the requested `TargetSite + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -1493,18 +1519,21 @@ def sample_delete_target_site(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. @@ -1572,8 +1601,8 @@ def list_target_sites( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListTargetSitesPager: - r"""Gets a list of - [TargetSite][google.cloud.discoveryengine.v1.TargetSite]s. + r"""Gets a list of `TargetSite + `__s. .. code-block:: python @@ -1605,17 +1634,20 @@ def sample_list_target_sites(): Args: request (Union[google.cloud.discoveryengine_v1.types.ListTargetSitesRequest, dict]): The request object. Request message for - [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.ListTargetSites] + `SiteSearchEngineService.ListTargetSites + `__ method. parent (str): - Required. The parent site search engine resource name, - such as + Required. The parent site search engine + resource name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. - If the caller does not have permission to list - [TargetSite][google.cloud.discoveryengine.v1.TargetSite]s - under this site search engine, regardless of whether or - not this branch exists, a PERMISSION_DENIED error is + If the caller does not have permission + to list `TargetSite + `__s + under this site search engine, + regardless of whether or not this branch + exists, a PERMISSION_DENIED error is returned. This corresponds to the ``parent`` field @@ -1632,11 +1664,13 @@ def sample_list_target_sites(): Returns: google.cloud.discoveryengine_v1.services.site_search_engine_service.pagers.ListTargetSitesPager: Response message for - [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.ListTargetSites] - method. + `SiteSearchEngineService.ListTargetSites + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -1708,7 +1742,8 @@ def create_sitemap( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Creates a [Sitemap][google.cloud.discoveryengine.v1.Sitemap]. + r"""Creates a `Sitemap + `__. .. code-block:: python @@ -1747,11 +1782,13 @@ def sample_create_sitemap(): Args: request (Union[google.cloud.discoveryengine_v1.types.CreateSitemapRequest, dict]): The request object. Request message for - [SiteSearchEngineService.CreateSitemap][google.cloud.discoveryengine.v1.SiteSearchEngineService.CreateSitemap] + `SiteSearchEngineService.CreateSitemap + `__ method. parent (str): Required. Parent resource name of the - [SiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine``. @@ -1759,9 +1796,9 @@ def sample_create_sitemap(): on the ``request`` instance; if ``request`` is provided, this should not be set. sitemap (google.cloud.discoveryengine_v1.types.Sitemap): - Required. The - [Sitemap][google.cloud.discoveryengine.v1.Sitemap] to - create. + Required. The `Sitemap + `__ + to create. This corresponds to the ``sitemap`` field on the ``request`` instance; if ``request`` is provided, this @@ -1776,11 +1813,12 @@ def sample_create_sitemap(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be - :class:`google.cloud.discoveryengine_v1.types.Sitemap` A - sitemap for the SiteSearchEngine. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.Sitemap` + A sitemap for the SiteSearchEngine. """ # Create or coerce a protobuf request object. @@ -1850,7 +1888,8 @@ def delete_sitemap( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Deletes a [Sitemap][google.cloud.discoveryengine.v1.Sitemap]. + r"""Deletes a `Sitemap + `__. .. code-block:: python @@ -1885,22 +1924,26 @@ def sample_delete_sitemap(): Args: request (Union[google.cloud.discoveryengine_v1.types.DeleteSitemapRequest, dict]): The request object. Request message for - [SiteSearchEngineService.DeleteSitemap][google.cloud.discoveryengine.v1.SiteSearchEngineService.DeleteSitemap] + `SiteSearchEngineService.DeleteSitemap + `__ method. name (str): Required. Full resource name of - [Sitemap][google.cloud.discoveryengine.v1.Sitemap], such - as + `Sitemap + `__, + such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}``. - If the caller does not have permission to access the - [Sitemap][google.cloud.discoveryengine.v1.Sitemap], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `Sitemap + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the requested - [Sitemap][google.cloud.discoveryengine.v1.Sitemap] does - not exist, a NOT_FOUND error is returned. + If the requested `Sitemap + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -1915,18 +1958,21 @@ def sample_delete_sitemap(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. @@ -1994,8 +2040,10 @@ def fetch_sitemaps( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> site_search_engine_service.FetchSitemapsResponse: - r"""Fetch [Sitemap][google.cloud.discoveryengine.v1.Sitemap]s in a - [DataStore][google.cloud.discoveryengine.v1.DataStore]. + r"""Fetch `Sitemap + `__s in a + `DataStore + `__. .. code-block:: python @@ -2026,11 +2074,13 @@ def sample_fetch_sitemaps(): Args: request (Union[google.cloud.discoveryengine_v1.types.FetchSitemapsRequest, dict]): The request object. Request message for - [SiteSearchEngineService.FetchSitemaps][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchSitemaps] + `SiteSearchEngineService.FetchSitemaps + `__ method. parent (str): Required. Parent resource name of the - [SiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine``. @@ -2048,8 +2098,9 @@ def sample_fetch_sitemaps(): Returns: google.cloud.discoveryengine_v1.types.FetchSitemapsResponse: Response message for - [SiteSearchEngineService.FetchSitemaps][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchSitemaps] - method. + `SiteSearchEngineService.FetchSitemaps + `__ + method. """ # Create or coerce a protobuf request object. @@ -2144,7 +2195,8 @@ def sample_enable_advanced_site_search(): Args: request (Union[google.cloud.discoveryengine_v1.types.EnableAdvancedSiteSearchRequest, dict]): The request object. Request message for - [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.EnableAdvancedSiteSearch] + `SiteSearchEngineService.EnableAdvancedSiteSearch + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2156,11 +2208,15 @@ def sample_enable_advanced_site_search(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.EnableAdvancedSiteSearchResponse` Response message for - [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.EnableAdvancedSiteSearch] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.EnableAdvancedSiteSearchResponse` + Response message for + `SiteSearchEngineService.EnableAdvancedSiteSearch + `__ + method. """ # Create or coerce a protobuf request object. @@ -2255,7 +2311,8 @@ def sample_disable_advanced_site_search(): Args: request (Union[google.cloud.discoveryengine_v1.types.DisableAdvancedSiteSearchRequest, dict]): The request object. Request message for - [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.DisableAdvancedSiteSearch] + `SiteSearchEngineService.DisableAdvancedSiteSearch + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2267,11 +2324,15 @@ def sample_disable_advanced_site_search(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.DisableAdvancedSiteSearchResponse` Response message for - [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.DisableAdvancedSiteSearch] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.DisableAdvancedSiteSearchResponse` + Response message for + `SiteSearchEngineService.DisableAdvancedSiteSearch + `__ + method. """ # Create or coerce a protobuf request object. @@ -2366,7 +2427,8 @@ def sample_recrawl_uris(): Args: request (Union[google.cloud.discoveryengine_v1.types.RecrawlUrisRequest, dict]): The request object. Request message for - [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1.SiteSearchEngineService.RecrawlUris] + `SiteSearchEngineService.RecrawlUris + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2378,11 +2440,15 @@ def sample_recrawl_uris(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.RecrawlUrisResponse` Response message for - [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1.SiteSearchEngineService.RecrawlUris] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.RecrawlUrisResponse` + Response message for + `SiteSearchEngineService.RecrawlUris + `__ + method. """ # Create or coerce a protobuf request object. @@ -2472,7 +2538,8 @@ def sample_batch_verify_target_sites(): Args: request (Union[google.cloud.discoveryengine_v1.types.BatchVerifyTargetSitesRequest, dict]): The request object. Request message for - [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchVerifyTargetSites] + `SiteSearchEngineService.BatchVerifyTargetSites + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2484,11 +2551,15 @@ def sample_batch_verify_target_sites(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.BatchVerifyTargetSitesResponse` Response message for - [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchVerifyTargetSites] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.BatchVerifyTargetSitesResponse` + Response message for + `SiteSearchEngineService.BatchVerifyTargetSites + `__ + method. """ # Create or coerce a protobuf request object. @@ -2543,9 +2614,10 @@ def fetch_domain_verification_status( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.FetchDomainVerificationStatusPager: - r"""Returns list of target sites with its domain verification - status. This method can only be called under data store with - BASIC_SITE_SEARCH state at the moment. + r"""Returns list of target sites with its domain + verification status. This method can only be called + under data store with BASIC_SITE_SEARCH state at the + moment. .. code-block:: python @@ -2577,7 +2649,8 @@ def sample_fetch_domain_verification_status(): Args: request (Union[google.cloud.discoveryengine_v1.types.FetchDomainVerificationStatusRequest, dict]): The request object. Request message for - [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchDomainVerificationStatus] + `SiteSearchEngineService.FetchDomainVerificationStatus + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2590,11 +2663,13 @@ def sample_fetch_domain_verification_status(): Returns: google.cloud.discoveryengine_v1.services.site_search_engine_service.pagers.FetchDomainVerificationStatusPager: Response message for - [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchDomainVerificationStatus] - method. + `SiteSearchEngineService.FetchDomainVerificationStatus + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/site_search_engine_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/site_search_engine_service/transports/grpc.py index 082f14f87f21..4904d79e4809 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/site_search_engine_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/site_search_engine_service/transports/grpc.py @@ -353,7 +353,8 @@ def get_site_search_engine( r"""Return a callable for the get site search engine method over gRPC. Gets the - [SiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngine]. + `SiteSearchEngine + `__. Returns: Callable[[~.GetSiteSearchEngineRequest], @@ -381,8 +382,8 @@ def create_target_site( ]: r"""Return a callable for the create target site method over gRPC. - Creates a - [TargetSite][google.cloud.discoveryengine.v1.TargetSite]. + Creates a `TargetSite + `__. Returns: Callable[[~.CreateTargetSiteRequest], @@ -411,8 +412,9 @@ def batch_create_target_sites( ]: r"""Return a callable for the batch create target sites method over gRPC. - Creates [TargetSite][google.cloud.discoveryengine.v1.TargetSite] - in a batch. + Creates `TargetSite + `__ in a + batch. Returns: Callable[[~.BatchCreateTargetSitesRequest], @@ -440,7 +442,8 @@ def get_target_site( ]: r"""Return a callable for the get target site method over gRPC. - Gets a [TargetSite][google.cloud.discoveryengine.v1.TargetSite]. + Gets a `TargetSite + `__. Returns: Callable[[~.GetTargetSiteRequest], @@ -468,8 +471,8 @@ def update_target_site( ]: r"""Return a callable for the update target site method over gRPC. - Updates a - [TargetSite][google.cloud.discoveryengine.v1.TargetSite]. + Updates a `TargetSite + `__. Returns: Callable[[~.UpdateTargetSiteRequest], @@ -497,8 +500,8 @@ def delete_target_site( ]: r"""Return a callable for the delete target site method over gRPC. - Deletes a - [TargetSite][google.cloud.discoveryengine.v1.TargetSite]. + Deletes a `TargetSite + `__. Returns: Callable[[~.DeleteTargetSiteRequest], @@ -527,8 +530,8 @@ def list_target_sites( ]: r"""Return a callable for the list target sites method over gRPC. - Gets a list of - [TargetSite][google.cloud.discoveryengine.v1.TargetSite]s. + Gets a list of `TargetSite + `__s. Returns: Callable[[~.ListTargetSitesRequest], @@ -556,7 +559,8 @@ def create_sitemap( ]: r"""Return a callable for the create sitemap method over gRPC. - Creates a [Sitemap][google.cloud.discoveryengine.v1.Sitemap]. + Creates a `Sitemap + `__. Returns: Callable[[~.CreateSitemapRequest], @@ -584,7 +588,8 @@ def delete_sitemap( ]: r"""Return a callable for the delete sitemap method over gRPC. - Deletes a [Sitemap][google.cloud.discoveryengine.v1.Sitemap]. + Deletes a `Sitemap + `__. Returns: Callable[[~.DeleteSitemapRequest], @@ -613,8 +618,10 @@ def fetch_sitemaps( ]: r"""Return a callable for the fetch sitemaps method over gRPC. - Fetch [Sitemap][google.cloud.discoveryengine.v1.Sitemap]s in a - [DataStore][google.cloud.discoveryengine.v1.DataStore]. + Fetch `Sitemap + `__s in a + `DataStore + `__. Returns: Callable[[~.FetchSitemapsRequest], @@ -767,9 +774,10 @@ def fetch_domain_verification_status( r"""Return a callable for the fetch domain verification status method over gRPC. - Returns list of target sites with its domain verification - status. This method can only be called under data store with - BASIC_SITE_SEARCH state at the moment. + Returns list of target sites with its domain + verification status. This method can only be called + under data store with BASIC_SITE_SEARCH state at the + moment. Returns: Callable[[~.FetchDomainVerificationStatusRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/site_search_engine_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/site_search_engine_service/transports/grpc_asyncio.py index 2614081a8a1b..918eabaca59d 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/site_search_engine_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/site_search_engine_service/transports/grpc_asyncio.py @@ -361,7 +361,8 @@ def get_site_search_engine( r"""Return a callable for the get site search engine method over gRPC. Gets the - [SiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngine]. + `SiteSearchEngine + `__. Returns: Callable[[~.GetSiteSearchEngineRequest], @@ -390,8 +391,8 @@ def create_target_site( ]: r"""Return a callable for the create target site method over gRPC. - Creates a - [TargetSite][google.cloud.discoveryengine.v1.TargetSite]. + Creates a `TargetSite + `__. Returns: Callable[[~.CreateTargetSiteRequest], @@ -420,8 +421,9 @@ def batch_create_target_sites( ]: r"""Return a callable for the batch create target sites method over gRPC. - Creates [TargetSite][google.cloud.discoveryengine.v1.TargetSite] - in a batch. + Creates `TargetSite + `__ in a + batch. Returns: Callable[[~.BatchCreateTargetSitesRequest], @@ -450,7 +452,8 @@ def get_target_site( ]: r"""Return a callable for the get target site method over gRPC. - Gets a [TargetSite][google.cloud.discoveryengine.v1.TargetSite]. + Gets a `TargetSite + `__. Returns: Callable[[~.GetTargetSiteRequest], @@ -479,8 +482,8 @@ def update_target_site( ]: r"""Return a callable for the update target site method over gRPC. - Updates a - [TargetSite][google.cloud.discoveryengine.v1.TargetSite]. + Updates a `TargetSite + `__. Returns: Callable[[~.UpdateTargetSiteRequest], @@ -509,8 +512,8 @@ def delete_target_site( ]: r"""Return a callable for the delete target site method over gRPC. - Deletes a - [TargetSite][google.cloud.discoveryengine.v1.TargetSite]. + Deletes a `TargetSite + `__. Returns: Callable[[~.DeleteTargetSiteRequest], @@ -539,8 +542,8 @@ def list_target_sites( ]: r"""Return a callable for the list target sites method over gRPC. - Gets a list of - [TargetSite][google.cloud.discoveryengine.v1.TargetSite]s. + Gets a list of `TargetSite + `__s. Returns: Callable[[~.ListTargetSitesRequest], @@ -569,7 +572,8 @@ def create_sitemap( ]: r"""Return a callable for the create sitemap method over gRPC. - Creates a [Sitemap][google.cloud.discoveryengine.v1.Sitemap]. + Creates a `Sitemap + `__. Returns: Callable[[~.CreateSitemapRequest], @@ -598,7 +602,8 @@ def delete_sitemap( ]: r"""Return a callable for the delete sitemap method over gRPC. - Deletes a [Sitemap][google.cloud.discoveryengine.v1.Sitemap]. + Deletes a `Sitemap + `__. Returns: Callable[[~.DeleteSitemapRequest], @@ -627,8 +632,10 @@ def fetch_sitemaps( ]: r"""Return a callable for the fetch sitemaps method over gRPC. - Fetch [Sitemap][google.cloud.discoveryengine.v1.Sitemap]s in a - [DataStore][google.cloud.discoveryengine.v1.DataStore]. + Fetch `Sitemap + `__s in a + `DataStore + `__. Returns: Callable[[~.FetchSitemapsRequest], @@ -782,9 +789,10 @@ def fetch_domain_verification_status( r"""Return a callable for the fetch domain verification status method over gRPC. - Returns list of target sites with its domain verification - status. This method can only be called under data store with - BASIC_SITE_SEARCH state at the moment. + Returns list of target sites with its domain + verification status. This method can only be called + under data store with BASIC_SITE_SEARCH state at the + moment. Returns: Callable[[~.FetchDomainVerificationStatusRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/site_search_engine_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/site_search_engine_service/transports/rest.py index d81dea2526f0..8ba4e44d5219 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/site_search_engine_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/site_search_engine_service/transports/rest.py @@ -1336,7 +1336,8 @@ def __call__( Args: request (~.site_search_engine_service.BatchCreateTargetSitesRequest): The request object. Request message for - [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchCreateTargetSites] + `SiteSearchEngineService.BatchCreateTargetSites + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1492,7 +1493,8 @@ def __call__( Args: request (~.site_search_engine_service.BatchVerifyTargetSitesRequest): The request object. Request message for - [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchVerifyTargetSites] + `SiteSearchEngineService.BatchVerifyTargetSites + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1648,7 +1650,8 @@ def __call__( Args: request (~.site_search_engine_service.CreateSitemapRequest): The request object. Request message for - [SiteSearchEngineService.CreateSitemap][google.cloud.discoveryengine.v1.SiteSearchEngineService.CreateSitemap] + `SiteSearchEngineService.CreateSitemap + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1804,7 +1807,8 @@ def __call__( Args: request (~.site_search_engine_service.CreateTargetSiteRequest): The request object. Request message for - [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.CreateTargetSite] + `SiteSearchEngineService.CreateTargetSite + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1961,7 +1965,8 @@ def __call__( Args: request (~.site_search_engine_service.DeleteSitemapRequest): The request object. Request message for - [SiteSearchEngineService.DeleteSitemap][google.cloud.discoveryengine.v1.SiteSearchEngineService.DeleteSitemap] + `SiteSearchEngineService.DeleteSitemap + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2111,7 +2116,8 @@ def __call__( Args: request (~.site_search_engine_service.DeleteTargetSiteRequest): The request object. Request message for - [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.DeleteTargetSite] + `SiteSearchEngineService.DeleteTargetSite + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2267,7 +2273,8 @@ def __call__( Args: request (~.site_search_engine_service.DisableAdvancedSiteSearchRequest): The request object. Request message for - [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.DisableAdvancedSiteSearch] + `SiteSearchEngineService.DisableAdvancedSiteSearch + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2424,7 +2431,8 @@ def __call__( Args: request (~.site_search_engine_service.EnableAdvancedSiteSearchRequest): The request object. Request message for - [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.EnableAdvancedSiteSearch] + `SiteSearchEngineService.EnableAdvancedSiteSearch + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2582,7 +2590,8 @@ def __call__( Args: request (~.site_search_engine_service.FetchDomainVerificationStatusRequest): The request object. Request message for - [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchDomainVerificationStatus] + `SiteSearchEngineService.FetchDomainVerificationStatus + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2595,7 +2604,8 @@ def __call__( Returns: ~.site_search_engine_service.FetchDomainVerificationStatusResponse: Response message for - [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchDomainVerificationStatus] + `SiteSearchEngineService.FetchDomainVerificationStatus + `__ method. """ @@ -2743,7 +2753,8 @@ def __call__( Args: request (~.site_search_engine_service.FetchSitemapsRequest): The request object. Request message for - [SiteSearchEngineService.FetchSitemaps][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchSitemaps] + `SiteSearchEngineService.FetchSitemaps + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2756,7 +2767,8 @@ def __call__( Returns: ~.site_search_engine_service.FetchSitemapsResponse: Response message for - [SiteSearchEngineService.FetchSitemaps][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchSitemaps] + `SiteSearchEngineService.FetchSitemaps + `__ method. """ @@ -2899,7 +2911,8 @@ def __call__( Args: request (~.site_search_engine_service.GetSiteSearchEngineRequest): The request object. Request message for - [SiteSearchEngineService.GetSiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngineService.GetSiteSearchEngine] + `SiteSearchEngineService.GetSiteSearchEngine + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -3056,7 +3069,8 @@ def __call__( Args: request (~.site_search_engine_service.GetTargetSiteRequest): The request object. Request message for - [SiteSearchEngineService.GetTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.GetTargetSite] + `SiteSearchEngineService.GetTargetSite + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -3207,7 +3221,8 @@ def __call__( Args: request (~.site_search_engine_service.ListTargetSitesRequest): The request object. Request message for - [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.ListTargetSites] + `SiteSearchEngineService.ListTargetSites + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -3220,7 +3235,8 @@ def __call__( Returns: ~.site_search_engine_service.ListTargetSitesResponse: Response message for - [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.ListTargetSites] + `SiteSearchEngineService.ListTargetSites + `__ method. """ @@ -3366,7 +3382,8 @@ def __call__( Args: request (~.site_search_engine_service.RecrawlUrisRequest): The request object. Request message for - [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1.SiteSearchEngineService.RecrawlUris] + `SiteSearchEngineService.RecrawlUris + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -3520,7 +3537,8 @@ def __call__( Args: request (~.site_search_engine_service.UpdateTargetSiteRequest): The request object. Request message for - [SiteSearchEngineService.UpdateTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.UpdateTargetSite] + `SiteSearchEngineService.UpdateTargetSite + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/user_event_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/user_event_service/async_client.py index f7f698f5f8bb..7e44110de5dc 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/user_event_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/user_event_service/async_client.py @@ -455,52 +455,61 @@ async def sample_collect_user_event(): Returns: google.api.httpbody_pb2.HttpBody: - Message that represents an arbitrary HTTP body. It should only be used for - payload formats that can't be represented as JSON, - such as raw binary or an HTML page. - - This message can be used both in streaming and - non-streaming API methods in the request as well as - the response. - - It can be used as a top-level request field, which is - convenient if one wants to extract parameters from - either the URL or HTTP template into the request - fields and also want access to the raw HTTP body. - - Example: - - message GetResourceRequest { - // A unique request id. string request_id = 1; - - // The raw HTTP body is bound to this field. - google.api.HttpBody http_body = 2; - - } - - service ResourceService { - rpc GetResource(GetResourceRequest) - returns (google.api.HttpBody); - - rpc UpdateResource(google.api.HttpBody) - returns (google.protobuf.Empty); - - } - - Example with streaming methods: - - service CaldavService { - rpc GetCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); - - rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); - - } - - Use of this type only changes how the request and - response bodies are handled, all other features will - continue to work unchanged. + Message that represents an arbitrary + HTTP body. It should only be used for + payload formats that can't be + represented as JSON, such as raw binary + or an HTML page. + + This message can be used both in + streaming and non-streaming API methods + in the request as well as the response. + + It can be used as a top-level request + field, which is convenient if one wants + to extract parameters from either the + URL or HTTP template into the request + fields and also want access to the raw + HTTP body. + + Example: + + message GetResourceRequest { + // A unique request id. + string request_id = 1; + + // The raw HTTP body is bound to + this field. google.api.HttpBody + http_body = 2; + + } + + service ResourceService { + rpc + GetResource(GetResourceRequest) + returns (google.api.HttpBody); + rpc + UpdateResource(google.api.HttpBody) + returns (google.protobuf.Empty); + + } + + Example with streaming methods: + + service CaldavService { + rpc GetCalendar(stream + google.api.HttpBody) returns + (stream google.api.HttpBody); rpc + UpdateCalendar(stream + google.api.HttpBody) returns + (stream google.api.HttpBody); + + } + + Use of this type only changes how the + request and response bodies are handled, + all other features will continue to work + unchanged. """ # Create or coerce a protobuf request object. @@ -594,11 +603,17 @@ async def sample_purge_user_events(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.PurgeUserEventsResponse` Response of the PurgeUserEventsRequest. If the long running operation is - successfully done, then this message is returned by - the google.longrunning.Operations.response field. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.PurgeUserEventsResponse` + Response of the PurgeUserEventsRequest. + If the long running operation is + successfully done, then this message is + returned by the + google.longrunning.Operations.response + field. """ # Create or coerce a protobuf request object. @@ -707,13 +722,17 @@ async def sample_import_user_events(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.ImportUserEventsResponse` Response of the ImportUserEventsRequest. If the long running - operation was successful, then this message is - returned by the - google.longrunning.Operations.response field if the - operation was successful. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.ImportUserEventsResponse` + Response of the ImportUserEventsRequest. + If the long running operation was + successful, then this message is + returned by the + google.longrunning.Operations.response + field if the operation was successful. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/user_event_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/user_event_service/client.py index f70be2aaff4b..f10c5a7387c1 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/user_event_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/user_event_service/client.py @@ -923,52 +923,61 @@ def sample_collect_user_event(): Returns: google.api.httpbody_pb2.HttpBody: - Message that represents an arbitrary HTTP body. It should only be used for - payload formats that can't be represented as JSON, - such as raw binary or an HTML page. + Message that represents an arbitrary + HTTP body. It should only be used for + payload formats that can't be + represented as JSON, such as raw binary + or an HTML page. - This message can be used both in streaming and - non-streaming API methods in the request as well as - the response. + This message can be used both in + streaming and non-streaming API methods + in the request as well as the response. - It can be used as a top-level request field, which is - convenient if one wants to extract parameters from - either the URL or HTTP template into the request - fields and also want access to the raw HTTP body. + It can be used as a top-level request + field, which is convenient if one wants + to extract parameters from either the + URL or HTTP template into the request + fields and also want access to the raw + HTTP body. - Example: + Example: - message GetResourceRequest { - // A unique request id. string request_id = 1; + message GetResourceRequest { + // A unique request id. + string request_id = 1; - // The raw HTTP body is bound to this field. - google.api.HttpBody http_body = 2; + // The raw HTTP body is bound to + this field. google.api.HttpBody + http_body = 2; - } - - service ResourceService { - rpc GetResource(GetResourceRequest) - returns (google.api.HttpBody); - - rpc UpdateResource(google.api.HttpBody) - returns (google.protobuf.Empty); + } - } + service ResourceService { + rpc + GetResource(GetResourceRequest) + returns (google.api.HttpBody); + rpc + UpdateResource(google.api.HttpBody) + returns (google.protobuf.Empty); - Example with streaming methods: + } - service CaldavService { - rpc GetCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); + Example with streaming methods: - rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); + service CaldavService { + rpc GetCalendar(stream + google.api.HttpBody) returns + (stream google.api.HttpBody); rpc + UpdateCalendar(stream + google.api.HttpBody) returns + (stream google.api.HttpBody); - } + } - Use of this type only changes how the request and - response bodies are handled, all other features will - continue to work unchanged. + Use of this type only changes how the + request and response bodies are handled, + all other features will continue to work + unchanged. """ # Create or coerce a protobuf request object. @@ -1060,11 +1069,17 @@ def sample_purge_user_events(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.PurgeUserEventsResponse` Response of the PurgeUserEventsRequest. If the long running operation is - successfully done, then this message is returned by - the google.longrunning.Operations.response field. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.PurgeUserEventsResponse` + Response of the PurgeUserEventsRequest. + If the long running operation is + successfully done, then this message is + returned by the + google.longrunning.Operations.response + field. """ # Create or coerce a protobuf request object. @@ -1171,13 +1186,17 @@ def sample_import_user_events(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.ImportUserEventsResponse` Response of the ImportUserEventsRequest. If the long running - operation was successful, then this message is - returned by the - google.longrunning.Operations.response field if the - operation was successful. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.ImportUserEventsResponse` + Response of the ImportUserEventsRequest. + If the long running operation was + successful, then this message is + returned by the + google.longrunning.Operations.response + field if the operation was successful. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/user_event_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/user_event_service/transports/rest.py index e93d914728ee..63d8de299e99 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/user_event_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/user_event_service/transports/rest.py @@ -710,55 +710,61 @@ def __call__( Returns: ~.httpbody_pb2.HttpBody: - Message that represents an arbitrary HTTP body. It - should only be used for payload formats that can't be - represented as JSON, such as raw binary or an HTML page. - - This message can be used both in streaming and - non-streaming API methods in the request as well as the - response. - - It can be used as a top-level request field, which is - convenient if one wants to extract parameters from - either the URL or HTTP template into the request fields - and also want access to the raw HTTP body. + Message that represents an arbitrary + HTTP body. It should only be used for + payload formats that can't be + represented as JSON, such as raw binary + or an HTML page. + + This message can be used both in + streaming and non-streaming API methods + in the request as well as the response. + + It can be used as a top-level request + field, which is convenient if one wants + to extract parameters from either the + URL or HTTP template into the request + fields and also want access to the raw + HTTP body. Example: - :: - message GetResourceRequest { // A unique request id. string request_id = 1; - // The raw HTTP body is bound to this field. - google.api.HttpBody http_body = 2; + // The raw HTTP body is bound to + this field. google.api.HttpBody + http_body = 2; } service ResourceService { - rpc GetResource(GetResourceRequest) + rpc + GetResource(GetResourceRequest) returns (google.api.HttpBody); - rpc UpdateResource(google.api.HttpBody) - returns (google.protobuf.Empty); + rpc + UpdateResource(google.api.HttpBody) + returns (google.protobuf.Empty); } Example with streaming methods: - :: - service CaldavService { - rpc GetCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); - rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); + rpc GetCalendar(stream + google.api.HttpBody) returns + (stream google.api.HttpBody); rpc + UpdateCalendar(stream + google.api.HttpBody) returns + (stream google.api.HttpBody); } - Use of this type only changes how the request and - response bodies are handled, all other features will - continue to work unchanged. + Use of this type only changes how the + request and response bodies are handled, + all other features will continue to work + unchanged. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/user_license_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/user_license_service/async_client.py index dcebff58820b..36292e74e778 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/user_license_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/user_license_service/async_client.py @@ -343,10 +343,11 @@ async def sample_list_user_licenses(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.ListUserLicensesRequest, dict]]): The request object. Request message for - [UserLicenseService.ListUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.ListUserLicenses]. + `UserLicenseService.ListUserLicenses + `__. parent (:class:`str`): - Required. The parent [UserStore][] resource name, - format: + Required. The parent [UserStore][] + resource name, format: ``projects/{project}/locations/{location}/userStores/{user_store_id}``. This corresponds to the ``parent`` field @@ -363,10 +364,12 @@ async def sample_list_user_licenses(): Returns: google.cloud.discoveryengine_v1.services.user_license_service.pagers.ListUserLicensesAsyncPager: Response message for - [UserLicenseService.ListUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.ListUserLicenses]. + `UserLicenseService.ListUserLicenses + `__. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -480,7 +483,8 @@ async def sample_batch_update_user_licenses(): Args: request (Optional[Union[google.cloud.discoveryengine_v1.types.BatchUpdateUserLicensesRequest, dict]]): The request object. Request message for - [UserLicenseService.BatchUpdateUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.BatchUpdateUserLicenses] + `UserLicenseService.BatchUpdateUserLicenses + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -492,11 +496,15 @@ async def sample_batch_update_user_licenses(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.BatchUpdateUserLicensesResponse` Response message for - [UserLicenseService.BatchUpdateUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.BatchUpdateUserLicenses] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.BatchUpdateUserLicensesResponse` + Response message for + `UserLicenseService.BatchUpdateUserLicenses + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/user_license_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/user_license_service/client.py index 410ae1121a9c..9f6670529dbf 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/user_license_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/user_license_service/client.py @@ -785,10 +785,11 @@ def sample_list_user_licenses(): Args: request (Union[google.cloud.discoveryengine_v1.types.ListUserLicensesRequest, dict]): The request object. Request message for - [UserLicenseService.ListUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.ListUserLicenses]. + `UserLicenseService.ListUserLicenses + `__. parent (str): - Required. The parent [UserStore][] resource name, - format: + Required. The parent [UserStore][] + resource name, format: ``projects/{project}/locations/{location}/userStores/{user_store_id}``. This corresponds to the ``parent`` field @@ -805,10 +806,12 @@ def sample_list_user_licenses(): Returns: google.cloud.discoveryengine_v1.services.user_license_service.pagers.ListUserLicensesPager: Response message for - [UserLicenseService.ListUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.ListUserLicenses]. + `UserLicenseService.ListUserLicenses + `__. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -919,7 +922,8 @@ def sample_batch_update_user_licenses(): Args: request (Union[google.cloud.discoveryengine_v1.types.BatchUpdateUserLicensesRequest, dict]): The request object. Request message for - [UserLicenseService.BatchUpdateUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.BatchUpdateUserLicenses] + `UserLicenseService.BatchUpdateUserLicenses + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -931,11 +935,15 @@ def sample_batch_update_user_licenses(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1.types.BatchUpdateUserLicensesResponse` Response message for - [UserLicenseService.BatchUpdateUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.BatchUpdateUserLicenses] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1.types.BatchUpdateUserLicensesResponse` + Response message for + `UserLicenseService.BatchUpdateUserLicenses + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/user_license_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/user_license_service/transports/rest.py index dd67d173a26e..a3f8225795d5 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/user_license_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/services/user_license_service/transports/rest.py @@ -585,7 +585,8 @@ def __call__( Args: request (~.user_license_service.BatchUpdateUserLicensesRequest): The request object. Request message for - [UserLicenseService.BatchUpdateUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.BatchUpdateUserLicenses] + `UserLicenseService.BatchUpdateUserLicenses + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -742,7 +743,8 @@ def __call__( Args: request (~.user_license_service.ListUserLicensesRequest): The request object. Request message for - [UserLicenseService.ListUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.ListUserLicenses]. + `UserLicenseService.ListUserLicenses + `__. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -754,7 +756,8 @@ def __call__( Returns: ~.user_license_service.ListUserLicensesResponse: Response message for - [UserLicenseService.ListUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.ListUserLicenses]. + `UserLicenseService.ListUserLicenses + `__. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/answer.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/answer.py index 39c29ccfbabd..ae7f0f53ec34 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/answer.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/answer.py @@ -45,8 +45,8 @@ class Answer(proto.Message): answer_text (str): The textual answer. grounding_score (float): - A score in the range of [0, 1] describing how grounded the - answer is by the reference chunks. + A score in the range of [0, 1] describing how + grounded the answer is by the reference chunks. This field is a member of `oneof`_ ``_grounding_score``. citations (MutableSequence[google.cloud.discoveryengine_v1.types.Answer.Citation]): @@ -233,17 +233,20 @@ class GroundingSupport(proto.Message): end_index (int): Required. End of the claim, exclusive. grounding_score (float): - A score in the range of [0, 1] describing how grounded is a - specific claim by the references. Higher value means that - the claim is better supported by the reference chunks. + A score in the range of [0, 1] describing how + grounded is a specific claim by the references. + Higher value means that the claim is better + supported by the reference chunks. This field is a member of `oneof`_ ``_grounding_score``. grounding_check_required (bool): - Indicates that this claim required grounding check. When the - system decided this claim didn't require - attribution/grounding check, this field is set to false. In - that case, no grounding check was done for the claim and - therefore ``grounding_score``, ``sources`` is not returned. + Indicates that this claim required grounding + check. When the system decided this claim didn't + require attribution/grounding check, this field + is set to false. In that case, no grounding + check was done for the claim and therefore + ``grounding_score``, ``sources`` is not + returned. This field is a member of `oneof`_ ``_grounding_check_required``. sources (MutableSequence[google.cloud.discoveryengine_v1.types.Answer.CitationSource]): @@ -597,11 +600,11 @@ class SearchResult(proto.Message): title (str): Title. snippet_info (MutableSequence[google.cloud.discoveryengine_v1.types.Answer.Step.Action.Observation.SearchResult.SnippetInfo]): - If citation_type is DOCUMENT_LEVEL_CITATION, populate - document level snippets. + If citation_type is DOCUMENT_LEVEL_CITATION, + populate document level snippets. chunk_info (MutableSequence[google.cloud.discoveryengine_v1.types.Answer.Step.Action.Observation.SearchResult.ChunkInfo]): - If citation_type is CHUNK_LEVEL_CITATION and chunk mode is - on, populate chunk info. + If citation_type is CHUNK_LEVEL_CITATION and + chunk mode is on, populate chunk info. struct_data (google.protobuf.struct_pb2.Struct): Data representation. The structured JSON data for the document. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/assist_answer.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/assist_answer.py index 3709ae87a66c..2d4b5d606c11 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/assist_answer.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/assist_answer.py @@ -31,15 +31,18 @@ class AssistAnswer(proto.Message): r"""AssistAnswer resource, main part of - [AssistResponse][google.cloud.discoveryengine.v1.AssistResponse]. + `AssistResponse + `__. Attributes: name (str): - Immutable. Resource name of the ``AssistAnswer``. Format: + Immutable. Resource name of the + ``AssistAnswer``. Format: + ``projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}`` - This field must be a UTF-8 encoded string with a length - limit of 1024 characters. + This field must be a UTF-8 encoded string with a + length limit of 1024 characters. state (google.cloud.discoveryengine_v1.types.AssistAnswer.State): State of the answer generation. replies (MutableSequence[google.cloud.discoveryengine_v1.types.AssistAnswer.Reply]): @@ -246,8 +249,8 @@ class Outcome(proto.Enum): OUTCOME_OK (1): Code execution completed successfully. OUTCOME_FAILED (2): - Code execution finished but with a failure. ``stderr`` - should contain the reason. + Code execution finished but with a failure. + ``stderr`` should contain the reason. OUTCOME_DEADLINE_EXCEEDED (3): Code execution ran for too long, and was cancelled. There may or may not be a partial @@ -409,10 +412,10 @@ class DocumentMetadata(proto.Message): This field is a member of `oneof`_ ``_page_identifier``. domain (str): - Domain name from the document URI. Note that the ``uri`` - field may contain a URL that redirects to the actual - website, in which case this will contain the domain name of - the target site. + Domain name from the document URI. Note that the + ``uri`` field may contain a URL that redirects + to the actual website, in which case this will + contain the domain name of the target site. This field is a member of `oneof`_ ``_domain``. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/assistant.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/assistant.py index 16f301e40e2c..42d90d8c4209 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/assistant.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/assistant.py @@ -32,11 +32,13 @@ class Assistant(proto.Message): Attributes: name (str): - Immutable. Resource name of the assistant. Format: + Immutable. Resource name of the assistant. + Format: + ``projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`` - It must be a UTF-8 encoded string with a length limit of - 1024 characters. + It must be a UTF-8 encoded string with a length + limit of 1024 characters. """ name: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/assistant_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/assistant_service.py index ccee1a3bff80..725473d2ba79 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/assistant_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/assistant_service.py @@ -59,31 +59,36 @@ class AssistUserMetadata(proto.Message): class StreamAssistRequest(proto.Message): r"""Request for the - [AssistantService.StreamAssist][google.cloud.discoveryengine.v1.AssistantService.StreamAssist] + `AssistantService.StreamAssist + `__ method. Attributes: name (str): Required. The resource name of the - [Assistant][google.cloud.discoveryengine.v1.Assistant]. + `Assistant + `__. Format: + ``projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`` query (google.cloud.discoveryengine_v1.types.Query): Optional. Current user query. - Empty query is only supported if ``file_ids`` are provided. - In this case, the answer will be generated based on those - context files. + Empty query is only supported if ``file_ids`` + are provided. In this case, the answer will be + generated based on those context files. session (str): - Optional. The session to use for the request. If specified, - the assistant has access to the session history, and the - query and the answer are stored there. + Optional. The session to use for the request. If + specified, the assistant has access to the + session history, and the query and the answer + are stored there. - If ``-`` is specified as the session ID, or it is left - empty, then a new session is created with an automatically - generated ID. + If ``-`` is specified as the session ID, or it + is left empty, then a new session is created + with an automatically generated ID. Format: + ``projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`` user_metadata (google.cloud.discoveryengine_v1.types.AssistUserMetadata): Optional. Information about the user @@ -104,9 +109,11 @@ class ToolsSpec(proto.Message): Optional. Specification of the Vertex AI Search tool. web_grounding_spec (google.cloud.discoveryengine_v1.types.StreamAssistRequest.ToolsSpec.WebGroundingSpec): - Optional. Specification of the web grounding tool. If field - is present, enables grounding with web search. Works only if - [Assistant.web_grounding_type][google.cloud.discoveryengine.v1.Assistant.web_grounding_type] + Optional. Specification of the web grounding + tool. If field is present, enables grounding + with web search. Works only if + `Assistant.web_grounding_type + `__ is [WEB_GROUNDING_TYPE_GOOGLE_SEARCH][] or [WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH][]. image_generation_spec (google.cloud.discoveryengine_v1.types.StreamAssistRequest.ToolsSpec.ImageGenerationSpec): @@ -123,30 +130,35 @@ class VertexAiSearchSpec(proto.Message): Attributes: data_store_specs (MutableSequence[google.cloud.discoveryengine_v1.types.SearchRequest.DataStoreSpec]): Optional. Specs defining - [DataStore][google.cloud.discoveryengine.v1.DataStore]s to - filter on in a search call and configurations for those data - stores. This is only considered for - [Engine][google.cloud.discoveryengine.v1.Engine]s with - multiple data stores. + `DataStore + `__s + to filter on in a search call and configurations + for those data stores. This is only considered + for `Engine + `__s + with multiple data stores. filter (str): - Optional. The filter syntax consists of an expression - language for constructing a predicate from one or more - fields of the documents being filtered. Filter expression is - case-sensitive. - - If this field is unrecognizable, an ``INVALID_ARGUMENT`` is - returned. - - Filtering in Vertex AI Search is done by mapping the LHS - filter key to a key property defined in the Vertex AI Search - backend -- this mapping is defined by the customer in their - schema. For example a media customer might have a field - 'name' in their schema. In this case the filter would look - like this: filter --> name:'ANY("king kong")' - - For more information about filtering including syntax and - filter operators, see - `Filter `__ + Optional. The filter syntax consists of an + expression language for constructing a predicate + from one or more fields of the documents being + filtered. Filter expression is case-sensitive. + + If this field is unrecognizable, an + ``INVALID_ARGUMENT`` is returned. + + Filtering in Vertex AI Search is done by mapping + the LHS filter key to a key property defined in + the Vertex AI Search backend -- this mapping is + defined by the customer in their schema. For + example a media customer might have a field + 'name' in their schema. In this case the filter + would look like this: filter --> name:'ANY("king + kong")' + + For more information about filtering including + syntax and filter operators, see + `Filter + `__ """ data_store_specs: MutableSequence[ @@ -206,8 +218,9 @@ class GenerationSpec(proto.Message): Attributes: model_id (str): - Optional. The Vertex AI model_id used for the generative - model. If not set, the default Assistant model will be used. + Optional. The Vertex AI model_id used for the + generative model. If not set, the default + Assistant model will be used. """ model_id: str = proto.Field( @@ -247,30 +260,36 @@ class GenerationSpec(proto.Message): class StreamAssistResponse(proto.Message): r"""Response for the - [AssistantService.StreamAssist][google.cloud.discoveryengine.v1.AssistantService.StreamAssist] + `AssistantService.StreamAssist + `__ method. Attributes: answer (google.cloud.discoveryengine_v1.types.AssistAnswer): - Assist answer resource object containing parts of the - assistant's final answer for the user's query. + Assist answer resource object containing parts + of the assistant's final answer for the user's + query. - Not present if the current response doesn't add anything to - previously sent - [AssistAnswer.replies][google.cloud.discoveryengine.v1.AssistAnswer.replies]. + Not present if the current response doesn't add + anything to previously sent + `AssistAnswer.replies + `__. Observe - [AssistAnswer.state][google.cloud.discoveryengine.v1.AssistAnswer.state] - to see if more parts are to be expected. While the state is - ``IN_PROGRESS``, the - [AssistAnswer.replies][google.cloud.discoveryengine.v1.AssistAnswer.replies] - field in each response will contain replies (reply - fragments) to be appended to the ones received in previous - responses. [AssistAnswer.name][] won't be filled. - - If the state is ``SUCCEEDED``, ``FAILED`` or ``SKIPPED``, - the response is the last response and [AssistAnswer.name][] - will have a value. + `AssistAnswer.state + `__ + to see if more parts are to be expected. While + the state is ``IN_PROGRESS``, the + `AssistAnswer.replies + `__ + field in each response will contain replies + (reply fragments) to be appended to the ones + received in previous responses. + [AssistAnswer.name][] won't be filled. + + If the state is ``SUCCEEDED``, ``FAILED`` or + ``SKIPPED``, the response is the last response + and [AssistAnswer.name][] will have a value. session_info (google.cloud.discoveryengine_v1.types.StreamAssistResponse.SessionInfo): Session information. assist_token (str): @@ -284,9 +303,10 @@ class SessionInfo(proto.Message): Attributes: session (str): - Name of the newly generated or continued session. - + Name of the newly generated or continued + session. Format: + ``projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}``. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/chunk.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/chunk.py index c476c9ea4e8f..07d06b1bb7f6 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/chunk.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/chunk.py @@ -37,39 +37,47 @@ class Chunk(proto.Message): Attributes: name (str): - The full resource name of the chunk. Format: + The full resource name of the chunk. + Format: + ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}``. - This field must be a UTF-8 encoded string with a length - limit of 1024 characters. + This field must be a UTF-8 encoded string with a + length limit of 1024 characters. id (str): Unique chunk ID of the current chunk. content (str): Content is a string from a document (parsed content). relevance_score (float): - Output only. Represents the relevance score based on - similarity. Higher score indicates higher chunk relevance. - The score is in range [-1.0, 1.0]. Only populated on - [SearchResponse][google.cloud.discoveryengine.v1.SearchResponse]. + Output only. Represents the relevance score + based on similarity. Higher score indicates + higher chunk relevance. The score is in range + [-1.0, 1.0]. + Only populated on + `SearchResponse + `__. This field is a member of `oneof`_ ``_relevance_score``. document_metadata (google.cloud.discoveryengine_v1.types.Chunk.DocumentMetadata): Metadata of the document from the current chunk. derived_struct_data (google.protobuf.struct_pb2.Struct): - Output only. This field is OUTPUT_ONLY. It contains derived - data that are not in the original input document. + Output only. This field is OUTPUT_ONLY. + It contains derived data that are not in the + original input document. page_span (google.cloud.discoveryengine_v1.types.Chunk.PageSpan): Page span of the chunk. chunk_metadata (google.cloud.discoveryengine_v1.types.Chunk.ChunkMetadata): Output only. Metadata of the current chunk. data_urls (MutableSequence[str]): - Output only. Image Data URLs if the current chunk contains - images. Data URLs are composed of four parts: a prefix - (data:), a MIME type indicating the type of data, an - optional base64 token if non-textual, and the data itself: - data:[][;base64], + Output only. Image Data URLs if the current + chunk contains images. Data URLs are composed of + four parts: a prefix (data:), a MIME type + indicating the type of data, an optional base64 + token if non-textual, and the data itself: + + data:` <;base64>`__, annotation_contents (MutableSequence[str]): Output only. Annotation contents if the current chunk contains annotations. @@ -107,10 +115,11 @@ class DocumentMetadata(proto.Message): title (str): Title of the document. struct_data (google.protobuf.struct_pb2.Struct): - Data representation. The structured JSON data for the - document. It should conform to the registered - [Schema][google.cloud.discoveryengine.v1.Schema] or an - ``INVALID_ARGUMENT`` error is thrown. + Data representation. + The structured JSON data for the document. It + should conform to the registered `Schema + `__ or + an ``INVALID_ARGUMENT`` error is thrown. """ uri: str = proto.Field( @@ -148,23 +157,27 @@ class PageSpan(proto.Message): class ChunkMetadata(proto.Message): r"""Metadata of the current chunk. This field is only populated on - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] - API. + `SearchService.Search + `__ API. Attributes: previous_chunks (MutableSequence[google.cloud.discoveryengine_v1.types.Chunk]): - The previous chunks of the current chunk. The number is - controlled by - [SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks]. + The previous chunks of the current chunk. The + number is controlled by + `SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks + `__. This field is only populated on - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] + `SearchService.Search + `__ API. next_chunks (MutableSequence[google.cloud.discoveryengine_v1.types.Chunk]): - The next chunks of the current chunk. The number is - controlled by - [SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks]. + The next chunks of the current chunk. The number + is controlled by + `SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks + `__. This field is only populated on - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] + `SearchService.Search + `__ API. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/cmek_config_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/cmek_config_service.py index 378cd38ad0b7..de8b823f8ce0 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/cmek_config_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/cmek_config_service.py @@ -66,14 +66,16 @@ class GetCmekConfigRequest(proto.Message): Attributes: name (str): Required. Resource name of - [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig], + `CmekConfig + `__, such as ``projects/*/locations/*/cmekConfig`` or ``projects/*/locations/*/cmekConfigs/*``. - If the caller does not have permission to access the - [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. + If the caller does not have permission to access + the `CmekConfig + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. """ name: str = proto.Field( @@ -87,8 +89,8 @@ class SingleRegionKey(proto.Message): Attributes: kms_key (str): - Required. Single-regional kms key resource name which will - be used to encrypt resources + Required. Single-regional kms key resource name + which will be used to encrypt resources ``projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}``. """ @@ -105,15 +107,17 @@ class CmekConfig(proto.Message): Attributes: name (str): Required. The name of the CmekConfig of the form - ``projects/{project}/locations/{location}/cmekConfig`` or + ``projects/{project}/locations/{location}/cmekConfig`` + or ``projects/{project}/locations/{location}/cmekConfigs/{cmek_config}``. kms_key (str): - KMS key resource name which will be used to encrypt - resources + KMS key resource name which will be used to + encrypt resources ``projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}``. kms_key_version (str): - KMS key version resource name which will be used to encrypt - resources ``/cryptoKeyVersions/{keyVersion}``. + KMS key version resource name which will be used + to encrypt resources + ``/cryptoKeyVersions/{keyVersion}``. state (google.cloud.discoveryengine_v1.types.CmekConfig.State): Output only. The states of the CmekConfig. is_default (bool): @@ -223,7 +227,8 @@ class NotebookLMState(proto.Enum): class UpdateCmekConfigMetadata(proto.Message): r"""Metadata related to the progress of the - [CmekConfigService.UpdateCmekConfig][google.cloud.discoveryengine.v1.CmekConfigService.UpdateCmekConfig] + `CmekConfigService.UpdateCmekConfig + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -249,18 +254,22 @@ class UpdateCmekConfigMetadata(proto.Message): class ListCmekConfigsRequest(proto.Message): r"""Request message for - [CmekConfigService.ListCmekConfigs][google.cloud.discoveryengine.v1.CmekConfigService.ListCmekConfigs] + `CmekConfigService.ListCmekConfigs + `__ method. Attributes: parent (str): - Required. The parent location resource name, such as + Required. The parent location resource name, + such as ``projects/{project}/locations/{location}``. If the caller does not have permission to list - [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig]s - under this location, regardless of whether or not a - CmekConfig exists, a PERMISSION_DENIED error is returned. + `CmekConfig + `__s + under this location, regardless of whether or + not a CmekConfig exists, a PERMISSION_DENIED + error is returned. """ parent: str = proto.Field( @@ -271,13 +280,15 @@ class ListCmekConfigsRequest(proto.Message): class ListCmekConfigsResponse(proto.Message): r"""Response message for - [CmekConfigService.ListCmekConfigs][google.cloud.discoveryengine.v1.CmekConfigService.ListCmekConfigs] + `CmekConfigService.ListCmekConfigs + `__ method. Attributes: cmek_configs (MutableSequence[google.cloud.discoveryengine_v1.types.CmekConfig]): All the customer's - [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig]s. + `CmekConfig + `__s. """ cmek_configs: MutableSequence["CmekConfig"] = proto.RepeatedField( @@ -289,14 +300,16 @@ class ListCmekConfigsResponse(proto.Message): class DeleteCmekConfigRequest(proto.Message): r"""Request message for - [CmekConfigService.DeleteCmekConfig][google.cloud.discoveryengine.v1.CmekConfigService.DeleteCmekConfig] + `CmekConfigService.DeleteCmekConfig + `__ method. Attributes: name (str): Required. The resource name of the - [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig] to - delete, such as + `CmekConfig + `__ + to delete, such as ``projects/{project}/locations/{location}/cmekConfigs/{cmek_config}``. """ @@ -308,7 +321,8 @@ class DeleteCmekConfigRequest(proto.Message): class DeleteCmekConfigMetadata(proto.Message): r"""Metadata related to the progress of the - [CmekConfigService.DeleteCmekConfig][google.cloud.discoveryengine.v1.CmekConfigService.DeleteCmekConfig] + `CmekConfigService.DeleteCmekConfig + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/common.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/common.py index ee09c5fad591..22e7596b13f5 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/common.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/common.py @@ -40,7 +40,7 @@ class IndustryVertical(proto.Enum): r"""The industry vertical associated with the - [DataStore][google.cloud.discoveryengine.v1.DataStore]. + `DataStore `__. Values: INDUSTRY_VERTICAL_UNSPECIFIED (0): @@ -73,10 +73,10 @@ class SolutionType(proto.Enum): Used for use cases related to the Generative AI agent. SOLUTION_TYPE_GENERATIVE_CHAT (4): - Used for use cases related to the Generative Chat agent. - It's used for Generative chat engine only, the associated - data stores must enrolled with ``SOLUTION_TYPE_CHAT`` - solution. + Used for use cases related to the Generative + Chat agent. It's used for Generative chat engine + only, the associated data stores must enrolled + with ``SOLUTION_TYPE_CHAT`` solution. """ SOLUTION_TYPE_UNSPECIFIED = 0 SOLUTION_TYPE_RECOMMENDATION = 1 @@ -86,19 +86,22 @@ class SolutionType(proto.Enum): class SearchUseCase(proto.Enum): - r"""Defines a further subdivision of ``SolutionType``. Specifically - applies to - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH]. + r"""Defines a further subdivision of ``SolutionType``. + Specifically applies to + `SOLUTION_TYPE_SEARCH + `__. Values: SEARCH_USE_CASE_UNSPECIFIED (0): Value used when unset. Will not occur in CSS. SEARCH_USE_CASE_SEARCH (1): - Search use case. Expects the traffic has a non-empty - [query][google.cloud.discoveryengine.v1.SearchRequest.query]. + Search use case. Expects the traffic has a + non-empty `query + `__. SEARCH_USE_CASE_BROWSE (2): - Browse use case. Expects the traffic has an empty - [query][google.cloud.discoveryengine.v1.SearchRequest.query]. + Browse use case. Expects the traffic has an + empty `query + `__. """ SEARCH_USE_CASE_UNSPECIFIED = 0 SEARCH_USE_CASE_SEARCH = 1 @@ -191,32 +194,38 @@ class Interval(proto.Message): class CustomAttribute(proto.Message): r"""A custom attribute that is not explicitly modeled in a resource, - e.g. [UserEvent][google.cloud.discoveryengine.v1.UserEvent]. + e.g. `UserEvent `__. Attributes: text (MutableSequence[str]): - The textual values of this custom attribute. For example, - ``["yellow", "green"]`` when the key is "color". + The textual values of this custom attribute. For + example, ``["yellow", "green"]`` when the key is + "color". Empty string is not allowed. Otherwise, an ``INVALID_ARGUMENT`` error is returned. Exactly one of - [CustomAttribute.text][google.cloud.discoveryengine.v1.CustomAttribute.text] + `CustomAttribute.text + `__ or - [CustomAttribute.numbers][google.cloud.discoveryengine.v1.CustomAttribute.numbers] - should be set. Otherwise, an ``INVALID_ARGUMENT`` error is - returned. + `CustomAttribute.numbers + `__ + should be set. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. numbers (MutableSequence[float]): - The numerical values of this custom attribute. For example, - ``[2.3, 15.4]`` when the key is "lengths_cm". + The numerical values of this custom attribute. + For example, ``[2.3, 15.4]`` when the key is + "lengths_cm". Exactly one of - [CustomAttribute.text][google.cloud.discoveryengine.v1.CustomAttribute.text] + `CustomAttribute.text + `__ or - [CustomAttribute.numbers][google.cloud.discoveryengine.v1.CustomAttribute.numbers] - should be set. Otherwise, an ``INVALID_ARGUMENT`` error is - returned. + `CustomAttribute.numbers + `__ + should be set. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. """ text: MutableSequence[str] = proto.RepeatedField( @@ -234,31 +243,35 @@ class UserInfo(proto.Message): Attributes: user_id (str): - Highly recommended for logged-in users. Unique identifier - for logged-in user, such as a user name. Don't set for - anonymous users. + Highly recommended for logged-in users. Unique + identifier for logged-in user, such as a user + name. Don't set for anonymous users. Always use a hashed value for this ID. - Don't set the field to the same fixed ID for different - users. This mixes the event history of those users together, - which results in degraded model quality. + Don't set the field to the same fixed ID for + different users. This mixes the event history of + those users together, which results in degraded + model quality. - The field must be a UTF-8 encoded string with a length limit - of 128 characters. Otherwise, an ``INVALID_ARGUMENT`` error - is returned. + The field must be a UTF-8 encoded string with a + length limit of 128 characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. user_agent (str): User agent as included in the HTTP header. - The field must be a UTF-8 encoded string with a length limit - of 1,000 characters. Otherwise, an ``INVALID_ARGUMENT`` - error is returned. + The field must be a UTF-8 encoded string with a + length limit of 1,000 characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. - This should not be set when using the client side event - reporting with GTM or JavaScript tag in - [UserEventService.CollectUserEvent][google.cloud.discoveryengine.v1.UserEventService.CollectUserEvent] + This should not be set when using the client + side event reporting with GTM or JavaScript tag + in + `UserEventService.CollectUserEvent + `__ or if - [UserEvent.direct_user_request][google.cloud.discoveryengine.v1.UserEvent.direct_user_request] + `UserEvent.direct_user_request + `__ is set. time_zone (str): Optional. IANA time zone, e.g. @@ -305,18 +318,21 @@ class Principal(proto.Message): Attributes: user_id (str): - User identifier. For Google Workspace user account, user_id - should be the google workspace user email. For non-google - identity provider user account, user_id is the mapped user - identifier configured during the workforcepool config. + User identifier. + For Google Workspace user account, user_id + should be the google workspace user email. + For non-google identity provider user account, + user_id is the mapped user identifier configured + during the workforcepool config. This field is a member of `oneof`_ ``principal``. group_id (str): - Group identifier. For Google Workspace user account, - group_id should be the google workspace group email. For - non-google identity provider user account, group_id is the - mapped group identifier configured during the workforcepool - config. + Group identifier. + For Google Workspace user account, group_id + should be the google workspace group email. + For non-google identity provider user account, + group_id is the mapped group identifier + configured during the workforcepool config. This field is a member of `oneof`_ ``principal``. external_entity_id (str): @@ -350,16 +366,17 @@ class HealthcareFhirConfig(proto.Message): enable_configurable_schema (bool): Whether to enable configurable schema for ``HEALTHCARE_FHIR`` vertical. - - If set to ``true``, the predefined healthcare fhir schema - can be extended for more customized searching and filtering. + If set to ``true``, the predefined healthcare + fhir schema can be extended for more customized + searching and filtering. enable_static_indexing_for_batch_ingestion (bool): - Whether to enable static indexing for ``HEALTHCARE_FHIR`` - batch ingestion. + Whether to enable static indexing for + ``HEALTHCARE_FHIR`` batch ingestion. - If set to ``true``, the batch ingestion will be processed in - a static indexing mode which is slower but more capable of - handling larger volume. + If set to ``true``, the batch ingestion will be + processed in a static indexing mode which is + slower but more capable of handling larger + volume. """ enable_configurable_schema: bool = proto.Field( @@ -385,10 +402,11 @@ class SearchLinkPromotion(proto.Message): to promote. Must be set for site search. For other verticals, this is optional. document (str): - Optional. The - [Document][google.cloud.discoveryengine.v1.Document] the - user wants to promote. For site search, leave unset and only - populate uri. Can be set along with uri. + Optional. The `Document + `__ + the user wants to promote. For site search, + leave unset and only populate uri. Can be set + along with uri. image_uri (str): Optional. The promotion thumbnail image url. description (str): diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/completion.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/completion.py index f7f45960f38e..5f080bdbe0cb 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/completion.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/completion.py @@ -49,10 +49,11 @@ class MatchOperator(proto.Enum): MATCH_OPERATOR_UNSPECIFIED (0): Default value. Should not be used EXACT_MATCH (1): - If the suggestion is an exact match to the block_phrase, - then block it. + If the suggestion is an exact match to the + block_phrase, then block it. CONTAINS (2): - If the suggestion contains the block_phrase, then block it. + If the suggestion contains the block_phrase, + then block it. """ MATCH_OPERATOR_UNSPECIFIED = 0 EXACT_MATCH = 1 diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/completion_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/completion_service.py index d4c75d5e46c4..c610525dd280 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/completion_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/completion_service.py @@ -30,58 +30,65 @@ class CompleteQueryRequest(proto.Message): r"""Request message for - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1.CompletionService.CompleteQuery] + `CompletionService.CompleteQuery + `__ method. Attributes: data_store (str): - Required. The parent data store resource name for which the - completion is performed, such as + Required. The parent data store resource name + for which the completion is performed, such as ``projects/*/locations/global/collections/default_collection/dataStores/default_data_store``. query (str): Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. query_model (str): - Specifies the autocomplete data model. This overrides any - model specified in the Configuration > Autocomplete section - of the Cloud console. Currently supported values: - - - ``document`` - Using suggestions generated from - user-imported documents. - - ``search-history`` - Using suggestions generated from the - past history of - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] - API calls. Do not use it when there is no traffic for - Search API. - - ``user-event`` - Using suggestions generated from - user-imported search events. - - ``document-completable`` - Using suggestions taken - directly from user-imported document fields marked as - completable. + Specifies the autocomplete data model. This + overrides any model specified in the + Configuration > Autocomplete section of the + Cloud console. Currently supported values: + + * ``document`` - Using suggestions generated + from user-imported documents. * + ``search-history`` - Using suggestions generated + from the past history of `SearchService.Search + `__ + API calls. Do not use it when there is no + traffic for Search API. + + * ``user-event`` - Using suggestions generated + from user-imported search events. + + * ``document-completable`` - Using suggestions + taken directly from user-imported document + fields marked as completable. Default values: - - ``document`` is the default model for regular dataStores. - - ``search-history`` is the default model for site search - dataStores. + * ``document`` is the default model for regular + dataStores. * ``search-history`` is the default + model for site search dataStores. user_pseudo_id (str): - A unique identifier for tracking visitors. For example, this - could be implemented with an HTTP cookie, which should be - able to uniquely identify a visitor on a single device. This - unique identifier should not change if the visitor logs in - or out of the website. + A unique identifier for tracking visitors. For + example, this could be implemented with an HTTP + cookie, which should be able to uniquely + identify a visitor on a single device. This + unique identifier should not change if the + visitor logs in or out of the website. This field should NOT have a fixed value such as ``unknown_visitor``. This should be the same identifier as - [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id] + `UserEvent.user_pseudo_id + `__ and - [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1.SearchRequest.user_pseudo_id]. + `SearchRequest.user_pseudo_id + `__. - The field must be a UTF-8 encoded string with a length limit - of 128 characters. Otherwise, an ``INVALID_ARGUMENT`` error - is returned. + The field must be a UTF-8 encoded string with a + length limit of 128 characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. include_tail_suggestions (bool): Indicates if tail suggestions should be returned if there are no suggestions that match @@ -115,7 +122,8 @@ class CompleteQueryRequest(proto.Message): class CompleteQueryResponse(proto.Message): r"""Response message for - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1.CompletionService.CompleteQuery] + `CompletionService.CompleteQuery + `__ method. Attributes: @@ -124,11 +132,12 @@ class CompleteQueryResponse(proto.Message): result list is ordered and the first result is a top suggestion. tail_match_triggered (bool): - True if the returned suggestions are all tail suggestions. - - For tail matching to be triggered, include_tail_suggestions - in the request must be true and there must be no suggestions - that match the full query. + True if the returned suggestions are all tail + suggestions. + For tail matching to be triggered, + include_tail_suggestions in the request must be + true and there must be no suggestions that match + the full query. """ class QuerySuggestion(proto.Message): diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/control.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/control.py index 8d8b1e4a4bf0..f3abb1cdb514 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/control.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/control.py @@ -37,9 +37,11 @@ class Condition(proto.Message): Attributes: query_terms (MutableSequence[google.cloud.discoveryengine_v1.types.Condition.QueryTerm]): - Search only A list of terms to match the query on. Cannot be - set when - [Condition.query_regex][google.cloud.discoveryengine.v1.Condition.query_regex] + Search only + A list of terms to match the query on. + Cannot be set when + `Condition.query_regex + `__ is set. Maximum of 10 query terms. @@ -48,11 +50,12 @@ class Condition(proto.Message): active. Maximum of 10 time ranges. query_regex (str): - Optional. Query regex to match the whole search query. - Cannot be set when - [Condition.query_terms][google.cloud.discoveryengine.v1.Condition.query_terms] - is set. Only supported for Basic Site Search promotion - serving controls. + Optional. Query regex to match the whole search + query. Cannot be set when + `Condition.query_terms + `__ + is set. Only supported for Basic Site Search + promotion serving controls. """ class QueryTerm(proto.Message): @@ -62,9 +65,10 @@ class QueryTerm(proto.Message): value (str): The specific query value to match against - Must be lowercase, must be UTF-8. Can have at most 3 space - separated terms if full_match is true. Cannot be an empty - string. Maximum length of 5000 characters. + Must be lowercase, must be UTF-8. + Can have at most 3 space separated terms if + full_match is true. Cannot be an empty string. + Maximum length of 5000 characters. full_match (bool): Whether the search query needs to exactly match the query term. @@ -122,9 +126,10 @@ class TimeRange(proto.Message): class Control(proto.Message): - r"""Defines a conditioned behavior to employ during serving. Must be - attached to a - [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] to be + r"""Defines a conditioned behavior to employ during serving. + Must be attached to a + `ServingConfig + `__ to be considered at serving time. Permitted actions dependent on ``SolutionType``. @@ -170,21 +175,25 @@ class Control(proto.Message): error is thrown. associated_serving_config_ids (MutableSequence[str]): Output only. List of all - [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] - IDs this control is attached to. May take up to 10 minutes - to update after changes. + `ServingConfig + `__ + IDs this control is attached to. May take up to + 10 minutes to update after changes. solution_type (google.cloud.discoveryengine_v1.types.SolutionType): Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. use_cases (MutableSequence[google.cloud.discoveryengine_v1.types.SearchUseCase]): - Specifies the use case for the control. Affects what - condition fields can be set. Only applies to - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH]. - Currently only allow one use case per control. Must be set - when solution_type is - [SolutionType.SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH]. + Specifies the use case for the control. + Affects what condition fields can be set. + Only applies to + `SOLUTION_TYPE_SEARCH + `__. + Currently only allow one use case per control. + Must be set when solution_type is + `SolutionType.SOLUTION_TYPE_SEARCH + `__. conditions (MutableSequence[google.cloud.discoveryengine_v1.types.Condition]): Determines when the associated action will trigger. @@ -206,8 +215,9 @@ class BoostAction(proto.Message): Attributes: fixed_boost (float): - Optional. Strength of the boost, which should be in [-1, 1]. - Negative boost means demotion. Default is 0.0 (No-op). + Optional. Strength of the boost, which should be + in [-1, 1]. Negative boost means demotion. + Default is 0.0 (No-op). This field is a member of `oneof`_ ``boost_spec``. interpolation_boost_spec (google.cloud.discoveryengine_v1.types.Control.BoostAction.InterpolationBoostSpec): @@ -217,8 +227,9 @@ class BoostAction(proto.Message): This field is a member of `oneof`_ ``boost_spec``. boost (float): - Strength of the boost, which should be in [-1, 1]. Negative - boost means demotion. Default is 0.0 (No-op). + Strength of the boost, which should be in [-1, + 1]. Negative boost means demotion. Default is + 0.0 (No-op). filter (str): Required. Specifies which products to apply the boost to. @@ -229,8 +240,9 @@ class BoostAction(proto.Message): Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. data_store (str): - Required. Specifies which data store's documents can be - boosted by this control. Full data store name e.g. + Required. Specifies which data store's documents + can be boosted by this control. Full data store + name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store """ @@ -244,20 +256,23 @@ class InterpolationBoostSpec(proto.Message): Optional. The name of the field whose value will be used to determine the boost amount. attribute_type (google.cloud.discoveryengine_v1.types.Control.BoostAction.InterpolationBoostSpec.AttributeType): - Optional. The attribute type to be used to determine the - boost amount. The attribute value can be derived from the - field value of the specified field_name. In the case of - numerical it is straightforward i.e. attribute_value = - numerical_field_value. In the case of freshness however, - attribute_value = (time.now() - datetime_field_value). + Optional. The attribute type to be used to + determine the boost amount. The attribute value + can be derived from the field value of the + specified field_name. In the case of numerical + it is straightforward i.e. attribute_value = + numerical_field_value. In the case of freshness + however, attribute_value = (time.now() - + datetime_field_value). interpolation_type (google.cloud.discoveryengine_v1.types.Control.BoostAction.InterpolationBoostSpec.InterpolationType): Optional. The interpolation type to be applied to connect the control points listed below. control_points (MutableSequence[google.cloud.discoveryengine_v1.types.Control.BoostAction.InterpolationBoostSpec.ControlPoint]): - Optional. The control points used to define the curve. The - monotonic function (defined through the interpolation_type - above) passes through the control points listed here. + Optional. The control points used to define the + curve. The monotonic function (defined through + the interpolation_type above) passes through the + control points listed here. """ class AttributeType(proto.Enum): @@ -268,19 +283,21 @@ class AttributeType(proto.Enum): ATTRIBUTE_TYPE_UNSPECIFIED (0): Unspecified AttributeType. NUMERICAL (1): - The value of the numerical field will be used to dynamically - update the boost amount. In this case, the attribute_value - (the x value) of the control point will be the actual value - of the numerical field for which the boost_amount is + The value of the numerical field will be used to + dynamically update the boost amount. In this + case, the attribute_value (the x value) of the + control point will be the actual value of the + numerical field for which the boost_amount is specified. FRESHNESS (2): - For the freshness use case the attribute value will be the - duration between the current time and the date in the - datetime field specified. The value must be formatted as an - XSD ``dayTimeDuration`` value (a restricted subset of an ISO - 8601 duration value). The pattern for this is: - ``[nD][T[nH][nM][nS]]``. For example, ``5D``, ``3DT12H30M``, - ``T24H``. + For the freshness use case the attribute value + will be the duration between the current time + and the date in the datetime field specified. + The value must be formatted as an XSD + ``dayTimeDuration`` value (a restricted subset + of an ISO 8601 duration value). The pattern for + this is: ```nD `__`nM `__]``. For + example, ``5D``, ``3DT12H30M``, ``T24H``. """ ATTRIBUTE_TYPE_UNSPECIFIED = 0 NUMERICAL = 1 @@ -311,14 +328,16 @@ class ControlPoint(proto.Message): Optional. Can be one of: 1. The numerical field value. - 2. The duration spec for freshness: The value must be - formatted as an XSD ``dayTimeDuration`` value (a - restricted subset of an ISO 8601 duration value). The - pattern for this is: ``[nD][T[nH][nM][nS]]``. + 2. The duration spec for freshness: + + The value must be formatted as an XSD + ``dayTimeDuration`` value (a restricted subset + of an ISO 8601 duration value). The pattern for + this is: ```nD `__`nM `__]``. boost_amount (float): - Optional. The value between -1 to 1 by which to boost the - score if the attribute_value evaluates to the value - specified above. + Optional. The value between -1 to 1 by which to + boost the score if the attribute_value evaluates + to the value specified above. """ attribute_value: str = proto.Field( @@ -393,8 +412,9 @@ class FilterAction(proto.Message): Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. data_store (str): - Required. Specifies which data store's documents can be - filtered by this control. Full data store name e.g. + Required. Specifies which data store's documents + can be filtered by this control. Full data store + name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/control_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/control_service.py index b32fe3220982..a85138d16767 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/control_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/control_service.py @@ -40,18 +40,20 @@ class CreateControlRequest(proto.Message): Attributes: parent (str): - Required. Full resource name of parent data store. Format: + Required. Full resource name of parent data + store. Format: ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`` or ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. control (google.cloud.discoveryengine_v1.types.Control): Required. The Control to create. control_id (str): - Required. The ID to use for the Control, which will become - the final component of the Control's resource name. + Required. The ID to use for the Control, which + will become the final component of the Control's + resource name. - This value must be within 1-63 characters. Valid characters - are /[a-z][0-9]-\_/. + This value must be within 1-63 characters. + Valid characters are /`a-z <0-9>`__-_/. """ parent: str = proto.Field( @@ -77,13 +79,17 @@ class UpdateControlRequest(proto.Message): Required. The Control to update. update_mask (google.protobuf.field_mask_pb2.FieldMask): Optional. Indicates which fields in the provided - [Control][google.cloud.discoveryengine.v1.Control] to + `Control + `__ to update. The following are NOT supported: - - [Control.name][google.cloud.discoveryengine.v1.Control.name] - - [Control.solution_type][google.cloud.discoveryengine.v1.Control.solution_type] + * `Control.name + `__ + * `Control.solution_type + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported fields are + updated. """ control: gcd_control.Control = proto.Field( @@ -103,8 +109,8 @@ class DeleteControlRequest(proto.Message): Attributes: name (str): - Required. The resource name of the Control to delete. - Format: + Required. The resource name of the Control to + delete. Format: ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`` """ @@ -119,7 +125,8 @@ class GetControlRequest(proto.Message): Attributes: name (str): - Required. The resource name of the Control to get. Format: + Required. The resource name of the Control to + get. Format: ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`` """ @@ -144,15 +151,15 @@ class ListControlsRequest(proto.Message): allowed value is 1000. page_token (str): Optional. A page token, received from a previous - ``ListControls`` call. Provide this to retrieve the - subsequent page. + ``ListControls`` call. Provide this to retrieve + the subsequent page. filter (str): - Optional. A filter to apply on the list results. Supported - features: - - - List all the products under the parent branch if - [filter][google.cloud.discoveryengine.v1.ListControlsRequest.filter] - is unset. Currently this field is unsupported. + Optional. A filter to apply on the list results. + Supported features: + * List all the products under the parent branch + if `filter + `__ + is unset. Currently this field is unsupported. """ parent: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/conversational_search_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/conversational_search_service.py index d12fbaea8277..44b27332d060 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/conversational_search_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/conversational_search_service.py @@ -51,24 +51,28 @@ class ConverseConversationRequest(proto.Message): r"""Request message for - [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1.ConversationalSearchService.ConverseConversation] + `ConversationalSearchService.ConverseConversation + `__ method. Attributes: name (str): - Required. The resource name of the Conversation to get. - Format: + Required. The resource name of the Conversation + to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}``. Use ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-`` - to activate auto session mode, which automatically creates a - new conversation inside a ConverseConversation session. + to activate auto session mode, which + automatically creates a new conversation inside + a ConverseConversation session. query (google.cloud.discoveryengine_v1.types.TextInput): Required. Current user input. serving_config (str): - The resource name of the Serving Config to use. Format: + The resource name of the Serving Config to use. + Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`` - If this is not set, the default serving config will be used. + If this is not set, the default serving config + will be used. conversation (google.cloud.discoveryengine_v1.types.Conversation): The conversation to be used by auto session only. The name field will be ignored as we @@ -77,55 +81,66 @@ class ConverseConversationRequest(proto.Message): safe_search (bool): Whether to turn on safe search. user_labels (MutableMapping[str, str]): - The user labels applied to a resource must meet the - following requirements: - - - Each resource can have multiple labels, up to a maximum of - 64. - - Each label must be a key-value pair. - - Keys have a minimum length of 1 character and a maximum - length of 63 characters and cannot be empty. Values can be - empty and have a maximum length of 63 characters. - - Keys and values can contain only lowercase letters, - numeric characters, underscores, and dashes. All - characters must use UTF-8 encoding, and international - characters are allowed. - - The key portion of a label must be unique. However, you - can use the same key with multiple resources. - - Keys must start with a lowercase letter or international - character. + The user labels applied to a resource must meet + the following requirements: + * Each resource can have multiple labels, up to + a maximum of 64. + + * Each label must be a key-value pair. + * Keys have a minimum length of 1 character and + a maximum length of 63 characters and cannot + be empty. Values can be empty and have a maximum + length of 63 characters. + + * Keys and values can contain only lowercase + letters, numeric characters, underscores, and + dashes. All characters must use UTF-8 encoding, + and international characters are allowed. + + * The key portion of a label must be unique. + However, you can use the same key with + multiple resources. + + * Keys must start with a lowercase letter or + international character. See `Google Cloud - Document `__ + Document + `__ for more details. summary_spec (google.cloud.discoveryengine_v1.types.SearchRequest.ContentSearchSpec.SummarySpec): A specification for configuring the summary returned in the response. filter (str): - The filter syntax consists of an expression language for - constructing a predicate from one or more fields of the - documents being filtered. Filter expression is - case-sensitive. This will be used to filter search results - which may affect the summary response. - - If this field is unrecognizable, an ``INVALID_ARGUMENT`` is - returned. - - Filtering in Vertex AI Search is done by mapping the LHS - filter key to a key property defined in the Vertex AI Search - backend -- this mapping is defined by the customer in their - schema. For example a media customer might have a field - 'name' in their schema. In this case the filter would look - like this: filter --> name:'ANY("king kong")' - - For more information about filtering including syntax and - filter operators, see - `Filter `__ + The filter syntax consists of an expression + language for constructing a predicate from one + or more fields of the documents being filtered. + Filter expression is case-sensitive. This will + be used to filter search results which may + affect the summary response. + + If this field is unrecognizable, an + ``INVALID_ARGUMENT`` is returned. + + Filtering in Vertex AI Search is done by mapping + the LHS filter key to a key property defined in + the Vertex AI Search backend -- this mapping is + defined by the customer in their schema. For + example a media customer might have a field + 'name' in their schema. In this case the filter + would look like this: filter --> name:'ANY("king + kong")' + + For more information about filtering including + syntax and filter operators, see + `Filter + `__ boost_spec (google.cloud.discoveryengine_v1.types.SearchRequest.BoostSpec): - Boost specification to boost certain documents in search - results which may affect the converse response. For more - information on boosting, see - `Boosting `__ + Boost specification to boost certain documents + in search results which may affect the converse + response. For more information on boosting, see + `Boosting + `__ """ name: str = proto.Field( @@ -175,7 +190,8 @@ class ConverseConversationRequest(proto.Message): class ConverseConversationResponse(proto.Message): r"""Response message for - [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1.ConversationalSearchService.ConverseConversation] + `ConversationalSearchService.ConverseConversation + `__ method. Attributes: @@ -211,7 +227,8 @@ class CreateConversationRequest(proto.Message): Attributes: parent (str): - Required. Full resource name of parent data store. Format: + Required. Full resource name of parent data + store. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` conversation (google.cloud.discoveryengine_v1.types.Conversation): Required. The conversation to create. @@ -236,12 +253,15 @@ class UpdateConversationRequest(proto.Message): Required. The Conversation to update. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [Conversation][google.cloud.discoveryengine.v1.Conversation] + `Conversation + `__ to update. The following are NOT supported: - - [Conversation.name][google.cloud.discoveryengine.v1.Conversation.name] + * `Conversation.name + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported fields are + updated. """ conversation: gcd_conversation.Conversation = proto.Field( @@ -261,8 +281,8 @@ class DeleteConversationRequest(proto.Message): Attributes: name (str): - Required. The resource name of the Conversation to delete. - Format: + Required. The resource name of the Conversation + to delete. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`` """ @@ -277,8 +297,8 @@ class GetConversationRequest(proto.Message): Attributes: name (str): - Required. The resource name of the Conversation to get. - Format: + Required. The resource name of the Conversation + to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`` """ @@ -300,23 +320,30 @@ class ListConversationsRequest(proto.Message): unspecified, defaults to 50. Max allowed value is 1000. page_token (str): - A page token, received from a previous ``ListConversations`` - call. Provide this to retrieve the subsequent page. + A page token, received from a previous + ``ListConversations`` call. Provide this to + retrieve the subsequent page. filter (str): - A filter to apply on the list results. The supported - features are: user_pseudo_id, state. + A filter to apply on the list results. The + supported features are: user_pseudo_id, state. - Example: "user_pseudo_id = some_id". + Example: + + "user_pseudo_id = some_id". order_by (str): - A comma-separated list of fields to order by, sorted in - ascending order. Use "desc" after a field name for - descending. Supported fields: + A comma-separated list of fields to order by, + sorted in ascending order. Use "desc" after a + field name for descending. Supported fields: + + * ``update_time`` + * ``create_time`` - - ``update_time`` - - ``create_time`` - - ``conversation_name`` + * ``conversation_name`` + + Example: - Example: "update_time desc" "create_time". + "update_time desc" + "create_time". """ parent: str = proto.Field( @@ -369,29 +396,31 @@ def raw_page(self): class AnswerQueryRequest(proto.Message): r"""Request message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1.ConversationalSearchService.AnswerQuery] + `ConversationalSearchService.AnswerQuery + `__ method. Attributes: serving_config (str): - Required. The resource name of the Search serving config, - such as + Required. The resource name of the Search + serving config, such as ``projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config``, or ``projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config``. - This field is used to identify the serving configuration - name, set of models used to make the search. + This field is used to identify the serving + configuration name, set of models used to make + the search. query (google.cloud.discoveryengine_v1.types.Query): Required. Current user query. session (str): The session resource name. Not required. - When session field is not set, the API is in sessionless - mode. + When session field is not set, the API is in + sessionless mode. - We support auto session mode: users can use the wildcard - symbol ``-`` as session ID. A new ID will be automatically - generated and assigned. + We support auto session mode: users can use the + wildcard symbol ``-`` as session ID. A new ID + will be automatically generated and assigned. safety_spec (google.cloud.discoveryengine_v1.types.AnswerQueryRequest.SafetySpec): Model specification. related_questions_spec (google.cloud.discoveryengine_v1.types.AnswerQueryRequest.RelatedQuestionsSpec): @@ -405,73 +434,84 @@ class AnswerQueryRequest(proto.Message): query_understanding_spec (google.cloud.discoveryengine_v1.types.AnswerQueryRequest.QueryUnderstandingSpec): Query understanding specification. asynchronous_mode (bool): - Deprecated: This field is deprecated. Streaming Answer API - will be supported. + Deprecated: This field is deprecated. Streaming + Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with - answer/session resource name without final answer. The API - users need to do the polling to get the latest status of - answer/session by calling - [ConversationalSearchService.GetAnswer][google.cloud.discoveryengine.v1.ConversationalSearchService.GetAnswer] + answer/session resource name without final + answer. The API users need to do the polling to + get the latest status of answer/session by + calling `ConversationalSearchService.GetAnswer + `__ or - [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1.ConversationalSearchService.GetSession] + `ConversationalSearchService.GetSession + `__ method. user_pseudo_id (str): - A unique identifier for tracking visitors. For example, this - could be implemented with an HTTP cookie, which should be - able to uniquely identify a visitor on a single device. This - unique identifier should not change if the visitor logs in - or out of the website. + A unique identifier for tracking visitors. For + example, this could be implemented with an HTTP + cookie, which should be able to uniquely + identify a visitor on a single device. This + unique identifier should not change if the + visitor logs in or out of the website. This field should NOT have a fixed value such as ``unknown_visitor``. - The field must be a UTF-8 encoded string with a length limit - of 128 characters. Otherwise, an ``INVALID_ARGUMENT`` error - is returned. + The field must be a UTF-8 encoded string with a + length limit of 128 characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. user_labels (MutableMapping[str, str]): - The user labels applied to a resource must meet the - following requirements: - - - Each resource can have multiple labels, up to a maximum of - 64. - - Each label must be a key-value pair. - - Keys have a minimum length of 1 character and a maximum - length of 63 characters and cannot be empty. Values can be - empty and have a maximum length of 63 characters. - - Keys and values can contain only lowercase letters, - numeric characters, underscores, and dashes. All - characters must use UTF-8 encoding, and international - characters are allowed. - - The key portion of a label must be unique. However, you - can use the same key with multiple resources. - - Keys must start with a lowercase letter or international - character. + The user labels applied to a resource must meet + the following requirements: + * Each resource can have multiple labels, up to + a maximum of 64. + + * Each label must be a key-value pair. + * Keys have a minimum length of 1 character and + a maximum length of 63 characters and cannot + be empty. Values can be empty and have a maximum + length of 63 characters. + + * Keys and values can contain only lowercase + letters, numeric characters, underscores, and + dashes. All characters must use UTF-8 encoding, + and international characters are allowed. + + * The key portion of a label must be unique. + However, you can use the same key with + multiple resources. + + * Keys must start with a lowercase letter or + international character. See `Google Cloud - Document `__ + Document + `__ for more details. end_user_spec (google.cloud.discoveryengine_v1.types.AnswerQueryRequest.EndUserSpec): Optional. End user specification. """ class SafetySpec(proto.Message): - r"""Safety specification. There are two use cases: + r"""Safety specification. + There are two use cases: 1. when only safety_spec.enable is set, the BLOCK_LOW_AND_ABOVE - threshold will be applied for all categories. - 2. when safety_spec.enable is set and some safety_settings are set, - only specified safety_settings are applied. + threshold will be applied for all categories. + 2. when safety_spec.enable is set and some safety_settings are + set, only specified safety_settings are applied. Attributes: enable (bool): Enable the safety filtering on the answer response. It is false by default. safety_settings (MutableSequence[google.cloud.discoveryengine_v1.types.AnswerQueryRequest.SafetySpec.SafetySetting]): - Optional. Safety settings. This settings are effective only - when the safety_spec.enable is true. + Optional. Safety settings. + This settings are effective only when the + safety_spec.enable is true. """ class SafetySetting(proto.Message): @@ -550,12 +590,13 @@ class GroundingSpec(proto.Message): Attributes: include_grounding_supports (bool): - Optional. Specifies whether to include grounding_supports in - the answer. The default value is ``false``. + Optional. Specifies whether to include + grounding_supports in the answer. The default + value is ``false``. - When this field is set to ``true``, returned answer will - have ``grounding_score`` and will contain GroundingSupports - for each claim. + When this field is set to ``true``, returned + answer will have ``grounding_score`` and will + contain GroundingSupports for each claim. filtering_level (google.cloud.discoveryengine_v1.types.AnswerQueryRequest.GroundingSpec.FilteringLevel): Optional. Specifies whether to enable the filtering based on grounding score and at what @@ -600,57 +641,65 @@ class AnswerGenerationSpec(proto.Message): prompt_spec (google.cloud.discoveryengine_v1.types.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec): Answer generation prompt specification. include_citations (bool): - Specifies whether to include citation metadata in the - answer. The default value is ``false``. + Specifies whether to include citation metadata + in the answer. The default value is ``false``. answer_language_code (str): - Language code for Answer. Use language tags defined by - `BCP47 `__. + Language code for Answer. Use language tags + defined by `BCP47 + `__. Note: This is an experimental feature. ignore_adversarial_query (bool): - Specifies whether to filter out adversarial queries. The - default value is ``false``. - - Google employs search-query classification to detect - adversarial queries. No answer is returned if the search - query is classified as an adversarial query. For example, a - user might ask a question regarding negative comments about - the company or submit a query designed to generate unsafe, - policy-violating output. If this field is set to ``true``, - we skip generating answers for adversarial queries and - return fallback messages instead. + Specifies whether to filter out adversarial + queries. The default value is ``false``. + + Google employs search-query classification to + detect adversarial queries. No answer is + returned if the search query is classified as an + adversarial query. For example, a user might ask + a question regarding negative comments about the + company or submit a query designed to generate + unsafe, policy-violating output. If this field + is set to ``true``, we skip generating answers + for adversarial queries and return fallback + messages instead. ignore_non_answer_seeking_query (bool): - Specifies whether to filter out queries that are not - answer-seeking. The default value is ``false``. - - Google employs search-query classification to detect - answer-seeking queries. No answer is returned if the search - query is classified as a non-answer seeking query. If this - field is set to ``true``, we skip generating answers for - non-answer seeking queries and return fallback messages - instead. + Specifies whether to filter out queries that are + not answer-seeking. The default value is + ``false``. + + Google employs search-query classification to + detect answer-seeking queries. No answer is + returned if the search query is classified as a + non-answer seeking query. If this field is set + to ``true``, we skip generating answers for + non-answer seeking queries and return fallback + messages instead. ignore_low_relevant_content (bool): - Specifies whether to filter out queries that have low - relevance. - - If this field is set to ``false``, all search results are - used regardless of relevance to generate answers. If set to - ``true`` or unset, the behavior will be determined - automatically by the service. + Specifies whether to filter out queries that + have low relevance. + If this field is set to ``false``, all search + results are used regardless of relevance to + generate answers. If set to ``true`` or unset, + the behavior will be determined automatically by + the service. This field is a member of `oneof`_ ``_ignore_low_relevant_content``. ignore_jail_breaking_query (bool): - Optional. Specifies whether to filter out jail-breaking - queries. The default value is ``false``. - - Google employs search-query classification to detect - jail-breaking queries. No summary is returned if the search - query is classified as a jail-breaking query. A user might - add instructions to the query to change the tone, style, - language, content of the answer, or ask the model to act as - a different entity, e.g. "Reply in the tone of a competing - company's CEO". If this field is set to ``true``, we skip - generating summaries for jail-breaking queries and return - fallback messages instead. + Optional. Specifies whether to filter out + jail-breaking queries. The default value is + ``false``. + + Google employs search-query classification to + detect jail-breaking queries. No summary is + returned if the search query is classified as a + jail-breaking query. A user might add + instructions to the query to change the tone, + style, language, content of the answer, or ask + the model to act as a different entity, e.g. + "Reply in the tone of a competing company's + CEO". If this field is set to ``true``, we skip + generating summaries for jail-breaking queries + and return fallback messages instead. """ class ModelSpec(proto.Message): @@ -746,45 +795,53 @@ class SearchParams(proto.Message): Number of search results to return. The default value is 10. filter (str): - The filter syntax consists of an expression language for - constructing a predicate from one or more fields of the - documents being filtered. Filter expression is - case-sensitive. This will be used to filter search results - which may affect the Answer response. - - If this field is unrecognizable, an ``INVALID_ARGUMENT`` is - returned. - - Filtering in Vertex AI Search is done by mapping the LHS - filter key to a key property defined in the Vertex AI Search - backend -- this mapping is defined by the customer in their - schema. For example a media customers might have a field - 'name' in their schema. In this case the filter would look - like this: filter --> name:'ANY("king kong")' - - For more information about filtering including syntax and - filter operators, see - `Filter `__ + The filter syntax consists of an expression + language for constructing a predicate from one + or more fields of the documents being filtered. + Filter expression is case-sensitive. This will + be used to filter search results which may + affect the Answer response. + + If this field is unrecognizable, an + ``INVALID_ARGUMENT`` is returned. + + Filtering in Vertex AI Search is done by mapping + the LHS filter key to a key property defined in + the Vertex AI Search backend -- this mapping is + defined by the customer in their schema. For + example a media customers might have a field + 'name' in their schema. In this case the filter + would look like this: filter --> name:'ANY("king + kong")' + + For more information about filtering including + syntax and filter operators, see + `Filter + `__ boost_spec (google.cloud.discoveryengine_v1.types.SearchRequest.BoostSpec): - Boost specification to boost certain documents in search - results which may affect the answer query response. For more - information on boosting, see - `Boosting `__ + Boost specification to boost certain documents + in search results which may affect the answer + query response. For more information on + boosting, see `Boosting + `__ order_by (str): - The order in which documents are returned. Documents can be - ordered by a field in an - [Document][google.cloud.discoveryengine.v1.Document] object. - Leave it unset if ordered by relevance. ``order_by`` - expression is case-sensitive. For more information on - ordering, see - `Ordering `__ - - If this field is unrecognizable, an ``INVALID_ARGUMENT`` is - returned. + The order in which documents are returned. + Documents can be ordered by a field in an + `Document + `__ + object. Leave it unset if ordered by relevance. + ``order_by`` expression is case-sensitive. For + more information on ordering, see `Ordering + `__ + + If this field is unrecognizable, an + ``INVALID_ARGUMENT`` is returned. search_result_mode (google.cloud.discoveryengine_v1.types.SearchRequest.ContentSearchSpec.SearchResultMode): - Specifies the search result mode. If unspecified, the search - result mode defaults to ``DOCUMENTS``. See `parse and chunk - documents `__ + Specifies the search result mode. If + unspecified, the search result mode defaults to + ``DOCUMENTS``. See `parse and chunk + documents + `__ data_store_specs (MutableSequence[google.cloud.discoveryengine_v1.types.SearchRequest.DataStoreSpec]): Specs defining dataStores to filter on in a search call and configurations for those @@ -871,9 +928,11 @@ class UnstructuredDocumentInfo(proto.Message): extractive_segments (MutableSequence[google.cloud.discoveryengine_v1.types.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveSegment]): List of extractive segments. extractive_answers (MutableSequence[google.cloud.discoveryengine_v1.types.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveAnswer]): - Deprecated: This field is deprecated and will have no effect - on the Answer generation. Please use document_contexts and - extractive_segments fields. List of extractive answers. + Deprecated: This field is deprecated and will + have no effect on the Answer generation. + Please use document_contexts and + extractive_segments fields. List of extractive + answers. """ class DocumentContext(proto.Message): @@ -898,9 +957,10 @@ class DocumentContext(proto.Message): class ExtractiveSegment(proto.Message): r"""Extractive segment. - `Guide `__ - Answer generation will only use it if document_contexts is empty. - This is supposed to be shorter snippets. + `Guide + `__ + Answer generation will only use it if document_contexts is + empty. This is supposed to be shorter snippets. Attributes: page_identifier (str): @@ -920,7 +980,8 @@ class ExtractiveSegment(proto.Message): class ExtractiveAnswer(proto.Message): r"""Extractive answer. - `Guide `__ + `Guide + `__ Attributes: page_identifier (str): @@ -1064,8 +1125,8 @@ class QueryUnderstandingSpec(proto.Message): query_rephraser_spec (google.cloud.discoveryengine_v1.types.AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec): Query rephraser specification. disable_spell_correction (bool): - Optional. Whether to disable spell correction. The default - value is ``false``. + Optional. Whether to disable spell correction. + The default value is ``false``. """ class QueryClassificationSpec(proto.Message): @@ -1327,22 +1388,28 @@ class DocumentMetadata(proto.Message): class AnswerQueryResponse(proto.Message): r"""Response message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1.ConversationalSearchService.AnswerQuery] + `ConversationalSearchService.AnswerQuery + `__ method. Attributes: answer (google.cloud.discoveryengine_v1.types.Answer): - Answer resource object. If - [AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps][google.cloud.discoveryengine.v1.AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps] + Answer resource object. + If + `AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps + `__ is greater than 1, use - [Answer.name][google.cloud.discoveryengine.v1.Answer.name] + `Answer.name + `__ to fetch answer information using - [ConversationalSearchService.GetAnswer][google.cloud.discoveryengine.v1.ConversationalSearchService.GetAnswer] + `ConversationalSearchService.GetAnswer + `__ API. session (google.cloud.discoveryengine_v1.types.Session): - Session resource object. It will be only available when - session field is set and valid in the - [AnswerQueryRequest][google.cloud.discoveryengine.v1.AnswerQueryRequest] + Session resource object. + It will be only available when session field is + set and valid in the `AnswerQueryRequest + `__ request. answer_query_token (str): A global unique ID used for logging. @@ -1369,7 +1436,8 @@ class GetAnswerRequest(proto.Message): Attributes: name (str): - Required. The resource name of the Answer to get. Format: + Required. The resource name of the Answer to + get. Format: ``projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`` """ @@ -1384,7 +1452,8 @@ class CreateSessionRequest(proto.Message): Attributes: parent (str): - Required. Full resource name of parent data store. Format: + Required. Full resource name of parent data + store. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` session (google.cloud.discoveryengine_v1.types.Session): Required. The session to create. @@ -1409,12 +1478,15 @@ class UpdateSessionRequest(proto.Message): Required. The Session to update. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [Session][google.cloud.discoveryengine.v1.Session] to + `Session + `__ to update. The following are NOT supported: - - [Session.name][google.cloud.discoveryengine.v1.Session.name] + * `Session.name + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported fields are + updated. """ session: gcd_session.Session = proto.Field( @@ -1434,8 +1506,8 @@ class DeleteSessionRequest(proto.Message): Attributes: name (str): - Required. The resource name of the Session to delete. - Format: + Required. The resource name of the Session to + delete. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` """ @@ -1450,7 +1522,8 @@ class GetSessionRequest(proto.Message): Attributes: name (str): - Required. The resource name of the Session to get. Format: + Required. The resource name of the Session to + get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` include_answer_details (bool): Optional. If set to true, the full session @@ -1479,40 +1552,51 @@ class ListSessionsRequest(proto.Message): unspecified, defaults to 50. Max allowed value is 1000. page_token (str): - A page token, received from a previous ``ListSessions`` - call. Provide this to retrieve the subsequent page. + A page token, received from a previous + ``ListSessions`` call. Provide this to retrieve + the subsequent page. filter (str): - A comma-separated list of fields to filter by, in EBNF - grammar. The supported fields are: - - - ``user_pseudo_id`` - - ``state`` - - ``display_name`` - - ``starred`` - - ``is_pinned`` - - ``labels`` - - ``create_time`` - - ``update_time`` - - Examples: "user_pseudo_id = some_id" "display_name = - "some_name"" "starred = true" "is_pinned=true AND (NOT - labels:hidden)" "create_time > "1970-01-01T12:00:00Z"". + A comma-separated list of fields to filter by, + in EBNF grammar. The supported fields are: + + * ``user_pseudo_id`` + * ``state`` + + * ``display_name`` + * ``starred`` + + * ``is_pinned`` + * ``labels`` + + * ``create_time`` + * ``update_time`` + + Examples: + + "user_pseudo_id = some_id" + "display_name = \"some_name\"" + "starred = true" + "is_pinned=true AND (NOT labels:hidden)" + "create_time > \"1970-01-01T12:00:00Z\"". order_by (str): - A comma-separated list of fields to order by, sorted in - ascending order. Use "desc" after a field name for - descending. Supported fields: + A comma-separated list of fields to order by, + sorted in ascending order. Use "desc" after a + field name for descending. Supported fields: - - ``update_time`` - - ``create_time`` - - ``session_name`` - - ``is_pinned`` + * ``update_time`` + * ``create_time`` + + * ``session_name`` + * ``is_pinned`` Example: - - "update_time desc" - - "create_time" - - "is_pinned desc,update_time desc": list sessions by - is_pinned first, then by update_time. + * "update_time desc" + * "create_time" + + * "is_pinned desc,update_time desc": list + sessions by is_pinned first, then by + update_time. """ parent: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/custom_tuning_model.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/custom_tuning_model.py index d4eacc8b57c8..e5c995df38f3 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/custom_tuning_model.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/custom_tuning_model.py @@ -33,20 +33,21 @@ class CustomTuningModel(proto.Message): Attributes: name (str): - Required. The fully qualified resource name of the model. - + Required. The fully qualified resource name of + the model. Format: + ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}``. - Model must be an alpha-numerical string with limit of 40 - characters. + Model must be an alpha-numerical string with + limit of 40 characters. display_name (str): The display name of the model. model_version (int): The version of the model. model_state (google.cloud.discoveryengine_v1.types.CustomTuningModel.ModelState): - The state that the model is in (e.g.\ ``TRAINING`` or - ``TRAINING_FAILED``). + The state that the model is in (e.g.``TRAINING`` + or ``TRAINING_FAILED``). create_time (google.protobuf.timestamp_pb2.Timestamp): Deprecated: Timestamp the Model was created at. @@ -55,8 +56,8 @@ class CustomTuningModel(proto.Message): metrics (MutableMapping[str, float]): The metrics of the trained model. error_message (str): - Currently this is only populated if the model state is - ``INPUT_VALIDATION_FAILED``. + Currently this is only populated if the model + state is ``INPUT_VALIDATION_FAILED``. """ class ModelState(proto.Enum): diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/data_store.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/data_store.py index 397e4dce92ba..2df1b69c48aa 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/data_store.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/data_store.py @@ -42,55 +42,59 @@ class DataStore(proto.Message): Attributes: name (str): - Immutable. Identifier. The full resource name of the data - store. Format: + Immutable. Identifier. The full resource name of + the data store. Format: + ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. - This field must be a UTF-8 encoded string with a length - limit of 1024 characters. + This field must be a UTF-8 encoded string with a + length limit of 1024 characters. display_name (str): Required. The data store display name. - This field must be a UTF-8 encoded string with a length - limit of 128 characters. Otherwise, an INVALID_ARGUMENT - error is returned. + This field must be a UTF-8 encoded string with a + length limit of 128 characters. Otherwise, an + INVALID_ARGUMENT error is returned. industry_vertical (google.cloud.discoveryengine_v1.types.IndustryVertical): Immutable. The industry vertical that the data store registers. solution_types (MutableSequence[google.cloud.discoveryengine_v1.types.SolutionType]): - The solutions that the data store enrolls. Available - solutions for each - [industry_vertical][google.cloud.discoveryengine.v1.DataStore.industry_vertical]: - - - ``MEDIA``: ``SOLUTION_TYPE_RECOMMENDATION`` and - ``SOLUTION_TYPE_SEARCH``. - - ``SITE_SEARCH``: ``SOLUTION_TYPE_SEARCH`` is automatically - enrolled. Other solutions cannot be enrolled. + The solutions that the data store enrolls. + Available solutions for each `industry_vertical + `__: + + * ``MEDIA``: ``SOLUTION_TYPE_RECOMMENDATION`` + and ``SOLUTION_TYPE_SEARCH``. * ``SITE_SEARCH``: + ``SOLUTION_TYPE_SEARCH`` is automatically + enrolled. Other solutions cannot be enrolled. default_schema_id (str): Output only. The id of the default - [Schema][google.cloud.discoveryengine.v1.Schema] associated - to this data store. + `Schema + `__ + associated to this data store. content_config (google.cloud.discoveryengine_v1.types.DataStore.ContentConfig): - Immutable. The content config of the data store. If this - field is unset, the server behavior defaults to - [ContentConfig.NO_CONTENT][google.cloud.discoveryengine.v1.DataStore.ContentConfig.NO_CONTENT]. + Immutable. The content config of the data store. + If this field is unset, the server behavior + defaults to `ContentConfig.NO_CONTENT + `__. create_time (google.protobuf.timestamp_pb2.Timestamp): Output only. Timestamp the - [DataStore][google.cloud.discoveryengine.v1.DataStore] was - created at. + `DataStore + `__ + was created at. advanced_site_search_config (google.cloud.discoveryengine_v1.types.AdvancedSiteSearchConfig): Optional. Configuration for advanced site search. kms_key_name (str): - Input only. The KMS key to be used to protect this DataStore - at creation time. + Input only. The KMS key to be used to protect + this DataStore at creation time. - Must be set for requests that need to comply with CMEK Org - Policy protections. + Must be set for requests that need to comply + with CMEK Org Policy protections. - If this field is set and processed successfully, the - DataStore will be protected by the KMS key, as indicated in - the cmek_config field. + If this field is set and processed successfully, + the DataStore will be protected by the KMS key, + as indicated in the cmek_config field. cmek_config (google.cloud.discoveryengine_v1.types.CmekConfig): Output only. CMEK-related information for the DataStore. @@ -99,58 +103,78 @@ class DataStore(proto.Message): billing. acl_enabled (bool): Immutable. Whether data in the - [DataStore][google.cloud.discoveryengine.v1.DataStore] has - ACL information. If set to ``true``, the source data must - have ACL. ACL will be ingested when data is ingested by - [DocumentService.ImportDocuments][google.cloud.discoveryengine.v1.DocumentService.ImportDocuments] + `DataStore + `__ + has ACL information. If set to ``true``, the + source data must have ACL. ACL will be ingested + when data is ingested by + `DocumentService.ImportDocuments + `__ methods. When ACL is enabled for the - [DataStore][google.cloud.discoveryengine.v1.DataStore], - [Document][google.cloud.discoveryengine.v1.Document] can't - be accessed by calling - [DocumentService.GetDocument][google.cloud.discoveryengine.v1.DocumentService.GetDocument] + `DataStore + `__, + `Document + `__ + can't be accessed by calling + `DocumentService.GetDocument + `__ or - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments]. + `DocumentService.ListDocuments + `__. - Currently ACL is only supported in ``GENERIC`` industry - vertical with non-``PUBLIC_WEBSITE`` content config. + Currently ACL is only supported in ``GENERIC`` + industry vertical with non-``PUBLIC_WEBSITE`` + content config. workspace_config (google.cloud.discoveryengine_v1.types.WorkspaceConfig): - Config to store data store type configuration for workspace - data. This must be set when - [DataStore.content_config][google.cloud.discoveryengine.v1.DataStore.content_config] + Config to store data store type configuration + for workspace data. This must be set when + `DataStore.content_config + `__ is set as - [DataStore.ContentConfig.GOOGLE_WORKSPACE][google.cloud.discoveryengine.v1.DataStore.ContentConfig.GOOGLE_WORKSPACE]. + `DataStore.ContentConfig.GOOGLE_WORKSPACE + `__. document_processing_config (google.cloud.discoveryengine_v1.types.DocumentProcessingConfig): Configuration for Document understanding and enrichment. starting_schema (google.cloud.discoveryengine_v1.types.Schema): The start schema to use for this - [DataStore][google.cloud.discoveryengine.v1.DataStore] when - provisioning it. If unset, a default vertical specialized - schema will be used. + `DataStore + `__ + when provisioning it. If unset, a default + vertical specialized schema will be used. This field is only used by - [CreateDataStore][google.cloud.discoveryengine.v1.DataStoreService.CreateDataStore] - API, and will be ignored if used in other APIs. This field - will be omitted from all API responses including - [CreateDataStore][google.cloud.discoveryengine.v1.DataStoreService.CreateDataStore] + `CreateDataStore + `__ + API, and will be ignored if used in other APIs. + This field will be omitted from all API + responses including + `CreateDataStore + `__ API. To retrieve a schema of a - [DataStore][google.cloud.discoveryengine.v1.DataStore], use - [SchemaService.GetSchema][google.cloud.discoveryengine.v1.SchemaService.GetSchema] + `DataStore + `__, + use `SchemaService.GetSchema + `__ API instead. - The provided schema will be validated against certain rules - on schema. Learn more from `this - doc `__. + The provided schema will be validated against + certain rules on schema. Learn more from `this + doc + `__. healthcare_fhir_config (google.cloud.discoveryengine_v1.types.HealthcareFhirConfig): - Optional. Configuration for ``HEALTHCARE_FHIR`` vertical. + Optional. Configuration for ``HEALTHCARE_FHIR`` + vertical. identity_mapping_store (str): - Immutable. The fully qualified resource name of the - associated - [IdentityMappingStore][google.cloud.discoveryengine.v1.IdentityMappingStore]. - This field can only be set for acl_enabled DataStores with - ``THIRD_PARTY`` or ``GSUITE`` IdP. Format: + Immutable. The fully qualified resource name of + the associated `IdentityMappingStore + `__. + This field can only be set for acl_enabled + DataStores with ``THIRD_PARTY`` or ``GSUITE`` + IdP. Format: + ``projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}``. """ @@ -162,17 +186,20 @@ class ContentConfig(proto.Enum): Default value. NO_CONTENT (1): Only contains documents without any - [Document.content][google.cloud.discoveryengine.v1.Document.content]. + `Document.content + `__. CONTENT_REQUIRED (2): Only contains documents with - [Document.content][google.cloud.discoveryengine.v1.Document.content]. + `Document.content + `__. PUBLIC_WEBSITE (3): The data store is used for public website search. GOOGLE_WORKSPACE (4): - The data store is used for workspace search. Details of - workspace data store are specified in the - [WorkspaceConfig][google.cloud.discoveryengine.v1.WorkspaceConfig]. + The data store is used for workspace search. + Details of workspace data store are specified in + the `WorkspaceConfig + `__. """ CONTENT_CONFIG_UNSPECIFIED = 0 NO_CONTENT = 1 diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/data_store_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/data_store_service.py index 6415db9c91d7..9ad546117e91 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/data_store_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/data_store_service.py @@ -40,7 +40,8 @@ class CreateDataStoreRequest(proto.Message): r"""Request for - [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1.DataStoreService.CreateDataStore] + `DataStoreService.CreateDataStore + `__ method. This message has `oneof`_ fields (mutually exclusive fields). @@ -67,33 +68,40 @@ class CreateDataStoreRequest(proto.Message): Required. The parent resource name, such as ``projects/{project}/locations/{location}/collections/{collection}``. data_store (google.cloud.discoveryengine_v1.types.DataStore): - Required. The - [DataStore][google.cloud.discoveryengine.v1.DataStore] to - create. + Required. The `DataStore + `__ + to create. data_store_id (str): Required. The ID to use for the - [DataStore][google.cloud.discoveryengine.v1.DataStore], + `DataStore + `__, which will become the final component of the - [DataStore][google.cloud.discoveryengine.v1.DataStore]'s + `DataStore + `__'s resource name. - This field must conform to - `RFC-1034 `__ standard - with a length limit of 63 characters. Otherwise, an - INVALID_ARGUMENT error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 characters. + Otherwise, an INVALID_ARGUMENT error is + returned. create_advanced_site_search (bool): - A boolean flag indicating whether user want to directly - create an advanced data store for site search. If the data - store is not configured as site search (GENERIC vertical and - PUBLIC_WEBSITE content_config), this flag will be ignored. + A boolean flag indicating whether user want to + directly create an advanced data store for site + search. If the data store is not configured as + site + search (GENERIC vertical and PUBLIC_WEBSITE + content_config), this flag will be ignored. skip_default_schema_creation (bool): - A boolean flag indicating whether to skip the default schema - creation for the data store. Only enable this flag if you - are certain that the default schema is incompatible with - your use case. + A boolean flag indicating whether to skip the + default schema creation for the data store. Only + enable this flag if you are certain that the + default schema is incompatible with your use + case. - If set to true, you must manually create a schema for the - data store before any documents can be ingested. + If set to true, you must manually create a + schema for the data store before any documents + can be ingested. This flag cannot be specified if ``data_store.starting_schema`` is specified. @@ -134,24 +142,27 @@ class CreateDataStoreRequest(proto.Message): class GetDataStoreRequest(proto.Message): r"""Request message for - [DataStoreService.GetDataStore][google.cloud.discoveryengine.v1.DataStoreService.GetDataStore] + `DataStoreService.GetDataStore + `__ method. Attributes: name (str): Required. Full resource name of - [DataStore][google.cloud.discoveryengine.v1.DataStore], such - as + `DataStore + `__, + such as ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. - If the caller does not have permission to access the - [DataStore][google.cloud.discoveryengine.v1.DataStore], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. + If the caller does not have permission to access + the `DataStore + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. - If the requested - [DataStore][google.cloud.discoveryengine.v1.DataStore] does - not exist, a NOT_FOUND error is returned. + If the requested `DataStore + `__ + does not exist, a NOT_FOUND error is returned. """ name: str = proto.Field( @@ -162,7 +173,8 @@ class GetDataStoreRequest(proto.Message): class CreateDataStoreMetadata(proto.Message): r"""Metadata related to the progress of the - [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1.DataStoreService.CreateDataStore] + `DataStoreService.CreateDataStore + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -188,39 +200,51 @@ class CreateDataStoreMetadata(proto.Message): class ListDataStoresRequest(proto.Message): r"""Request message for - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores] + `DataStoreService.ListDataStores + `__ method. Attributes: parent (str): - Required. The parent branch resource name, such as + Required. The parent branch resource name, such + as ``projects/{project}/locations/{location}/collections/{collection_id}``. If the caller does not have permission to list - [DataStore][google.cloud.discoveryengine.v1.DataStore]s - under this location, regardless of whether or not this data - store exists, a PERMISSION_DENIED error is returned. + `DataStore + `__s + under this location, regardless of whether or + not this data store exists, a PERMISSION_DENIED + error is returned. page_size (int): - Maximum number of - [DataStore][google.cloud.discoveryengine.v1.DataStore]s to - return. If unspecified, defaults to 10. The maximum allowed - value is 50. Values above 50 will be coerced to 50. - - If this field is negative, an INVALID_ARGUMENT is returned. + Maximum number of `DataStore + `__s + to return. If unspecified, defaults to 10. The + maximum allowed value is 50. Values above 50 + will be coerced to 50. + + If this field is negative, an INVALID_ARGUMENT + is returned. page_token (str): A page token - [ListDataStoresResponse.next_page_token][google.cloud.discoveryengine.v1.ListDataStoresResponse.next_page_token], + `ListDataStoresResponse.next_page_token + `__, received from a previous - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores] - call. Provide this to retrieve the subsequent page. - - When paginating, all other parameters provided to - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores] - must match the call that provided the page token. Otherwise, - an INVALID_ARGUMENT error is returned. + `DataStoreService.ListDataStores + `__ + call. Provide this to retrieve the subsequent + page. + + When paginating, all other parameters provided + to `DataStoreService.ListDataStores + `__ + must match the call that provided the page + token. Otherwise, an INVALID_ARGUMENT error is + returned. filter (str): - Filter by solution type . For example: - ``filter = 'solution_type:SOLUTION_TYPE_SEARCH'`` + Filter by solution type . + For example: ``filter = + 'solution_type:SOLUTION_TYPE_SEARCH'`` """ parent: str = proto.Field( @@ -243,18 +267,20 @@ class ListDataStoresRequest(proto.Message): class ListDataStoresResponse(proto.Message): r"""Response message for - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores] + `DataStoreService.ListDataStores + `__ method. Attributes: data_stores (MutableSequence[google.cloud.discoveryengine_v1.types.DataStore]): - All the customer's - [DataStore][google.cloud.discoveryengine.v1.DataStore]s. + All the customer's `DataStore + `__s. next_page_token (str): A token that can be sent as - [ListDataStoresRequest.page_token][google.cloud.discoveryengine.v1.ListDataStoresRequest.page_token] - to retrieve the next page. If this field is omitted, there - are no subsequent pages. + `ListDataStoresRequest.page_token + `__ + to retrieve the next page. If this field is + omitted, there are no subsequent pages. """ @property @@ -274,24 +300,28 @@ def raw_page(self): class DeleteDataStoreRequest(proto.Message): r"""Request message for - [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1.DataStoreService.DeleteDataStore] + `DataStoreService.DeleteDataStore + `__ method. Attributes: name (str): Required. Full resource name of - [DataStore][google.cloud.discoveryengine.v1.DataStore], such - as + `DataStore + `__, + such as ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. - If the caller does not have permission to delete the - [DataStore][google.cloud.discoveryengine.v1.DataStore], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. + If the caller does not have permission to delete + the `DataStore + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. - If the - [DataStore][google.cloud.discoveryengine.v1.DataStore] to - delete does not exist, a NOT_FOUND error is returned. + If the `DataStore + `__ + to delete does not exist, a NOT_FOUND error is + returned. """ name: str = proto.Field( @@ -302,30 +332,34 @@ class DeleteDataStoreRequest(proto.Message): class UpdateDataStoreRequest(proto.Message): r"""Request message for - [DataStoreService.UpdateDataStore][google.cloud.discoveryengine.v1.DataStoreService.UpdateDataStore] + `DataStoreService.UpdateDataStore + `__ method. Attributes: data_store (google.cloud.discoveryengine_v1.types.DataStore): - Required. The - [DataStore][google.cloud.discoveryengine.v1.DataStore] to - update. - - If the caller does not have permission to update the - [DataStore][google.cloud.discoveryengine.v1.DataStore], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. - - If the - [DataStore][google.cloud.discoveryengine.v1.DataStore] to - update does not exist, a NOT_FOUND error is returned. + Required. The `DataStore + `__ + to update. + + If the caller does not have permission to update + the `DataStore + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. + + If the `DataStore + `__ + to update does not exist, a NOT_FOUND error is + returned. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [DataStore][google.cloud.discoveryengine.v1.DataStore] to - update. + `DataStore + `__ + to update. - If an unsupported or unknown field is provided, an - INVALID_ARGUMENT error is returned. + If an unsupported or unknown field is provided, + an INVALID_ARGUMENT error is returned. """ data_store: gcd_data_store.DataStore = proto.Field( @@ -342,7 +376,8 @@ class UpdateDataStoreRequest(proto.Message): class DeleteDataStoreMetadata(proto.Message): r"""Metadata related to the progress of the - [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1.DataStoreService.DeleteDataStore] + `DataStoreService.DeleteDataStore + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/document.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/document.py index aa775043afc9..d0b88ee4bc58 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/document.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/document.py @@ -45,66 +45,73 @@ class Document(proto.Message): Attributes: struct_data (google.protobuf.struct_pb2.Struct): - The structured JSON data for the document. It should conform - to the registered - [Schema][google.cloud.discoveryengine.v1.Schema] or an - ``INVALID_ARGUMENT`` error is thrown. + The structured JSON data for the document. It + should conform to the registered `Schema + `__ or + an ``INVALID_ARGUMENT`` error is thrown. This field is a member of `oneof`_ ``data``. json_data (str): - The JSON string representation of the document. It should - conform to the registered - [Schema][google.cloud.discoveryengine.v1.Schema] or an - ``INVALID_ARGUMENT`` error is thrown. + The JSON string representation of the document. + It should conform to the registered `Schema + `__ or + an ``INVALID_ARGUMENT`` error is thrown. This field is a member of `oneof`_ ``data``. name (str): - Immutable. The full resource name of the document. Format: + Immutable. The full resource name of the + document. Format: + ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}``. - This field must be a UTF-8 encoded string with a length - limit of 1024 characters. + This field must be a UTF-8 encoded string with a + length limit of 1024 characters. id (str): Immutable. The identifier of the document. - Id should conform to - `RFC-1034 `__ standard - with a length limit of 128 characters. + Id should conform to `RFC-1034 + `__ + standard with a length limit of 128 characters. schema_id (str): The identifier of the schema located in the same data store. content (google.cloud.discoveryengine_v1.types.Document.Content): - The unstructured data linked to this document. Content can - only be set and must be set if this document is under a - ``CONTENT_REQUIRED`` data store. + The unstructured data linked to this document. + Content can only be set and must be set if this + document is under a ``CONTENT_REQUIRED`` data + store. parent_document_id (str): - The identifier of the parent document. Currently supports at - most two level document hierarchy. + The identifier of the parent document. Currently + supports at most two level document hierarchy. - Id should conform to - `RFC-1034 `__ standard - with a length limit of 63 characters. + Id should conform to `RFC-1034 + `__ + standard with a length limit of 63 characters. derived_struct_data (google.protobuf.struct_pb2.Struct): - Output only. This field is OUTPUT_ONLY. It contains derived - data that are not in the original input document. + Output only. This field is OUTPUT_ONLY. + It contains derived data that are not in the + original input document. acl_info (google.cloud.discoveryengine_v1.types.Document.AclInfo): Access control information for the document. index_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. The last time the document was indexed. If this - field is set, the document could be returned in search - results. + Output only. The last time the document was + indexed. If this field is set, the document + could be returned in search results. - This field is OUTPUT_ONLY. If this field is not populated, - it means the document has never been indexed. + This field is OUTPUT_ONLY. If this field is not + populated, it means the document has never been + indexed. index_status (google.cloud.discoveryengine_v1.types.Document.IndexStatus): Output only. The index status of the document. - - If document is indexed successfully, the index_time field - is populated. - - Otherwise, if document is not indexed due to errors, the - error_samples field is populated. - - Otherwise, if document's index is in progress, the - pending_message field is populated. + * If document is indexed successfully, the + index_time field is populated. + + * Otherwise, if document is not indexed due to + errors, the error_samples field is populated. + + * Otherwise, if document's index is in progress, + the pending_message field is populated. """ class Content(proto.Message): @@ -119,49 +126,62 @@ class Content(proto.Message): Attributes: raw_bytes (bytes): - The content represented as a stream of bytes. The maximum - length is 1,000,000 bytes (1 MB / ~0.95 MiB). - - Note: As with all ``bytes`` fields, this field is - represented as pure binary in Protocol Buffers and - base64-encoded string in JSON. For example, - ``abc123!?$*&()'-=@~`` should be represented as - ``YWJjMTIzIT8kKiYoKSctPUB+`` in JSON. See + The content represented as a stream of bytes. + The maximum length is 1,000,000 bytes (1 MB / + ~0.95 MiB). + + Note: As with all ``bytes`` fields, this field + is represented as pure binary in Protocol + Buffers and base64-encoded string in JSON. For + example, ``abc123!?$*&()'-=@~`` should be + represented as ``YWJjMTIzIT8kKiYoKSctPUB+`` in + JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. This field is a member of `oneof`_ ``content``. uri (str): - The URI of the content. Only Cloud Storage URIs (e.g. - ``gs://bucket-name/path/to/file``) are supported. The - maximum file size is 2.5 MB for text-based formats, 200 MB - for other formats. + The URI of the content. Only Cloud Storage URIs + (e.g. ``gs://bucket-name/path/to/file``) are + supported. The maximum file size is 2.5 MB for + text-based formats, 200 MB for other formats. This field is a member of `oneof`_ ``content``. mime_type (str): The MIME type of the content. Supported types: - - ``application/pdf`` (PDF, only native PDFs are supported - for now) - - ``text/html`` (HTML) - - ``text/plain`` (TXT) - - ``application/xml`` or ``text/xml`` (XML) - - ``application/json`` (JSON) - - ``application/vnd.openxmlformats-officedocument.wordprocessingml.document`` - (DOCX) - - ``application/vnd.openxmlformats-officedocument.presentationml.presentation`` - (PPTX) - - ``application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`` - (XLSX) - - ``application/vnd.ms-excel.sheet.macroenabled.12`` (XLSM) - - The following types are supported only if layout parser is - enabled in the data store: - - - ``image/bmp`` (BMP) - - ``image/gif`` (GIF) - - ``image/jpeg`` (JPEG) - - ``image/png`` (PNG) - - ``image/tiff`` (TIFF) + * ``application/pdf`` (PDF, only native PDFs are + supported for now) + + * ``text/html`` (HTML) + * ``text/plain`` (TXT) + + * ``application/xml`` or ``text/xml`` (XML) + * ``application/json`` (JSON) + + * + ``application/vnd.openxmlformats-officedocument.wordprocessingml.document`` + (DOCX) * + ``application/vnd.openxmlformats-officedocument.presentationml.presentation`` + (PPTX) + + * + ``application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`` + (XLSX) + + * + ``application/vnd.ms-excel.sheet.macroenabled.12`` + (XLSM) + + The following types are supported only if layout + parser is enabled in the data store: + + * ``image/bmp`` (BMP) + * ``image/gif`` (GIF) + + * ``image/jpeg`` (JPEG) + * ``image/png`` (PNG) + + * ``image/tiff`` (TIFF) See https://www.iana.org/assignments/media-types/media-types.xhtml. @@ -198,16 +218,59 @@ class AccessRestriction(proto.Message): Document Hierarchy - Space_S --> Page_P. - Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 - - Space_S ACL Restriction - { "acl_info": { "readers": [ { - "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] - } ] } } - - Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": - [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": - "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { - "user_id": "user_1" } ], } ] } } + Readers: + + Space_S: group_1, user_1 + Page_P: group_2, group_3, user_2 + + Space_S ACL Restriction - + { + "acl_info": { + "readers": [ + { + "principals": [ + { + "group_id": "group_1" + }, + { + "user_id": "user_1" + } + ] + } + ] + } + } + + Page_P ACL Restriction. + { + "acl_info": { + "readers": [ + { + "principals": [ + { + "group_id": "group_2" + }, + { + "group_id": "group_3" + }, + { + "user_id": "user_2" + } + ], + }, + { + "principals": [ + { + "group_id": "group_1" + }, + { + "user_id": "user_1" + } + ], + } + ] + } + } Attributes: principals (MutableSequence[google.cloud.discoveryengine_v1.types.Principal]): diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/document_processing_config.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/document_processing_config.py index 319afeb26b8d..5b2e162074b3 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/document_processing_config.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/document_processing_config.py @@ -29,17 +29,19 @@ class DocumentProcessingConfig(proto.Message): r"""A singleton resource of - [DataStore][google.cloud.discoveryengine.v1.DataStore]. If it's - empty when [DataStore][google.cloud.discoveryengine.v1.DataStore] is - created and [DataStore][google.cloud.discoveryengine.v1.DataStore] - is set to - [DataStore.ContentConfig.CONTENT_REQUIRED][google.cloud.discoveryengine.v1.DataStore.ContentConfig.CONTENT_REQUIRED], + `DataStore `__. If + it's empty when `DataStore + `__ is created and + `DataStore `__ is set + to `DataStore.ContentConfig.CONTENT_REQUIRED + `__, the default parser will default to digital parser. Attributes: name (str): - The full resource name of the Document Processing Config. - Format: + The full resource name of the Document + Processing Config. Format: + ``projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig``. chunking_config (google.cloud.discoveryengine_v1.types.DocumentProcessingConfig.ChunkingConfig): Whether chunking mode is enabled. @@ -50,22 +52,33 @@ class DocumentProcessingConfig(proto.Message): parsing config will be applied to all file types for Document parsing. parsing_config_overrides (MutableMapping[str, google.cloud.discoveryengine_v1.types.DocumentProcessingConfig.ParsingConfig]): - Map from file type to override the default parsing - configuration based on the file type. Supported keys: - - - ``pdf``: Override parsing config for PDF files, either - digital parsing, ocr parsing or layout parsing is - supported. - - ``html``: Override parsing config for HTML files, only - digital parsing and layout parsing are supported. - - ``docx``: Override parsing config for DOCX files, only - digital parsing and layout parsing are supported. - - ``pptx``: Override parsing config for PPTX files, only - digital parsing and layout parsing are supported. - - ``xlsm``: Override parsing config for XLSM files, only - digital parsing and layout parsing are supported. - - ``xlsx``: Override parsing config for XLSX files, only - digital parsing and layout parsing are supported. + Map from file type to override the default + parsing configuration based on the file type. + Supported keys: + + * ``pdf``: Override parsing config for PDF + files, either digital parsing, ocr parsing or + layout parsing is supported. + + * ``html``: Override parsing config for HTML + files, only digital parsing and layout parsing + are supported. + + * ``docx``: Override parsing config for DOCX + files, only digital parsing and layout parsing + are supported. + + * ``pptx``: Override parsing config for PPTX + files, only digital parsing and layout parsing + are supported. + + * ``xlsm``: Override parsing config for XLSM + files, only digital parsing and layout parsing + are supported. + + * ``xlsx``: Override parsing config for XLSX + files, only digital parsing and layout parsing + are supported. """ class ChunkingConfig(proto.Message): @@ -148,8 +161,9 @@ class OcrParsingConfig(proto.Message): Attributes: enhanced_document_elements (MutableSequence[str]): - [DEPRECATED] This field is deprecated. To use the additional - enhanced document elements processing, please switch to + [DEPRECATED] This field is deprecated. To use + the additional enhanced document elements + processing, please switch to ``layout_parsing_config``. use_native_text (bool): If true, will use native text instead of OCR @@ -176,10 +190,10 @@ class LayoutParsingConfig(proto.Message): Optional. If true, the LLM based annotation is added to the image during parsing. structured_content_types (MutableSequence[str]): - Optional. Contains the required structure types to extract - from the document. Supported values: + Optional. Contains the required structure types + to extract from the document. Supported values: - - ``shareholder-structure`` + * ``shareholder-structure`` exclude_html_elements (MutableSequence[str]): Optional. List of HTML elements to exclude from the parsed content. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/document_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/document_service.py index 6a4718de16f0..d9edd210c506 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/document_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/document_service.py @@ -40,24 +40,28 @@ class GetDocumentRequest(proto.Message): r"""Request message for - [DocumentService.GetDocument][google.cloud.discoveryengine.v1.DocumentService.GetDocument] + `DocumentService.GetDocument + `__ method. Attributes: name (str): Required. Full resource name of - [Document][google.cloud.discoveryengine.v1.Document], such - as + `Document + `__, + such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}``. - If the caller does not have permission to access the - [Document][google.cloud.discoveryengine.v1.Document], + If the caller does not have permission to access + the `Document + `__, regardless of whether or not it exists, a ``PERMISSION_DENIED`` error is returned. - If the requested - [Document][google.cloud.discoveryengine.v1.Document] does - not exist, a ``NOT_FOUND`` error is returned. + If the requested `Document + `__ + does not exist, a ``NOT_FOUND`` error is + returned. """ name: str = proto.Field( @@ -68,39 +72,49 @@ class GetDocumentRequest(proto.Message): class ListDocumentsRequest(proto.Message): r"""Request message for - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments] + `DocumentService.ListDocuments + `__ method. Attributes: parent (str): - Required. The parent branch resource name, such as + Required. The parent branch resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. - Use ``default_branch`` as the branch ID, to list documents - under the default branch. + Use ``default_branch`` as the branch ID, to list + documents under the default branch. If the caller does not have permission to list - [Document][google.cloud.discoveryengine.v1.Document]s under - this branch, regardless of whether or not this branch - exists, a ``PERMISSION_DENIED`` error is returned. + `Document + `__s + under this branch, regardless of whether or not + this branch exists, a ``PERMISSION_DENIED`` + error is returned. page_size (int): - Maximum number of - [Document][google.cloud.discoveryengine.v1.Document]s to - return. If unspecified, defaults to 100. The maximum allowed - value is 1000. Values above 1000 are set to 1000. + Maximum number of `Document + `__s + to return. If unspecified, defaults to 100. The + maximum allowed value is 1000. Values above 1000 + are set to 1000. - If this field is negative, an ``INVALID_ARGUMENT`` error is - returned. + If this field is negative, an + ``INVALID_ARGUMENT`` error is returned. page_token (str): A page token - [ListDocumentsResponse.next_page_token][google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token], + `ListDocumentsResponse.next_page_token + `__, received from a previous - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments] - call. Provide this to retrieve the subsequent page. - - When paginating, all other parameters provided to - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments] - must match the call that provided the page token. Otherwise, - an ``INVALID_ARGUMENT`` error is returned. + `DocumentService.ListDocuments + `__ + call. Provide this to retrieve the subsequent + page. + + When paginating, all other parameters provided + to `DocumentService.ListDocuments + `__ + must match the call that provided the page + token. Otherwise, an ``INVALID_ARGUMENT`` error + is returned. """ parent: str = proto.Field( @@ -119,17 +133,20 @@ class ListDocumentsRequest(proto.Message): class ListDocumentsResponse(proto.Message): r"""Response message for - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments] + `DocumentService.ListDocuments + `__ method. Attributes: documents (MutableSequence[google.cloud.discoveryengine_v1.types.Document]): - The [Document][google.cloud.discoveryengine.v1.Document]s. + The `Document + `__s. next_page_token (str): A token that can be sent as - [ListDocumentsRequest.page_token][google.cloud.discoveryengine.v1.ListDocumentsRequest.page_token] - to retrieve the next page. If this field is omitted, there - are no subsequent pages. + `ListDocumentsRequest.page_token + `__ + to retrieve the next page. If this field is + omitted, there are no subsequent pages. """ @property @@ -149,7 +166,8 @@ def raw_page(self): class CreateDocumentRequest(proto.Message): r"""Request message for - [DocumentService.CreateDocument][google.cloud.discoveryengine.v1.DocumentService.CreateDocument] + `DocumentService.CreateDocument + `__ method. Attributes: @@ -157,30 +175,36 @@ class CreateDocumentRequest(proto.Message): Required. The parent resource name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. document (google.cloud.discoveryengine_v1.types.Document): - Required. The - [Document][google.cloud.discoveryengine.v1.Document] to + Required. The `Document + `__ to create. document_id (str): Required. The ID to use for the - [Document][google.cloud.discoveryengine.v1.Document], which - becomes the final component of the - [Document.name][google.cloud.discoveryengine.v1.Document.name]. - - If the caller does not have permission to create the - [Document][google.cloud.discoveryengine.v1.Document], + `Document + `__, + which becomes the final component of the + `Document.name + `__. + + If the caller does not have permission to create + the `Document + `__, regardless of whether or not it exists, a ``PERMISSION_DENIED`` error is returned. This field must be unique among all - [Document][google.cloud.discoveryengine.v1.Document]s with - the same - [parent][google.cloud.discoveryengine.v1.CreateDocumentRequest.parent]. - Otherwise, an ``ALREADY_EXISTS`` error is returned. - - This field must conform to - `RFC-1034 `__ standard - with a length limit of 128 characters. Otherwise, an - ``INVALID_ARGUMENT`` error is returned. + `Document + `__s + with the same `parent + `__. + Otherwise, an ``ALREADY_EXISTS`` error is + returned. + + This field must conform to `RFC-1034 + `__ + standard with a length limit of 128 characters. + Otherwise, an ``INVALID_ARGUMENT`` error is + returned. """ parent: str = proto.Field( @@ -200,28 +224,33 @@ class CreateDocumentRequest(proto.Message): class UpdateDocumentRequest(proto.Message): r"""Request message for - [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1.DocumentService.UpdateDocument] + `DocumentService.UpdateDocument + `__ method. Attributes: document (google.cloud.discoveryengine_v1.types.Document): Required. The document to update/create. - If the caller does not have permission to update the - [Document][google.cloud.discoveryengine.v1.Document], + If the caller does not have permission to update + the `Document + `__, regardless of whether or not it exists, a ``PERMISSION_DENIED`` error is returned. - If the [Document][google.cloud.discoveryengine.v1.Document] - to update does not exist and - [allow_missing][google.cloud.discoveryengine.v1.UpdateDocumentRequest.allow_missing] + If the `Document + `__ to + update does not exist and + `allow_missing + `__ is not set, a ``NOT_FOUND`` error is returned. allow_missing (bool): If set to ``true`` and the - [Document][google.cloud.discoveryengine.v1.Document] is not - found, a new - [Document][google.cloud.discoveryengine.v1.Document] is be - created. + `Document + `__ is + not found, a new `Document + `__ is + be created. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided imported 'document' to update. If not set, by @@ -246,23 +275,28 @@ class UpdateDocumentRequest(proto.Message): class DeleteDocumentRequest(proto.Message): r"""Request message for - [DocumentService.DeleteDocument][google.cloud.discoveryengine.v1.DocumentService.DeleteDocument] + `DocumentService.DeleteDocument + `__ method. Attributes: name (str): Required. Full resource name of - [Document][google.cloud.discoveryengine.v1.Document], such - as + `Document + `__, + such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}``. - If the caller does not have permission to delete the - [Document][google.cloud.discoveryengine.v1.Document], + If the caller does not have permission to delete + the `Document + `__, regardless of whether or not it exists, a ``PERMISSION_DENIED`` error is returned. - If the [Document][google.cloud.discoveryengine.v1.Document] - to delete does not exist, a ``NOT_FOUND`` error is returned. + If the `Document + `__ to + delete does not exist, a ``NOT_FOUND`` error is + returned. """ name: str = proto.Field( @@ -273,21 +307,24 @@ class DeleteDocumentRequest(proto.Message): class BatchGetDocumentsMetadataRequest(proto.Message): r"""Request message for - [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1.DocumentService.BatchGetDocumentsMetadata] + `DocumentService.BatchGetDocumentsMetadata + `__ method. Attributes: parent (str): - Required. The parent branch resource name, such as + Required. The parent branch resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. matcher (google.cloud.discoveryengine_v1.types.BatchGetDocumentsMetadataRequest.Matcher): Required. Matcher for the - [Document][google.cloud.discoveryengine.v1.Document]s. + `Document + `__s. """ class UrisMatcher(proto.Message): - r"""Matcher for the - [Document][google.cloud.discoveryengine.v1.Document]s by exact uris. + r"""Matcher for the `Document + `__s by exact uris. Attributes: uris (MutableSequence[str]): @@ -300,13 +337,15 @@ class UrisMatcher(proto.Message): ) class FhirMatcher(proto.Message): - r"""Matcher for the - [Document][google.cloud.discoveryengine.v1.Document]s by FHIR - resource names. + r"""Matcher for the `Document + `__s by FHIR resource + names. Attributes: fhir_resources (MutableSequence[str]): - Required. The FHIR resources to match by. Format: + Required. The FHIR resources to match by. + Format: + projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} """ @@ -316,8 +355,8 @@ class FhirMatcher(proto.Message): ) class Matcher(proto.Message): - r"""Matcher for the - [Document][google.cloud.discoveryengine.v1.Document]s. Currently + r"""Matcher for the `Document + `__s. Currently supports matching by exact URIs. This message has `oneof`_ fields (mutually exclusive fields). @@ -364,31 +403,36 @@ class Matcher(proto.Message): class BatchGetDocumentsMetadataResponse(proto.Message): r"""Response message for - [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1.DocumentService.BatchGetDocumentsMetadata] + `DocumentService.BatchGetDocumentsMetadata + `__ method. Attributes: documents_metadata (MutableSequence[google.cloud.discoveryengine_v1.types.BatchGetDocumentsMetadataResponse.DocumentMetadata]): - The metadata of the - [Document][google.cloud.discoveryengine.v1.Document]s. + The metadata of the `Document + `__s. """ class State(proto.Enum): - r"""The state of the - [Document][google.cloud.discoveryengine.v1.Document]. + r"""The state of the `Document + `__. Values: STATE_UNSPECIFIED (0): Should never be set. INDEXED (1): - The [Document][google.cloud.discoveryengine.v1.Document] is + The `Document + `__ is indexed. NOT_IN_TARGET_SITE (2): - The [Document][google.cloud.discoveryengine.v1.Document] is + The `Document + `__ is not indexed because its URI is not in the - [TargetSite][google.cloud.discoveryengine.v1.TargetSite]. + `TargetSite + `__. NOT_IN_INDEX (3): - The [Document][google.cloud.discoveryengine.v1.Document] is + The `Document + `__ is not indexed. """ STATE_UNSPECIFIED = 0 @@ -397,34 +441,36 @@ class State(proto.Enum): NOT_IN_INDEX = 3 class DocumentMetadata(proto.Message): - r"""The metadata of a - [Document][google.cloud.discoveryengine.v1.Document]. + r"""The metadata of a `Document + `__. Attributes: matcher_value (google.cloud.discoveryengine_v1.types.BatchGetDocumentsMetadataResponse.DocumentMetadata.MatcherValue): - The value of the matcher that was used to match the - [Document][google.cloud.discoveryengine.v1.Document]. + The value of the matcher that was used to match + the `Document + `__. state (google.cloud.discoveryengine_v1.types.BatchGetDocumentsMetadataResponse.State): The state of the document. last_refreshed_time (google.protobuf.timestamp_pb2.Timestamp): The timestamp of the last time the - [Document][google.cloud.discoveryengine.v1.Document] was - last indexed. + `Document + `__ + was last indexed. data_ingestion_source (str): The data ingestion source of the - [Document][google.cloud.discoveryengine.v1.Document]. + `Document + `__. Allowed values are: - - ``batch``: Data ingested via Batch API, e.g., - ImportDocuments. - - ``streaming`` Data ingested via Streaming API, e.g., FHIR - streaming. + * ``batch``: Data ingested via Batch API, e.g., + ImportDocuments. * ``streaming`` Data ingested + via Streaming API, e.g., FHIR streaming. """ class MatcherValue(proto.Message): r"""The value of the matcher that was used to match the - [Document][google.cloud.discoveryengine.v1.Document]. + `Document `__. This message has `oneof`_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. @@ -436,11 +482,13 @@ class MatcherValue(proto.Message): Attributes: uri (str): If match by URI, the URI of the - [Document][google.cloud.discoveryengine.v1.Document]. + `Document + `__. This field is a member of `oneof`_ ``matcher_value``. fhir_resource (str): Format: + projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} This field is a member of `oneof`_ ``matcher_value``. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/engine.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/engine.py index 6269a62ef070..1da567b08cd2 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/engine.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/engine.py @@ -31,8 +31,8 @@ class Engine(proto.Message): - r"""Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1.Engine]. + r"""Metadata that describes the training and serving parameters of + an `Engine `__. This message has `oneof`_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. @@ -43,49 +43,56 @@ class Engine(proto.Message): Attributes: chat_engine_config (google.cloud.discoveryengine_v1.types.Engine.ChatEngineConfig): - Configurations for the Chat Engine. Only applicable if - [solution_type][google.cloud.discoveryengine.v1.Engine.solution_type] - is - [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_CHAT]. + Configurations for the Chat Engine. Only + applicable if `solution_type + `__ + is `SOLUTION_TYPE_CHAT + `__. This field is a member of `oneof`_ ``engine_config``. search_engine_config (google.cloud.discoveryengine_v1.types.Engine.SearchEngineConfig): - Configurations for the Search Engine. Only applicable if - [solution_type][google.cloud.discoveryengine.v1.Engine.solution_type] - is - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH]. + Configurations for the Search Engine. Only + applicable if `solution_type + `__ + is `SOLUTION_TYPE_SEARCH + `__. This field is a member of `oneof`_ ``engine_config``. media_recommendation_engine_config (google.cloud.discoveryengine_v1.types.Engine.MediaRecommendationEngineConfig): - Configurations for the Media Engine. Only applicable on the - data stores with - [solution_type][google.cloud.discoveryengine.v1.Engine.solution_type] - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_RECOMMENDATION] + Configurations for the Media Engine. Only + applicable on the data stores with + `solution_type + `__ + `SOLUTION_TYPE_RECOMMENDATION + `__ and - [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1.IndustryVertical.MEDIA] + `IndustryVertical.MEDIA + `__ vertical. This field is a member of `oneof`_ ``engine_config``. chat_engine_metadata (google.cloud.discoveryengine_v1.types.Engine.ChatEngineMetadata): - Output only. Additional information of the Chat Engine. Only - applicable if - [solution_type][google.cloud.discoveryengine.v1.Engine.solution_type] + Output only. Additional information of the Chat + Engine. Only applicable if `solution_type + `__ is - [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_CHAT]. + `SOLUTION_TYPE_CHAT + `__. This field is a member of `oneof`_ ``engine_metadata``. name (str): - Immutable. Identifier. The fully qualified resource name of - the engine. - - This field must be a UTF-8 encoded string with a length - limit of 1024 characters. + Immutable. Identifier. The fully qualified + resource name of the engine. + This field must be a UTF-8 encoded string with a + length limit of 1024 characters. Format: + ``projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`` - engine should be 1-63 characters, and valid characters are - /[a-z0-9][a-z0-9-\_]*/. Otherwise, an INVALID_ARGUMENT error - is returned. + engine should be 1-63 characters, and valid + characters are /`a-z0-9 `__*/. + Otherwise, an INVALID_ARGUMENT error is + returned. display_name (str): Required. The display name of the engine. Should be human readable. UTF-8 encoded string @@ -97,37 +104,41 @@ class Engine(proto.Message): Output only. Timestamp the Recommendation Engine was last updated. data_store_ids (MutableSequence[str]): - Optional. The data stores associated with this engine. - + Optional. The data stores associated with this + engine. For - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH] + `SOLUTION_TYPE_SEARCH + `__ and - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_RECOMMENDATION] - type of engines, they can only associate with at most one - data store. - - If - [solution_type][google.cloud.discoveryengine.v1.Engine.solution_type] - is - [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_CHAT], - multiple - [DataStore][google.cloud.discoveryengine.v1.DataStore]s in - the same - [Collection][google.cloud.discoveryengine.v1.Collection] can - be associated here. + `SOLUTION_TYPE_RECOMMENDATION + `__ + type of engines, they can only associate with at + most one data store. + + If `solution_type + `__ + is `SOLUTION_TYPE_CHAT + `__, + multiple `DataStore + `__s + in the same `Collection + `__ + can be associated here. Note that when used in - [CreateEngineRequest][google.cloud.discoveryengine.v1.CreateEngineRequest], - one DataStore id must be provided as the system will use it - for necessary initializations. + `CreateEngineRequest + `__, + one DataStore id must be provided as the system + will use it for necessary initializations. solution_type (google.cloud.discoveryengine_v1.types.SolutionType): Required. The solutions of the engine. industry_vertical (google.cloud.discoveryengine_v1.types.IndustryVertical): - Optional. The industry vertical that the engine registers. - The restriction of the Engine industry vertical is based on - [DataStore][google.cloud.discoveryengine.v1.DataStore]: - Vertical on Engine has to match vertical of the DataStore - linked to the engine. + Optional. The industry vertical that the engine + registers. The restriction of the Engine + industry vertical is based on `DataStore + `__: + Vertical on Engine has to match vertical of the + DataStore linked to the engine. common_config (google.cloud.discoveryengine_v1.types.Engine.CommonConfig): Common config spec that specifies the metadata of the engine. @@ -143,11 +154,13 @@ class SearchEngineConfig(proto.Message): search_tier (google.cloud.discoveryengine_v1.types.SearchTier): The search feature tier of this engine. - Different tiers might have different pricing. To learn more, - check the pricing documentation. + Different tiers might have different + pricing. To learn more, check the pricing + documentation. Defaults to - [SearchTier.SEARCH_TIER_STANDARD][google.cloud.discoveryengine.v1.SearchTier.SEARCH_TIER_STANDARD] + `SearchTier.SEARCH_TIER_STANDARD + `__ if not specified. search_add_ons (MutableSequence[google.cloud.discoveryengine_v1.types.SearchAddOn]): The add-on that this search engine enables. @@ -169,51 +182,60 @@ class MediaRecommendationEngineConfig(proto.Message): Attributes: type_ (str): - Required. The type of engine. e.g., ``recommended-for-you``. - + Required. The type of engine. e.g., + ``recommended-for-you``. This field together with - [optimization_objective][google.cloud.discoveryengine.v1.Engine.MediaRecommendationEngineConfig.optimization_objective] - describe engine metadata to use to control engine training - and serving. + `optimization_objective + `__ + describe engine metadata to use to control + engine training and serving. - Currently supported values: ``recommended-for-you``, + Currently supported values: + ``recommended-for-you``, ``others-you-may-like``, ``more-like-this``, ``most-popular-items``. optimization_objective (str): The optimization objective. e.g., ``cvr``. This field together with - [optimization_objective][google.cloud.discoveryengine.v1.Engine.MediaRecommendationEngineConfig.type] - describe engine metadata to use to control engine training - and serving. + `optimization_objective + `__ + describe engine metadata to use to control + engine training and serving. - Currently supported values: ``ctr``, ``cvr``. + Currently supported + values: ``ctr``, ``cvr``. - If not specified, we choose default based on engine type. - Default depends on type of recommendation: + If not specified, we choose default based on + engine type. Default depends on type of + recommendation: ``recommended-for-you`` => ``ctr`` ``others-you-may-like`` => ``ctr`` optimization_objective_config (google.cloud.discoveryengine_v1.types.Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig): Name and value of the custom threshold for cvr - optimization_objective. For target_field ``watch-time``, - target_field_value must be an integer value indicating the - media progress time in seconds between (0, 86400] (excludes - 0, includes 86400) (e.g., 90). For target_field - ``watch-percentage``, the target_field_value must be a valid - float value between (0, 1.0] (excludes 0, includes 1.0) + optimization_objective. For target_field + ``watch-time``, target_field_value must be an + integer value indicating the media progress time + in seconds between (0, 86400] (excludes 0, + includes 86400) (e.g., 90). + For target_field ``watch-percentage``, the + target_field_value must be a valid float value + between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5). training_state (google.cloud.discoveryengine_v1.types.Engine.MediaRecommendationEngineConfig.TrainingState): - The training state that the engine is in (e.g. ``TRAINING`` - or ``PAUSED``). - - Since part of the cost of running the service is frequency - of training - this can be used to determine when to train - engine in order to control cost. If not specified: the - default value for ``CreateEngine`` method is ``TRAINING``. - The default value for ``UpdateEngine`` method is to keep the - state the same as before. + The training state that the engine is in (e.g. + ``TRAINING`` or ``PAUSED``). + + Since part of the cost of running the service is + frequency of training - this can be used to + determine when to train engine in order to + control cost. If not specified: the default + value for ``CreateEngine`` method is + ``TRAINING``. The default value for + ``UpdateEngine`` method is to keep the state the + same as before. engine_features_config (google.cloud.discoveryengine_v1.types.Engine.MediaRecommendationEngineConfig.EngineFeaturesConfig): Optional. Additional engine features config. """ @@ -238,8 +260,9 @@ class OptimizationObjectiveConfig(proto.Message): Attributes: target_field (str): - Required. The name of the field to target. Currently - supported values: ``watch-percentage``, ``watch-time``. + Required. The name of the field to target. + Currently supported values: + ``watch-percentage``, ``watch-time``. target_field_value_float (float): Required. The threshold to be applied to the target (e.g., 0.5). @@ -294,15 +317,18 @@ class RecommendedForYouFeatureConfig(proto.Message): Attributes: context_event_type (str): - The type of event with which the engine is queried at - prediction time. If set to ``generic``, only ``view-item``, - ``media-play``,and ``media-complete`` will be used as - ``context-event`` in engine training. If set to - ``view-home-page``, ``view-home-page`` will also be used as - ``context-events`` in addition to ``view-item``, - ``media-play``, and ``media-complete``. Currently supported - for the ``recommended-for-you`` engine. Currently supported - values: ``view-home-page``, ``generic``. + The type of event with which the engine is + queried at prediction time. If set to + ``generic``, only ``view-item``, + ``media-play``,and ``media-complete`` will be + used as ``context-event`` in engine training. If + set to ``view-home-page``, ``view-home-page`` + will also be used as ``context-events`` in + addition to ``view-item``, ``media-play``, and + ``media-complete``. Currently supported for the + ``recommended-for-you`` engine. Currently + supported values: ``view-home-page``, + ``generic``. """ context_event_type: str = proto.Field( @@ -316,10 +342,11 @@ class MostPopularFeatureConfig(proto.Message): Attributes: time_window_days (int): - The time window of which the engine is queried at training - and prediction time. Positive integers only. The value - translates to the last X days of events. Currently required - for the ``most-popular-items`` engine. + The time window of which the engine is queried + at training and prediction time. Positive + integers only. The value translates to the last + X days of events. Currently required for the + ``most-popular-items`` engine. """ time_window_days: int = proto.Field( @@ -358,58 +385,70 @@ class ChatEngineConfig(proto.Message): Attributes: agent_creation_config (google.cloud.discoveryengine_v1.types.Engine.ChatEngineConfig.AgentCreationConfig): - The configurationt generate the Dialogflow agent that is - associated to this Engine. - - Note that these configurations are one-time consumed by and - passed to Dialogflow service. It means they cannot be - retrieved using - [EngineService.GetEngine][google.cloud.discoveryengine.v1.EngineService.GetEngine] + The configurationt generate the Dialogflow agent + that is associated to this Engine. + + Note that these configurations are one-time + consumed by and passed to Dialogflow service. It + means they cannot be retrieved using + `EngineService.GetEngine + `__ or - [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines] + `EngineService.ListEngines + `__ API after engine creation. dialogflow_agent_to_link (str): - The resource name of an exist Dialogflow agent to link to - this Chat Engine. Customers can either provide - ``agent_creation_config`` to create agent or provide an - agent name that links the agent with the Chat engine. - - Format: - ``projects//locations//agents/``. - - Note that the ``dialogflow_agent_to_link`` are one-time - consumed by and passed to Dialogflow service. It means they - cannot be retrieved using - [EngineService.GetEngine][google.cloud.discoveryengine.v1.EngineService.GetEngine] + The resource name of an exist Dialogflow agent + to link to this Chat Engine. Customers can + either provide ``agent_creation_config`` to + create agent or provide an agent name that links + the agent with the Chat engine. + + Format: ``projects//locations//agents/``. + + Note that the ``dialogflow_agent_to_link`` are + one-time consumed by and passed to Dialogflow + service. It means they cannot be retrieved using + `EngineService.GetEngine + `__ or - [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines] + `EngineService.ListEngines + `__ API after engine creation. Use - [ChatEngineMetadata.dialogflow_agent][google.cloud.discoveryengine.v1.Engine.ChatEngineMetadata.dialogflow_agent] - for actual agent association after Engine is created. + `ChatEngineMetadata.dialogflow_agent + `__ + for actual agent association after Engine is + created. allow_cross_region (bool): - Optional. If the flag set to true, we allow the agent and - engine are in different locations, otherwise the agent and - engine are required to be in the same location. The flag is - set to false by default. - - Note that the ``allow_cross_region`` are one-time consumed - by and passed to - [EngineService.CreateEngine][google.cloud.discoveryengine.v1.EngineService.CreateEngine]. + Optional. If the flag set to true, we allow the + agent and engine are in different locations, + otherwise the agent and engine are required to + be in the same location. The flag is set to + false by default. + + Note that the ``allow_cross_region`` are + one-time consumed by and passed to + `EngineService.CreateEngine + `__. It means they cannot be retrieved using - [EngineService.GetEngine][google.cloud.discoveryengine.v1.EngineService.GetEngine] + `EngineService.GetEngine + `__ or - [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines] + `EngineService.ListEngines + `__ API after engine creation. """ class AgentCreationConfig(proto.Message): r"""Configurations for generating a Dialogflow agent. - Note that these configurations are one-time consumed by and passed - to Dialogflow service. It means they cannot be retrieved using - [EngineService.GetEngine][google.cloud.discoveryengine.v1.EngineService.GetEngine] - or - [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines] + Note that these configurations are one-time consumed by and + passed to Dialogflow service. It means they cannot be retrieved + using `EngineService.GetEngine + `__ or + `EngineService.ListEngines + `__ API after engine creation. Attributes: @@ -419,13 +458,16 @@ class AgentCreationConfig(proto.Message): knowledge connector LLM prompt and for knowledge search. default_language_code (str): - Required. The default language of the agent as a language - tag. See `Language - Support `__ - for a list of the currently supported language codes. + Required. The default language of the agent as a + language tag. See `Language + Support + `__ + for a list of the currently supported language + codes. time_zone (str): - Required. The time zone of the agent from the `time zone - database `__, e.g., + Required. The time zone of the agent from the + `time zone database + `__, e.g., America/New_York, Europe/Paris. location (str): Agent location for Agent creation, supported @@ -489,11 +531,11 @@ class ChatEngineMetadata(proto.Message): Attributes: dialogflow_agent (str): - The resource name of a Dialogflow agent, that this Chat - Engine refers to. + The resource name of a Dialogflow agent, that + this Chat Engine refers to. - Format: - ``projects//locations//agents/``. + Format: ``projects//locations//agents/``. """ dialogflow_agent: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/engine_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/engine_service.py index 484dbbcd23e3..37d88767c6c5 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/engine_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/engine_service.py @@ -40,7 +40,8 @@ class CreateEngineRequest(proto.Message): r"""Request for - [EngineService.CreateEngine][google.cloud.discoveryengine.v1.EngineService.CreateEngine] + `EngineService.CreateEngine + `__ method. Attributes: @@ -48,19 +49,23 @@ class CreateEngineRequest(proto.Message): Required. The parent resource name, such as ``projects/{project}/locations/{location}/collections/{collection}``. engine (google.cloud.discoveryengine_v1.types.Engine): - Required. The - [Engine][google.cloud.discoveryengine.v1.Engine] to create. + Required. The `Engine + `__ to + create. engine_id (str): Required. The ID to use for the - [Engine][google.cloud.discoveryengine.v1.Engine], which will - become the final component of the - [Engine][google.cloud.discoveryengine.v1.Engine]'s resource - name. - - This field must conform to - `RFC-1034 `__ standard - with a length limit of 63 characters. Otherwise, an - INVALID_ARGUMENT error is returned. + `Engine + `__, + which will become the final component of the + `Engine + `__'s + resource name. + + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 characters. + Otherwise, an INVALID_ARGUMENT error is + returned. """ parent: str = proto.Field( @@ -80,7 +85,8 @@ class CreateEngineRequest(proto.Message): class CreateEngineMetadata(proto.Message): r"""Metadata related to the progress of the - [EngineService.CreateEngine][google.cloud.discoveryengine.v1.EngineService.CreateEngine] + `EngineService.CreateEngine + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -106,22 +112,28 @@ class CreateEngineMetadata(proto.Message): class DeleteEngineRequest(proto.Message): r"""Request message for - [EngineService.DeleteEngine][google.cloud.discoveryengine.v1.EngineService.DeleteEngine] + `EngineService.DeleteEngine + `__ method. Attributes: name (str): Required. Full resource name of - [Engine][google.cloud.discoveryengine.v1.Engine], such as + `Engine + `__, + such as ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. - If the caller does not have permission to delete the - [Engine][google.cloud.discoveryengine.v1.Engine], regardless - of whether or not it exists, a PERMISSION_DENIED error is - returned. + If the caller does not have permission to delete + the `Engine + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. - If the [Engine][google.cloud.discoveryengine.v1.Engine] to - delete does not exist, a NOT_FOUND error is returned. + If the `Engine + `__ to + delete does not exist, a NOT_FOUND error is + returned. """ name: str = proto.Field( @@ -132,7 +144,8 @@ class DeleteEngineRequest(proto.Message): class DeleteEngineMetadata(proto.Message): r"""Metadata related to the progress of the - [EngineService.DeleteEngine][google.cloud.discoveryengine.v1.EngineService.DeleteEngine] + `EngineService.DeleteEngine + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -158,13 +171,16 @@ class DeleteEngineMetadata(proto.Message): class GetEngineRequest(proto.Message): r"""Request message for - [EngineService.GetEngine][google.cloud.discoveryengine.v1.EngineService.GetEngine] + `EngineService.GetEngine + `__ method. Attributes: name (str): Required. Full resource name of - [Engine][google.cloud.discoveryengine.v1.Engine], such as + `Engine + `__, + such as ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. """ @@ -176,7 +192,8 @@ class GetEngineRequest(proto.Message): class ListEnginesRequest(proto.Message): r"""Request message for - [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines] + `EngineService.ListEngines + `__ method. Attributes: @@ -212,13 +229,14 @@ class ListEnginesRequest(proto.Message): class ListEnginesResponse(proto.Message): r"""Response message for - [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines] + `EngineService.ListEngines + `__ method. Attributes: engines (MutableSequence[google.cloud.discoveryengine_v1.types.Engine]): - All the customer's - [Engine][google.cloud.discoveryengine.v1.Engine]s. + All the customer's `Engine + `__s. next_page_token (str): Not supported. """ @@ -240,27 +258,32 @@ def raw_page(self): class UpdateEngineRequest(proto.Message): r"""Request message for - [EngineService.UpdateEngine][google.cloud.discoveryengine.v1.EngineService.UpdateEngine] + `EngineService.UpdateEngine + `__ method. Attributes: engine (google.cloud.discoveryengine_v1.types.Engine): - Required. The - [Engine][google.cloud.discoveryengine.v1.Engine] to update. - - If the caller does not have permission to update the - [Engine][google.cloud.discoveryengine.v1.Engine], regardless - of whether or not it exists, a PERMISSION_DENIED error is + Required. The `Engine + `__ to + update. If the caller does not have permission + to update the `Engine + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. + + If the `Engine + `__ to + update does not exist, a NOT_FOUND error is returned. - - If the [Engine][google.cloud.discoveryengine.v1.Engine] to - update does not exist, a NOT_FOUND error is returned. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [Engine][google.cloud.discoveryengine.v1.Engine] to update. + `Engine + `__ to + update. - If an unsupported or unknown field is provided, an - INVALID_ARGUMENT error is returned. + If an unsupported or unknown field is provided, + an INVALID_ARGUMENT error is returned. """ engine: gcd_engine.Engine = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/grounded_generation_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/grounded_generation_service.py index 31c733582e6a..64fd48f334da 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/grounded_generation_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/grounded_generation_service.py @@ -40,13 +40,13 @@ class GroundedGenerationContent(proto.Message): Attributes: role (str): - Producer of the content. Must be either ``user`` or - ``model``. - - Intended to be used for multi-turn conversations. Otherwise, - it can be left unset. + Producer of the content. Must be either ``user`` + or ``model``. + Intended to be used for multi-turn + conversations. Otherwise, it can be left unset. parts (MutableSequence[google.cloud.discoveryengine_v1.types.GroundedGenerationContent.Part]): - Ordered ``Parts`` that constitute a single message. + Ordered ``Parts`` that constitute a single + message. """ class Part(proto.Message): @@ -86,7 +86,8 @@ class GenerateGroundedContentRequest(proto.Message): location (str): Required. Location resource. - Format: ``projects/{project}/locations/{location}``. + Format: + ``projects/{project}/locations/{location}``. system_instruction (google.cloud.discoveryengine_v1.types.GroundedGenerationContent): Content of the system instruction for the current API. @@ -105,26 +106,32 @@ class GenerateGroundedContentRequest(proto.Message): grounding_spec (google.cloud.discoveryengine_v1.types.GenerateGroundedContentRequest.GroundingSpec): Grounding specification. user_labels (MutableMapping[str, str]): - The user labels applied to a resource must meet the - following requirements: - - - Each resource can have multiple labels, up to a maximum of - 64. - - Each label must be a key-value pair. - - Keys have a minimum length of 1 character and a maximum - length of 63 characters and cannot be empty. Values can be - empty and have a maximum length of 63 characters. - - Keys and values can contain only lowercase letters, - numeric characters, underscores, and dashes. All - characters must use UTF-8 encoding, and international - characters are allowed. - - The key portion of a label must be unique. However, you - can use the same key with multiple resources. - - Keys must start with a lowercase letter or international - character. + The user labels applied to a resource must meet + the following requirements: + * Each resource can have multiple labels, up to + a maximum of 64. + + * Each label must be a key-value pair. + * Keys have a minimum length of 1 character and + a maximum length of 63 characters and cannot + be empty. Values can be empty and have a maximum + length of 63 characters. + + * Keys and values can contain only lowercase + letters, numeric characters, underscores, and + dashes. All characters must use UTF-8 encoding, + and international characters are allowed. + + * The key portion of a label must be unique. + However, you can use the same key with + multiple resources. + + * Keys must start with a lowercase letter or + international character. See `Google Cloud - Document `__ + Document + `__ for more details. """ @@ -138,8 +145,9 @@ class GenerationSpec(proto.Message): Specifies which Vertex model id to use for generation. language_code (str): - Language code for content. Use language tags defined by - `BCP47 `__. + Language code for content. Use language tags + defined by `BCP47 + `__. temperature (float): If specified, custom value for the temperature will be used. @@ -320,9 +328,10 @@ class InlineSource(proto.Message): attributes (MutableMapping[str, str]): Attributes associated with the content. - Common attributes include ``source`` (indicating where the - content was sourced from) and ``author`` (indicating the - author of the content). + Common attributes include ``source`` (indicating + where the content was sourced from) and + ``author`` (indicating the author of the + content). """ grounding_facts: MutableSequence[ @@ -346,6 +355,7 @@ class SearchSource(proto.Message): The resource name of the Engine to use. Format: + ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`` max_result_count (int): Number of search results to return. @@ -356,7 +366,8 @@ class SearchSource(proto.Message): Filter expression to be applied to the search. The syntax is the same as - [SearchRequest.filter][google.cloud.discoveryengine.v1.SearchRequest.filter]. + `SearchRequest.filter + `__. safe_search (bool): If set, safe search is enabled in Vertex AI Search requests. @@ -495,8 +506,8 @@ class Candidate(proto.Message): content (google.cloud.discoveryengine_v1.types.GroundedGenerationContent): Content of the candidate. grounding_score (float): - The overall grounding score for the candidate, in the range - of [0, 1]. + The overall grounding score for the candidate, + in the range of [0, 1]. This field is a member of `oneof`_ ``_grounding_score``. grounding_metadata (google.cloud.discoveryengine_v1.types.GenerateGroundedContentResponse.Candidate.GroundingMetadata): @@ -599,12 +610,13 @@ class DynamicRetrievalPredictorMetadata(proto.Message): The version of the predictor which was used in dynamic retrieval. prediction (float): - The value of the predictor. This should be between [0, 1] - where a value of 0 means that the query would not benefit - from grounding, while a value of 1.0 means that the query - would benefit the most. In between values allow to - differentiate between different usefulness scores for - grounding. + The value of the predictor. This should be + between [0, 1] where a value of 0 means that the + query would not benefit from grounding, while a + value of 1.0 means that the query would benefit + the most. In between values allow to + differentiate between different usefulness + scores for grounding. This field is a member of `oneof`_ ``_prediction``. """ @@ -665,14 +677,17 @@ class GroundingSupport(proto.Message): Text for the claim in the candidate. Always provided when a support is found. support_chunk_indices (MutableSequence[int]): - A list of indices (into 'support_chunks') specifying the - citations associated with the claim. For instance [1,3,4] - means that support_chunks[1], support_chunks[3], - support_chunks[4] are the chunks attributed to the claim. + A list of indices (into 'support_chunks') + specifying the citations associated with the + claim. For instance [1,3,4] means that + support_chunks[1], support_chunks[3], + support_chunks[4] are the chunks attributed to + the claim. support_score (float): - A score in the range of [0, 1] describing how grounded is a - specific claim in the support chunks indicated. Higher value - means that the claim is better supported by the chunks. + A score in the range of [0, 1] describing how + grounded is a specific claim in the support + chunks indicated. Higher value means that the + claim is better supported by the chunks. This field is a member of `oneof`_ ``_support_score``. """ @@ -834,12 +849,13 @@ class CheckGroundingSpec(proto.Message): Attributes: citation_threshold (float): - The threshold (in [0,1]) used for determining whether a fact - must be cited for a claim in the answer candidate. Choosing - a higher threshold will lead to fewer but very strong - citations, while choosing a lower threshold may lead to more - but somewhat weaker citations. If unset, the threshold will - default to 0.6. + The threshold (in [0,1]) used for determining + whether a fact must be cited for a claim in the + answer candidate. Choosing a higher threshold + will lead to fewer but very strong citations, + while choosing a lower threshold may lead to + more but somewhat weaker citations. If unset, + the threshold will default to 0.6. This field is a member of `oneof`_ ``_citation_threshold``. enable_claim_level_score (bool): @@ -863,12 +879,14 @@ class CheckGroundingSpec(proto.Message): class CheckGroundingRequest(proto.Message): r"""Request message for - [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1.GroundedGenerationService.CheckGrounding] + `GroundedGenerationService.CheckGrounding + `__ method. Attributes: grounding_config (str): - Required. The resource name of the grounding config, such as + Required. The resource name of the grounding + config, such as ``projects/*/locations/global/groundingConfigs/default_grounding_config``. answer_candidate (str): Answer candidate to check. It can have a @@ -879,26 +897,32 @@ class CheckGroundingRequest(proto.Message): grounding_spec (google.cloud.discoveryengine_v1.types.CheckGroundingSpec): Configuration of the grounding check. user_labels (MutableMapping[str, str]): - The user labels applied to a resource must meet the - following requirements: - - - Each resource can have multiple labels, up to a maximum of - 64. - - Each label must be a key-value pair. - - Keys have a minimum length of 1 character and a maximum - length of 63 characters and cannot be empty. Values can be - empty and have a maximum length of 63 characters. - - Keys and values can contain only lowercase letters, - numeric characters, underscores, and dashes. All - characters must use UTF-8 encoding, and international - characters are allowed. - - The key portion of a label must be unique. However, you - can use the same key with multiple resources. - - Keys must start with a lowercase letter or international - character. + The user labels applied to a resource must meet + the following requirements: + * Each resource can have multiple labels, up to + a maximum of 64. + + * Each label must be a key-value pair. + * Keys have a minimum length of 1 character and + a maximum length of 63 characters and cannot + be empty. Values can be empty and have a maximum + length of 63 characters. + + * Keys and values can contain only lowercase + letters, numeric characters, underscores, and + dashes. All characters must use UTF-8 encoding, + and international characters are allowed. + + * The key portion of a label must be unique. + However, you can use the same key with + multiple resources. + + * Keys must start with a lowercase letter or + international character. See `Google Cloud - Document `__ + Document + `__ for more details. """ @@ -929,7 +953,8 @@ class CheckGroundingRequest(proto.Message): class CheckGroundingResponse(proto.Message): r"""Response message for the - [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1.GroundedGenerationService.CheckGrounding] + `GroundedGenerationService.CheckGrounding + `__ method. @@ -1010,24 +1035,29 @@ class Claim(proto.Message): Always provided regardless of whether citations or anti-citations are found. citation_indices (MutableSequence[int]): - A list of indices (into 'cited_chunks') specifying the - citations associated with the claim. For instance [1,3,4] - means that cited_chunks[1], cited_chunks[3], cited_chunks[4] - are the facts cited supporting for the claim. A citation to - a fact indicates that the claim is supported by the fact. + A list of indices (into 'cited_chunks') + specifying the citations associated with the + claim. For instance [1,3,4] means that + cited_chunks[1], cited_chunks[3], + cited_chunks[4] are the facts cited supporting + for the claim. A citation to a fact indicates + that the claim is supported by the fact. grounding_check_required (bool): - Indicates that this claim required grounding check. When the - system decided this claim doesn't require - attribution/grounding check, this field will be set to - false. In that case, no grounding check was done for the - claim and therefore - [citation_indices][google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim.citation_indices] + Indicates that this claim required grounding + check. When the system decided this claim + doesn't require attribution/grounding check, + this field will be set to false. In that case, + no grounding check was done for the claim and + therefore + `citation_indices + `__ should not be returned. This field is a member of `oneof`_ ``_grounding_check_required``. score (float): - Confidence score for the claim in the answer candidate, in - the range of [0, 1]. This is set only when + Confidence score for the claim in the answer + candidate, in the range of [0, 1]. This is set + only when ``CheckGroundingRequest.grounding_spec.enable_claim_level_score`` is true. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/grounding.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/grounding.py index 8fa92a7cdabd..4b77e23edfd9 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/grounding.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/grounding.py @@ -36,10 +36,10 @@ class GroundingFact(proto.Message): Text content of the fact. Can be at most 10K characters long. attributes (MutableMapping[str, str]): - Attributes associated with the fact. Common attributes - include ``source`` (indicating where the fact was sourced - from), ``author`` (indicating the author of the fact), and - so on. + Attributes associated with the fact. + Common attributes include ``source`` (indicating + where the fact was sourced from), ``author`` + (indicating the author of the fact), and so on. """ fact_text: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/identity_mapping_store.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/identity_mapping_store.py index 9d8d066786de..8fd66f677d96 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/identity_mapping_store.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/identity_mapping_store.py @@ -36,21 +36,23 @@ class IdentityMappingStore(proto.Message): Attributes: name (str): - Immutable. The full resource name of the identity mapping - store. Format: + Immutable. The full resource name of the + identity mapping store. Format: + ``projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}``. - This field must be a UTF-8 encoded string with a length - limit of 1024 characters. + This field must be a UTF-8 encoded string with a + length limit of 1024 characters. kms_key_name (str): - Input only. The KMS key to be used to protect this Identity - Mapping Store at creation time. + Input only. The KMS key to be used to protect + this Identity Mapping Store at creation time. - Must be set for requests that need to comply with CMEK Org - Policy protections. + Must be set for requests that need to comply + with CMEK Org Policy protections. - If this field is set and processed successfully, the - Identity Mapping Store will be protected by the KMS key, as - indicated in the cmek_config field. + If this field is set and processed successfully, + the Identity Mapping Store will be protected by + the KMS key, as indicated in the cmek_config + field. cmek_config (google.cloud.discoveryengine_v1.types.CmekConfig): Output only. CMEK-related information for the Identity Mapping Store. @@ -84,17 +86,21 @@ class IdentityMappingEntry(proto.Message): Attributes: user_id (str): - User identifier. For Google Workspace user account, user_id - should be the google workspace user email. For non-google - identity provider, user_id is the mapped user identifier - configured during the workforcepool config. + User identifier. + For Google Workspace user account, user_id + should be the google workspace user email. + For non-google identity provider, user_id is the + mapped user identifier configured during the + workforcepool config. This field is a member of `oneof`_ ``identity_provider_id``. group_id (str): - Group identifier. For Google Workspace user account, - group_id should be the google workspace group email. For - non-google identity provider, group_id is the mapped group - identifier configured during the workforcepool config. + Group identifier. + For Google Workspace user account, group_id + should be the google workspace group email. + For non-google identity provider, group_id is + the mapped group identifier configured during + the workforcepool config. This field is a member of `oneof`_ ``identity_provider_id``. external_identity (str): diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/identity_mapping_store_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/identity_mapping_store_service.py index 1cce182f70d0..7d78977cca01 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/identity_mapping_store_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/identity_mapping_store_service.py @@ -46,7 +46,8 @@ class CreateIdentityMappingStoreRequest(proto.Message): r"""Request message for - [IdentityMappingStoreService.CreateIdentityMappingStore][google.cloud.discoveryengine.v1.IdentityMappingStoreService.CreateIdentityMappingStore] + `IdentityMappingStoreService.CreateIdentityMappingStore + `__ This message has `oneof`_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. @@ -69,14 +70,15 @@ class CreateIdentityMappingStoreRequest(proto.Message): This field is a member of `oneof`_ ``cmek_options``. parent (str): - Required. The parent collection resource name, such as + Required. The parent collection resource name, + such as ``projects/{project}/locations/{location}``. identity_mapping_store_id (str): - Required. The ID of the Identity Mapping Store to create. - - The ID must contain only letters (a-z, A-Z), numbers (0-9), - underscores (\_), and hyphens (-). The maximum length is 63 - characters. + Required. The ID of the Identity Mapping Store + to create. + The ID must contain only letters (a-z, A-Z), + numbers (0-9), underscores (_), and hyphens (-). + The maximum length is 63 characters. identity_mapping_store (google.cloud.discoveryengine_v1.types.IdentityMappingStore): Required. The Identity Mapping Store to create. @@ -111,12 +113,14 @@ class CreateIdentityMappingStoreRequest(proto.Message): class GetIdentityMappingStoreRequest(proto.Message): r"""Request message for - [IdentityMappingStoreService.GetIdentityMappingStore][google.cloud.discoveryengine.v1.IdentityMappingStoreService.GetIdentityMappingStore] + `IdentityMappingStoreService.GetIdentityMappingStore + `__ Attributes: name (str): - Required. The name of the Identity Mapping Store to get. - Format: + Required. The name of the Identity Mapping Store + to get. Format: + ``projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`` """ @@ -128,12 +132,14 @@ class GetIdentityMappingStoreRequest(proto.Message): class DeleteIdentityMappingStoreRequest(proto.Message): r"""Request message for - [IdentityMappingStoreService.DeleteIdentityMappingStore][google.cloud.discoveryengine.v1.IdentityMappingStoreService.DeleteIdentityMappingStore] + `IdentityMappingStoreService.DeleteIdentityMappingStore + `__ Attributes: name (str): - Required. The name of the Identity Mapping Store to delete. - Format: + Required. The name of the Identity Mapping Store + to delete. Format: + ``projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`` """ @@ -145,7 +151,8 @@ class DeleteIdentityMappingStoreRequest(proto.Message): class ImportIdentityMappingsRequest(proto.Message): r"""Request message for - [IdentityMappingStoreService.ImportIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ImportIdentityMappings] + `IdentityMappingStoreService.ImportIdentityMappings + `__ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields @@ -157,8 +164,9 @@ class ImportIdentityMappingsRequest(proto.Message): This field is a member of `oneof`_ ``source``. identity_mapping_store (str): - Required. The name of the Identity Mapping Store to import - Identity Mapping Entries to. Format: + Required. The name of the Identity Mapping Store + to import Identity Mapping Entries to. Format: + ``projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`` """ @@ -193,7 +201,8 @@ class InlineSource(proto.Message): class ImportIdentityMappingsResponse(proto.Message): r"""Response message for - [IdentityMappingStoreService.ImportIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ImportIdentityMappings] + `IdentityMappingStoreService.ImportIdentityMappings + `__ Attributes: error_samples (MutableSequence[google.rpc.status_pb2.Status]): @@ -210,7 +219,8 @@ class ImportIdentityMappingsResponse(proto.Message): class PurgeIdentityMappingsRequest(proto.Message): r"""Request message for - [IdentityMappingStoreService.PurgeIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.PurgeIdentityMappings] + `IdentityMappingStoreService.PurgeIdentityMappings + `__ .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields @@ -222,34 +232,46 @@ class PurgeIdentityMappingsRequest(proto.Message): This field is a member of `oneof`_ ``source``. identity_mapping_store (str): - Required. The name of the Identity Mapping Store to purge - Identity Mapping Entries from. Format: + Required. The name of the Identity Mapping Store + to purge Identity Mapping Entries from. Format: + ``projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`` filter (str): - Filter matching identity mappings to purge. The eligible - field for filtering is: + Filter matching identity mappings to purge. + The eligible field for filtering is: - - ``update_time``: in ISO 8601 "zulu" format. - - ``external_id`` + * ``update_time``: in ISO 8601 "zulu" format. * + ``external_id`` Examples: - - Deleting all identity mappings updated in a time range: - ``update_time > "2012-04-23T18:25:43.511Z" AND update_time < "2012-04-23T18:30:43.511Z"`` - - Deleting all identity mappings for a given external_id: - ``external_id = "id1"`` - - Deleting all identity mappings inside an identity mapping - store: ``*`` + * Deleting all identity mappings updated in a + time range: + + ``update_time > "2012-04-23T18:25:43.511Z" AND + update_time < "2012-04-23T18:30:43.511Z"`` + + * Deleting all identity mappings for a given + external_id: - The filtering fields are assumed to have an implicit AND. - Should not be used with source. An error will be thrown, if - both are provided. + ``external_id = "id1"`` + + * Deleting all identity mappings inside an + identity mapping store: + + ``*`` + + The filtering fields are assumed to have an + implicit AND. Should not be used with source. An + error will be thrown, if both are provided. force (bool): - Actually performs the purge. If ``force`` is set to false, - return the expected purge count without deleting any - identity mappings. This field is only supported for purge - with filter. For input source this field is ignored and data - will be purged regardless of the value of this field. + Actually performs the purge. If ``force`` is set + to false, return the expected purge count + without deleting any identity mappings. This + field is only supported for purge with filter. + For input source this field is ignored and data + will be purged regardless of the value of this + field. This field is a member of `oneof`_ ``_force``. """ @@ -294,12 +316,14 @@ class InlineSource(proto.Message): class ListIdentityMappingsRequest(proto.Message): r"""Request message for - [IdentityMappingStoreService.ListIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ListIdentityMappings] + `IdentityMappingStoreService.ListIdentityMappings + `__ Attributes: identity_mapping_store (str): - Required. The name of the Identity Mapping Store to list - Identity Mapping Entries in. Format: + Required. The name of the Identity Mapping Store + to list Identity Mapping Entries in. Format: + ``projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`` page_size (int): Maximum number of IdentityMappings to return. @@ -308,12 +332,12 @@ class ListIdentityMappingsRequest(proto.Message): be coerced to 10000. page_token (str): A page token, received from a previous - ``ListIdentityMappings`` call. Provide this to retrieve the - subsequent page. + ``ListIdentityMappings`` call. Provide this to + retrieve the subsequent page. - When paginating, all other parameters provided to - ``ListIdentityMappings`` must match the call that provided - the page token. + When paginating, all other parameters provided + to ``ListIdentityMappings`` must match the call + that provided the page token. """ identity_mapping_store: str = proto.Field( @@ -332,15 +356,16 @@ class ListIdentityMappingsRequest(proto.Message): class ListIdentityMappingsResponse(proto.Message): r"""Response message for - [IdentityMappingStoreService.ListIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ListIdentityMappings] + `IdentityMappingStoreService.ListIdentityMappings + `__ Attributes: identity_mapping_entries (MutableSequence[google.cloud.discoveryengine_v1.types.IdentityMappingEntry]): The Identity Mapping Entries. next_page_token (str): - A token that can be sent as ``page_token`` to retrieve the - next page. If this field is omitted, there are no subsequent - pages. + A token that can be sent as ``page_token`` to + retrieve the next page. If this field is + omitted, there are no subsequent pages. """ @property @@ -362,12 +387,15 @@ def raw_page(self): class ListIdentityMappingStoresRequest(proto.Message): r"""Request message for - [IdentityMappingStoreService.ListIdentityMappingStores][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ListIdentityMappingStores] + `IdentityMappingStoreService.ListIdentityMappingStores + `__ Attributes: parent (str): - Required. The parent of the Identity Mapping Stores to list. - Format: ``projects/{project}/locations/{location}``. + Required. The parent of the Identity Mapping + Stores to list. Format: + + ``projects/{project}/locations/{location}``. page_size (int): Maximum number of IdentityMappingStores to return. If unspecified, defaults to 100. The @@ -375,12 +403,12 @@ class ListIdentityMappingStoresRequest(proto.Message): will be coerced to 1000. page_token (str): A page token, received from a previous - ``ListIdentityMappingStores`` call. Provide this to retrieve - the subsequent page. + ``ListIdentityMappingStores`` call. Provide this + to retrieve the subsequent page. - When paginating, all other parameters provided to - ``ListIdentityMappingStores`` must match the call that - provided the page token. + When paginating, all other parameters provided + to ``ListIdentityMappingStores`` must match the + call that provided the page token. """ parent: str = proto.Field( @@ -399,15 +427,16 @@ class ListIdentityMappingStoresRequest(proto.Message): class ListIdentityMappingStoresResponse(proto.Message): r"""Response message for - [IdentityMappingStoreService.ListIdentityMappingStores][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ListIdentityMappingStores] + `IdentityMappingStoreService.ListIdentityMappingStores + `__ Attributes: identity_mapping_stores (MutableSequence[google.cloud.discoveryengine_v1.types.IdentityMappingStore]): The Identity Mapping Stores. next_page_token (str): - A token that can be sent as ``page_token`` to retrieve the - next page. If this field is omitted, there are no subsequent - pages. + A token that can be sent as ``page_token`` to + retrieve the next page. If this field is + omitted, there are no subsequent pages. """ @property @@ -429,9 +458,11 @@ def raw_page(self): class IdentityMappingEntryOperationMetadata(proto.Message): r"""IdentityMappingEntry LongRunningOperation metadata for - [IdentityMappingStoreService.ImportIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.ImportIdentityMappings] + `IdentityMappingStoreService.ImportIdentityMappings + `__ and - [IdentityMappingStoreService.PurgeIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.PurgeIdentityMappings] + `IdentityMappingStoreService.PurgeIdentityMappings + `__ Attributes: success_count (int): @@ -461,7 +492,8 @@ class IdentityMappingEntryOperationMetadata(proto.Message): class DeleteIdentityMappingStoreMetadata(proto.Message): r"""Metadata related to the progress of the - [IdentityMappingStoreService.DeleteIdentityMappingStore][google.cloud.discoveryengine.v1.IdentityMappingStoreService.DeleteIdentityMappingStore] + `IdentityMappingStoreService.DeleteIdentityMappingStore + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/import_config.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/import_config.py index 8aa69e0939e7..26b3f0350d9e 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/import_config.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/import_config.py @@ -59,44 +59,55 @@ class GcsSource(proto.Message): Attributes: input_uris (MutableSequence[str]): - Required. Cloud Storage URIs to input files. Each URI can be - up to 2000 characters long. URIs can match the full object - path (for example, ``gs://bucket/directory/object.json``) or - a pattern matching one or more files, such as + Required. Cloud Storage URIs to input files. + Each URI can be up to 2000 characters long. URIs + can match the full object path (for example, + ``gs://bucket/directory/object.json``) or a + pattern matching one or more files, such as ``gs://bucket/directory/*.json``. - A request can contain at most 100 files (or 100,000 files if - ``data_schema`` is ``content``). Each file can be up to 2 GB - (or 100 MB if ``data_schema`` is ``content``). + A request can contain at most 100 files (or + 100,000 files if ``data_schema`` is + ``content``). Each file can be up to 2 GB (or + 100 MB if ``data_schema`` is ``content``). data_schema (str): - The schema to use when parsing the data from the source. - + The schema to use when parsing the data from the + source. Supported values for document imports: - - ``document`` (default): One JSON - [Document][google.cloud.discoveryengine.v1.Document] per - line. Each document must have a valid - [Document.id][google.cloud.discoveryengine.v1.Document.id]. - - ``content``: Unstructured data (e.g. PDF, HTML). Each file - matched by ``input_uris`` becomes a document, with the ID - set to the first 128 bits of SHA256(URI) encoded as a hex - string. - - ``custom``: One custom data JSON per row in arbitrary - format that conforms to the defined - [Schema][google.cloud.discoveryengine.v1.Schema] of the - data store. This can only be used by the GENERIC Data - Store vertical. - - ``csv``: A CSV file with header conforming to the defined - [Schema][google.cloud.discoveryengine.v1.Schema] of the - data store. Each entry after the header is imported as a - Document. This can only be used by the GENERIC Data Store - vertical. + * ``document`` (default): One JSON + `Document + `__ + per line. Each document must + have a valid `Document.id + `__. + + * ``content``: Unstructured data (e.g. PDF, + HTML). Each file matched by ``input_uris`` + becomes a document, with the ID set to the first + 128 bits of SHA256(URI) encoded as a hex + string. + + * ``custom``: One custom data JSON per row in + arbitrary format that conforms to the defined + `Schema + `__ of + the data store. This can only be used by the + GENERIC Data Store vertical. + + * ``csv``: A CSV file with header conforming to + the defined `Schema + `__ of + the data store. Each entry after the header is + imported as a Document. This can only be used + by the GENERIC Data Store vertical. Supported values for user event imports: - - ``user_event`` (default): One JSON - [UserEvent][google.cloud.discoveryengine.v1.UserEvent] per - line. + * ``user_event`` (default): One JSON + `UserEvent + `__ + per line. """ input_uris: MutableSequence[str] = proto.RepeatedField( @@ -116,8 +127,8 @@ class BigQuerySource(proto.Message): Attributes: partition_date (google.type.date_pb2.Date): - BigQuery time partitioned table's \_PARTITIONDATE in - YYYY-MM-DD format. + BigQuery time partitioned table's _PARTITIONDATE + in YYYY-MM-DD format. This field is a member of `oneof`_ ``partition``. project_id (str): @@ -139,29 +150,36 @@ class BigQuerySource(proto.Message): have the BigQuery export to a specific Cloud Storage directory. data_schema (str): - The schema to use when parsing the data from the source. - + The schema to use when parsing the data from the + source. Supported values for user event imports: - - ``user_event`` (default): One - [UserEvent][google.cloud.discoveryengine.v1.UserEvent] per - row. + * ``user_event`` (default): One + `UserEvent + `__ + per row. Supported values for document imports: - - ``document`` (default): One - [Document][google.cloud.discoveryengine.v1.Document] - format per row. Each document must have a valid - [Document.id][google.cloud.discoveryengine.v1.Document.id] - and one of - [Document.json_data][google.cloud.discoveryengine.v1.Document.json_data] - or - [Document.struct_data][google.cloud.discoveryengine.v1.Document.struct_data]. - - ``custom``: One custom data per row in arbitrary format - that conforms to the defined - [Schema][google.cloud.discoveryengine.v1.Schema] of the - data store. This can only be used by the GENERIC Data - Store vertical. + * ``document`` (default): One + `Document + `__ + format per row. Each document must have a + valid + `Document.id + `__ + and one of `Document.json_data + `__ + or + `Document.struct_data + `__. + + * ``custom``: One custom data per row in + arbitrary format that conforms to the defined + `Schema + `__ of + the data store. This can only be used by the + GENERIC Data Store vertical. """ partition_date: date_pb2.Date = proto.Field( @@ -211,9 +229,10 @@ class SpannerSource(proto.Message): Required. The table name of the Spanner database that needs to be imported. enable_data_boost (bool): - Whether to apply data boost on Spanner export. Enabling this - option will incur additional cost. More info can be found - `here `__. + Whether to apply data boost on Spanner export. + Enabling this option will incur additional cost. + More info can be found `here + `__. """ project_id: str = proto.Field( @@ -244,9 +263,9 @@ class BigtableOptions(proto.Message): Attributes: key_field_name (str): - The field name used for saving row key value in the - document. The name has to match the pattern - ``[a-zA-Z0-9][a-zA-Z0-9-_]*``. + The field name used for saving row key value in + the document. The name has to match the pattern + ```a-zA-Z0-9 `__*``. families (MutableMapping[str, google.cloud.discoveryengine_v1.types.BigtableOptions.BigtableColumnFamily]): The mapping from family names to an object that contains column families level information @@ -255,9 +274,11 @@ class BigtableOptions(proto.Message): """ class Type(proto.Enum): - r"""The type of values in a Bigtable column or column family. The values - are expected to be encoded using `HBase - Bytes.toBytes `__ + r"""The type of values in a Bigtable column or column family. + The values are expected to be encoded using + `HBase + Bytes.toBytes + `__ function when the encoding value is set to ``BINARY``. Values: @@ -307,25 +328,28 @@ class BigtableColumnFamily(proto.Message): Attributes: field_name (str): - The field name to use for this column family in the - document. The name has to match the pattern - ``[a-zA-Z0-9][a-zA-Z0-9-_]*``. If not set, it is parsed from - the family name with best effort. However, due to different - naming patterns, field name collisions could happen, where - parsing behavior is undefined. + The field name to use for this column family in + the document. The name has to match the pattern + ```a-zA-Z0-9 `__*``. If not set, it + is parsed from the family name with best effort. + However, due to different naming patterns, field + name collisions could happen, where parsing + behavior is undefined. encoding (google.cloud.discoveryengine_v1.types.BigtableOptions.Encoding): - The encoding mode of the values when the type is not STRING. - Acceptable encoding values are: - - - ``TEXT``: indicates values are alphanumeric text strings. - - ``BINARY``: indicates values are encoded using - ``HBase Bytes.toBytes`` family of functions. This can be - overridden for a specific column by listing that column in - ``columns`` and specifying an encoding for it. + The encoding mode of the values when the type is + not STRING. Acceptable encoding values are: + + * ``TEXT``: indicates values are alphanumeric + text strings. * ``BINARY``: indicates values are + encoded using ``HBase Bytes.toBytes`` family of + functions. This can be overridden for a specific + column by listing that column in ``columns`` and + specifying an encoding for it. type_ (google.cloud.discoveryengine_v1.types.BigtableOptions.Type): - The type of values in this column family. The values are - expected to be encoded using ``HBase Bytes.toBytes`` - function when the encoding value is set to ``BINARY``. + The type of values in this column family. + The values are expected to be encoded using + ``HBase Bytes.toBytes`` function when the + encoding value is set to ``BINARY``. columns (MutableSequence[google.cloud.discoveryengine_v1.types.BigtableOptions.BigtableColumn]): The list of objects that contains column level information for each column. If a column @@ -363,25 +387,28 @@ class BigtableColumn(proto.Message): cannot be decoded with utf-8, use a base-64 encoded string instead. field_name (str): - The field name to use for this column in the document. The - name has to match the pattern ``[a-zA-Z0-9][a-zA-Z0-9-_]*``. - If not set, it is parsed from the qualifier bytes with best - effort. However, due to different naming patterns, field - name collisions could happen, where parsing behavior is - undefined. + The field name to use for this column in the + document. The name has to match the pattern + ```a-zA-Z0-9 `__*``. If not set, it + is parsed from the qualifier bytes with best + effort. However, due to different naming + patterns, field name collisions could happen, + where parsing behavior is undefined. encoding (google.cloud.discoveryengine_v1.types.BigtableOptions.Encoding): - The encoding mode of the values when the type is not - ``STRING``. Acceptable encoding values are: - - - ``TEXT``: indicates values are alphanumeric text strings. - - ``BINARY``: indicates values are encoded using - ``HBase Bytes.toBytes`` family of functions. This can be - overridden for a specific column by listing that column in - ``columns`` and specifying an encoding for it. + The encoding mode of the values when the type is + not ``STRING``. Acceptable encoding values are: + + * ``TEXT``: indicates values are alphanumeric + text strings. * ``BINARY``: indicates values are + encoded using ``HBase Bytes.toBytes`` family of + functions. This can be overridden for a specific + column by listing that column in ``columns`` and + specifying an encoding for it. type_ (google.cloud.discoveryengine_v1.types.BigtableOptions.Type): - The type of values in this column family. The values are - expected to be encoded using ``HBase Bytes.toBytes`` - function when the encoding value is set to ``BINARY``. + The type of values in this column family. + The values are expected to be encoded using + ``HBase Bytes.toBytes`` function when the + encoding value is set to ``BINARY``. """ qualifier: bytes = proto.Field( @@ -461,8 +488,8 @@ class FhirStoreSource(proto.Message): Attributes: fhir_store (str): - Required. The full resource name of the FHIR store to import - data from, in the format of + Required. The full resource name of the FHIR + store to import data from, in the format of ``projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}``. gcs_staging_dir (str): Intermediate Cloud Storage directory used for @@ -471,21 +498,25 @@ class FhirStoreSource(proto.Message): have the FhirStore export to a specific Cloud Storage directory. resource_types (MutableSequence[str]): - The FHIR resource types to import. The resource types should - be a subset of all `supported FHIR resource - types `__. - Default to all supported FHIR resource types if empty. + The FHIR resource types to import. The resource + types should be a subset of all `supported FHIR + resource types + `__. + Default to all supported FHIR resource types if + empty. update_from_latest_predefined_schema (bool): - Optional. Whether to update the DataStore schema to the - latest predefined schema. - - If true, the DataStore schema will be updated to include any - FHIR fields or resource types that have been added since the - last import and corresponding FHIR resources will be - imported from the FHIR store. - - Note this field cannot be used in conjunction with - ``resource_types``. It should be used after initial import. + Optional. Whether to update the DataStore schema + to the latest predefined schema. + + If true, the DataStore schema will be updated to + include any FHIR fields or resource types that + have been added since the last import and + corresponding FHIR resources will be imported + from the FHIR store. + + Note this field cannot be used in conjunction + with ``resource_types``. It should be used after + initial import. """ fhir_store: str = proto.Field( @@ -535,9 +566,10 @@ class CloudSqlSource(proto.Message): the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. offload (bool): - Option for serverless export. Enabling this option will - incur additional cost. More info can be found - `here `__. + Option for serverless export. Enabling this + option will incur additional cost. More info can + be found `here + `__. """ project_id: str = proto.Field( @@ -678,10 +710,11 @@ class ImportErrorConfig(proto.Message): Attributes: gcs_prefix (str): - Cloud Storage prefix for import errors. This must be an - empty, existing Cloud Storage directory. Import errors are - written to sharded files in this directory, one per line, as - a JSON-encoded ``google.rpc.Status`` message. + Cloud Storage prefix for import errors. This + must be an empty, existing Cloud Storage + directory. Import errors are written to sharded + files in this directory, one per line, as a + JSON-encoded ``google.rpc.Status`` message. This field is a member of `oneof`_ ``destination``. """ @@ -718,7 +751,8 @@ class ImportUserEventsRequest(proto.Message): This field is a member of `oneof`_ ``source``. parent (str): - Required. Parent DataStore resource name, of the form + Required. Parent DataStore resource name, of the + form ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`` error_config (google.cloud.discoveryengine_v1.types.ImportErrorConfig): The desired location of errors incurred @@ -946,98 +980,130 @@ class ImportDocumentsRequest(proto.Message): This field is a member of `oneof`_ ``source``. parent (str): - Required. The parent branch resource name, such as + Required. The parent branch resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. Requires create/update permission. error_config (google.cloud.discoveryengine_v1.types.ImportErrorConfig): The desired location of errors incurred during the Import. reconciliation_mode (google.cloud.discoveryengine_v1.types.ImportDocumentsRequest.ReconciliationMode): - The mode of reconciliation between existing documents and - the documents to be imported. Defaults to - [ReconciliationMode.INCREMENTAL][google.cloud.discoveryengine.v1.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL]. + The mode of reconciliation between existing + documents and the documents to be imported. + Defaults to `ReconciliationMode.INCREMENTAL + `__. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields. auto_generate_ids (bool): - Whether to automatically generate IDs for the documents if - absent. - + Whether to automatically generate IDs for the + documents if absent. If set to ``true``, - [Document.id][google.cloud.discoveryengine.v1.Document.id]s - are automatically generated based on the hash of the - payload, where IDs may not be consistent during multiple - imports. In which case - [ReconciliationMode.FULL][google.cloud.discoveryengine.v1.ImportDocumentsRequest.ReconciliationMode.FULL] - is highly recommended to avoid duplicate contents. If unset - or set to ``false``, - [Document.id][google.cloud.discoveryengine.v1.Document.id]s + `Document.id + `__s + are automatically generated based on the hash of + the payload, where IDs may not be consistent + during multiple imports. In which case + `ReconciliationMode.FULL + `__ + is highly recommended to avoid duplicate + contents. If unset or set to ``false``, + `Document.id + `__s have to be specified using - [id_field][google.cloud.discoveryengine.v1.ImportDocumentsRequest.id_field], - otherwise, documents without IDs fail to be imported. + `id_field + `__, + otherwise, documents without IDs fail to be + imported. Supported data sources: - - [GcsSource][google.cloud.discoveryengine.v1.GcsSource]. - [GcsSource.data_schema][google.cloud.discoveryengine.v1.GcsSource.data_schema] - must be ``custom`` or ``csv``. Otherwise, an - INVALID_ARGUMENT error is thrown. - - [BigQuerySource][google.cloud.discoveryengine.v1.BigQuerySource]. - [BigQuerySource.data_schema][google.cloud.discoveryengine.v1.BigQuerySource.data_schema] - must be ``custom`` or ``csv``. Otherwise, an - INVALID_ARGUMENT error is thrown. - - [SpannerSource][google.cloud.discoveryengine.v1.SpannerSource]. - - [CloudSqlSource][google.cloud.discoveryengine.v1.CloudSqlSource]. - - [FirestoreSource][google.cloud.discoveryengine.v1.FirestoreSource]. - - [BigtableSource][google.cloud.discoveryengine.v1.BigtableSource]. + * `GcsSource + `__. + `GcsSource.data_schema + `__ + must be ``custom`` or ``csv``. Otherwise, an + INVALID_ARGUMENT error is thrown. + + * `BigQuerySource + `__. + `BigQuerySource.data_schema + `__ + must be ``custom`` or ``csv``. Otherwise, an + INVALID_ARGUMENT error is thrown. + + * `SpannerSource + `__. + * `CloudSqlSource + `__. + + * `FirestoreSource + `__. + * `BigtableSource + `__. id_field (str): - The field indicates the ID field or column to be used as - unique IDs of the documents. - - For [GcsSource][google.cloud.discoveryengine.v1.GcsSource] - it is the key of the JSON field. For instance, ``my_id`` for - JSON ``{"my_id": "some_uuid"}``. For others, it may be the - column name of the table where the unique ids are stored. - - The values of the JSON field or the table column are used as - the - [Document.id][google.cloud.discoveryengine.v1.Document.id]s. - The JSON field or the table column must be of string type, - and the values must be set as valid strings conform to - `RFC-1034 `__ with 1-63 - characters. Otherwise, documents without valid IDs fail to - be imported. + The field indicates the ID field or column to be + used as unique IDs of the documents. + + For `GcsSource + `__ + it is the key of the JSON field. For instance, + ``my_id`` for JSON ``{"my_id": "some_uuid"}``. + For others, it may be the column name of the + table where the unique ids are stored. + + The values of the JSON field or the table column + are used as the `Document.id + `__s. + The JSON field or the table column must be of + string type, and the values must be set as valid + strings conform to `RFC-1034 + `__ with + 1-63 characters. Otherwise, documents without + valid IDs fail to be imported. Only set this field when - [auto_generate_ids][google.cloud.discoveryengine.v1.ImportDocumentsRequest.auto_generate_ids] - is unset or set as ``false``. Otherwise, an INVALID_ARGUMENT - error is thrown. + `auto_generate_ids + `__ + is unset or set as ``false``. Otherwise, an + INVALID_ARGUMENT error is thrown. - If it is unset, a default value ``_id`` is used when - importing from the allowed data sources. + If it is unset, a default value ``_id`` is used + when importing from the allowed data sources. Supported data sources: - - [GcsSource][google.cloud.discoveryengine.v1.GcsSource]. - [GcsSource.data_schema][google.cloud.discoveryengine.v1.GcsSource.data_schema] - must be ``custom`` or ``csv``. Otherwise, an - INVALID_ARGUMENT error is thrown. - - [BigQuerySource][google.cloud.discoveryengine.v1.BigQuerySource]. - [BigQuerySource.data_schema][google.cloud.discoveryengine.v1.BigQuerySource.data_schema] - must be ``custom`` or ``csv``. Otherwise, an - INVALID_ARGUMENT error is thrown. - - [SpannerSource][google.cloud.discoveryengine.v1.SpannerSource]. - - [CloudSqlSource][google.cloud.discoveryengine.v1.CloudSqlSource]. - - [FirestoreSource][google.cloud.discoveryengine.v1.FirestoreSource]. - - [BigtableSource][google.cloud.discoveryengine.v1.BigtableSource]. + * `GcsSource + `__. + `GcsSource.data_schema + `__ + must be ``custom`` or ``csv``. Otherwise, an + INVALID_ARGUMENT error is thrown. + + * `BigQuerySource + `__. + `BigQuerySource.data_schema + `__ + must be ``custom`` or ``csv``. Otherwise, an + INVALID_ARGUMENT error is thrown. + + * `SpannerSource + `__. + * `CloudSqlSource + `__. + + * `FirestoreSource + `__. + * `BigtableSource + `__. force_refresh_content (bool): - Optional. Whether to force refresh the unstructured content - of the documents. + Optional. Whether to force refresh the + unstructured content of the documents. - If set to ``true``, the content part of the documents will - be refreshed regardless of the update status of the - referencing content. + If set to ``true``, the content part of the + documents will be refreshed regardless of the + update status of the referencing content. """ class ReconciliationMode(proto.Enum): @@ -1066,9 +1132,9 @@ class InlineSource(proto.Message): Attributes: documents (MutableSequence[google.cloud.discoveryengine_v1.types.Document]): - Required. A list of documents to update/create. Each - document must have a valid - [Document.id][google.cloud.discoveryengine.v1.Document.id]. + Required. A list of documents to update/create. + Each document must have a valid `Document.id + `__. Recommended max of 100 items. """ @@ -1167,10 +1233,11 @@ class InlineSource(proto.Message): class ImportDocumentsResponse(proto.Message): r"""Response of the - [ImportDocumentsRequest][google.cloud.discoveryengine.v1.ImportDocumentsRequest]. - If the long running operation is done, then this message is returned - by the google.longrunning.Operations.response field if the operation - was successful. + `ImportDocumentsRequest + `__. If + the long running operation is done, then this message is + returned by the google.longrunning.Operations.response field if + the operation was successful. Attributes: error_samples (MutableSequence[google.rpc.status_pb2.Status]): @@ -1195,7 +1262,8 @@ class ImportDocumentsResponse(proto.Message): class ImportSuggestionDenyListEntriesRequest(proto.Message): r"""Request message for - [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.ImportSuggestionDenyListEntries] + `CompletionService.ImportSuggestionDenyListEntries + `__ method. This message has `oneof`_ fields (mutually exclusive fields). @@ -1214,17 +1282,19 @@ class ImportSuggestionDenyListEntriesRequest(proto.Message): gcs_source (google.cloud.discoveryengine_v1.types.GcsSource): Cloud Storage location for the input content. - Only 1 file can be specified that contains all entries to - import. Supported values ``gcs_source.schema`` for - autocomplete suggestion deny list entry imports: + Only 1 file can be specified that contains all + entries to import. Supported values + ``gcs_source.schema`` for autocomplete + suggestion deny list entry imports: - - ``suggestion_deny_list`` (default): One JSON - [SuggestionDenyListEntry] per line. + * ``suggestion_deny_list`` (default): One JSON + [SuggestionDenyListEntry] per line. This field is a member of `oneof`_ ``source``. parent (str): - Required. The parent data store resource name for which to - import denylist entries. Follows pattern + Required. The parent data store resource name + for which to import denylist entries. Follows + pattern projects/*/locations/*/collections/*/dataStores/*. """ @@ -1265,7 +1335,8 @@ class InlineSource(proto.Message): class ImportSuggestionDenyListEntriesResponse(proto.Message): r"""Response message for - [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.ImportSuggestionDenyListEntries] + `CompletionService.ImportSuggestionDenyListEntries + `__ method. Attributes: @@ -1322,7 +1393,8 @@ class ImportSuggestionDenyListEntriesMetadata(proto.Message): class ImportCompletionSuggestionsRequest(proto.Message): r"""Request message for - [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1.CompletionService.ImportCompletionSuggestions] + `CompletionService.ImportCompletionSuggestions + `__ method. This message has `oneof`_ fields (mutually exclusive fields). @@ -1346,8 +1418,9 @@ class ImportCompletionSuggestionsRequest(proto.Message): This field is a member of `oneof`_ ``source``. parent (str): - Required. The parent data store resource name for which to - import customer autocomplete suggestions. + Required. The parent data store resource name + for which to import customer autocomplete + suggestions. Follows pattern ``projects/*/locations/*/collections/*/dataStores/*`` @@ -1404,10 +1477,11 @@ class InlineSource(proto.Message): class ImportCompletionSuggestionsResponse(proto.Message): r"""Response of the - [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1.CompletionService.ImportCompletionSuggestions] + `CompletionService.ImportCompletionSuggestions + `__ method. If the long running operation is done, this message is - returned by the google.longrunning.Operations.response field if the - operation is successful. + returned by the google.longrunning.Operations.response field if + the operation is successful. Attributes: error_samples (MutableSequence[google.rpc.status_pb2.Status]): @@ -1443,11 +1517,13 @@ class ImportCompletionSuggestionsMetadata(proto.Message): is done, this is also the finish time. success_count (int): Count of - [CompletionSuggestion][google.cloud.discoveryengine.v1.CompletionSuggestion]s + `CompletionSuggestion + `__s successfully imported. failure_count (int): Count of - [CompletionSuggestion][google.cloud.discoveryengine.v1.CompletionSuggestion]s + `CompletionSuggestion + `__s that failed to be imported. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/project.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/project.py index 23ec2dc21bae..2784661130f5 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/project.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/project.py @@ -34,9 +34,10 @@ class Project(proto.Message): Attributes: name (str): - Output only. Full resource name of the project, for example - ``projects/{project}``. Note that when making requests, - project number and project id are both acceptable, but the + Output only. Full resource name of the project, + for example ``projects/{project}``. + Note that when making requests, project number + and project id are both acceptable, but the server will always respond in project number. create_time (google.protobuf.timestamp_pb2.Timestamp): Output only. The timestamp when this project @@ -47,9 +48,9 @@ class Project(proto.Message): this project is still provisioning and is not ready for use. service_terms_map (MutableMapping[str, google.cloud.discoveryengine_v1.types.Project.ServiceTerms]): - Output only. A map of terms of services. The key is the - ``id`` of - [ServiceTerms][google.cloud.discoveryengine.v1.Project.ServiceTerms]. + Output only. A map of terms of services. The key + is the ``id`` of `ServiceTerms + `__. """ class ServiceTerms(proto.Message): @@ -57,18 +58,21 @@ class ServiceTerms(proto.Message): Attributes: id (str): - The unique identifier of this terms of service. Available - terms: + The unique identifier of this terms of service. + Available terms: - - ``GA_DATA_USE_TERMS``: `Terms for data - use `__. - When using this as ``id``, the acceptable - [version][google.cloud.discoveryengine.v1.Project.ServiceTerms.version] - to provide is ``2022-11-23``. + * ``GA_DATA_USE_TERMS``: `Terms for data + use + `__. + When using this as ``id``, the acceptable + `version + `__ + to provide is ``2022-11-23``. version (str): - The version string of the terms of service. For acceptable - values, see the comments for - [id][google.cloud.discoveryengine.v1.Project.ServiceTerms.id] + The version string of the terms of service. + For acceptable values, see the comments for + `id + `__ above. state (google.cloud.discoveryengine_v1.types.Project.ServiceTerms.State): Whether the project has accepted/rejected the diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/project_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/project_service.py index 77670cbe94f3..57ec8f64d2b0 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/project_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/project_service.py @@ -30,25 +30,30 @@ class ProvisionProjectRequest(proto.Message): r"""Request for - [ProjectService.ProvisionProject][google.cloud.discoveryengine.v1.ProjectService.ProvisionProject] + `ProjectService.ProvisionProject + `__ method. Attributes: name (str): Required. Full resource name of a - [Project][google.cloud.discoveryengine.v1.Project], such as - ``projects/{project_id_or_number}``. + `Project + `__, + such as ``projects/{project_id_or_number}``. accept_data_use_terms (bool): - Required. Set to ``true`` to specify that caller has read - and would like to give consent to the `Terms for data - use `__. + Required. Set to ``true`` to specify that caller + has read and would like to give consent to the + `Terms for data use + `__. data_use_terms_version (str): Required. The version of the `Terms for data - use `__ that - caller has read and would like to give consent to. + use + `__ + that caller has read and would like to give + consent to. - Acceptable version is ``2022-11-23``, and this may change - over time. + Acceptable version is ``2022-11-23``, and this + may change over time. """ name: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/purge_config.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/purge_config.py index 74cbdd1f53f1..e3d4d00cbc30 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/purge_config.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/purge_config.py @@ -48,44 +48,68 @@ class PurgeUserEventsRequest(proto.Message): Attributes: parent (str): - Required. The resource name of the catalog under which the - events are created. The format is + Required. The resource name of the catalog under + which the events are created. The format is ``projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}``. filter (str): - Required. The filter string to specify the events to be - deleted with a length limit of 5,000 characters. The - eligible fields for filtering are: + Required. The filter string to specify the + events to be deleted with a length limit of + 5,000 characters. The eligible fields for + filtering are: - - ``eventType``: Double quoted - [UserEvent.event_type][google.cloud.discoveryengine.v1.UserEvent.event_type] - string. - - ``eventTime``: in ISO 8601 "zulu" format. - - ``userPseudoId``: Double quoted string. Specifying this - will delete all events associated with a visitor. - - ``userId``: Double quoted string. Specifying this will - delete all events associated with a user. + * ``eventType``: Double quoted + `UserEvent.event_type + `__ + string. - Note: This API only supports purging a max range of 30 days. + * ``eventTime``: in ISO 8601 "zulu" format. + * ``userPseudoId``: Double quoted string. + Specifying this will delete all events + associated with a visitor. + + * ``userId``: Double quoted string. Specifying + this will delete all events associated with a + user. + + Note: This API only supports purging a max range + of 30 days. Examples: - - Deleting all events in a time range: - ``eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"`` - - Deleting specific eventType in a time range: - ``eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"`` - - Deleting all events for a specific visitor in a time - range: - ``eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"`` - - Deleting the past 30 days of events inside a DataStore: + * Deleting all events in a time range: + + ``eventTime > "2012-04-23T18:25:43.511Z" + eventTime < "2012-04-23T18:30:43.511Z"`` + + * Deleting specific eventType in a time range: + + ``eventTime > "2012-04-23T18:25:43.511Z" + eventTime < "2012-04-23T18:30:43.511Z" + eventType = "search"`` + + * Deleting all events for a specific visitor in + a time range: + + ``eventTime > "2012-04-23T18:25:43.511Z" + eventTime < "2012-04-23T18:30:43.511Z" + userPseudoId = "visitor1024"`` + + * Deleting the past 30 days of events inside a + DataStore: + ``*`` - The filtering fields are assumed to have an implicit AND. + The filtering fields are assumed to have an + implicit AND. force (bool): - The ``force`` field is currently not supported. Purge user - event requests will permanently delete all purgeable events. - Once the development is complete: If ``force`` is set to - false, the method will return the expected purge count - without deleting any user events. This field will default to + The ``force`` field is currently not supported. + Purge user event requests will permanently + delete all purgeable events. Once the + development is complete: + + If ``force`` is set to false, the method will + return the expected purge count without deleting + any user events. This field will default to false if not included in the request. """ @@ -166,10 +190,11 @@ class PurgeErrorConfig(proto.Message): Attributes: gcs_prefix (str): - Cloud Storage prefix for purge errors. This must be an - empty, existing Cloud Storage directory. Purge errors are - written to sharded files in this directory, one per line, as - a JSON-encoded ``google.rpc.Status`` message. + Cloud Storage prefix for purge errors. This must + be an empty, existing Cloud Storage directory. + Purge errors are written to sharded files in + this directory, one per line, as a JSON-encoded + ``google.rpc.Status`` message. This field is a member of `oneof`_ ``destination``. """ @@ -183,7 +208,8 @@ class PurgeErrorConfig(proto.Message): class PurgeDocumentsRequest(proto.Message): r"""Request message for - [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1.DocumentService.PurgeDocuments] + `DocumentService.PurgeDocuments + `__ method. This message has `oneof`_ fields (mutually exclusive fields). @@ -195,12 +221,13 @@ class PurgeDocumentsRequest(proto.Message): Attributes: gcs_source (google.cloud.discoveryengine_v1.types.GcsSource): - Cloud Storage location for the input content. Supported - ``data_schema``: + Cloud Storage location for the input content. + Supported ``data_schema``: - - ``document_id``: One valid - [Document.id][google.cloud.discoveryengine.v1.Document.id] - per line. + * ``document_id``: One valid + `Document.id + `__ + per line. This field is a member of `oneof`_ ``source``. inline_source (google.cloud.discoveryengine_v1.types.PurgeDocumentsRequest.InlineSource): @@ -212,26 +239,28 @@ class PurgeDocumentsRequest(proto.Message): Required. The parent resource name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. filter (str): - Required. Filter matching documents to purge. Only currently - supported value is ``*`` (all items). + Required. Filter matching documents to purge. + Only currently supported value is + ``*`` (all items). error_config (google.cloud.discoveryengine_v1.types.PurgeErrorConfig): The desired location of errors incurred during the purge. force (bool): - Actually performs the purge. If ``force`` is set to false, - return the expected purge count without deleting any - documents. + Actually performs the purge. If ``force`` is set + to false, return the expected purge count + without deleting any documents. """ class InlineSource(proto.Message): r"""The inline source for the input config for - [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1.DocumentService.PurgeDocuments] + `DocumentService.PurgeDocuments + `__ method. Attributes: documents (MutableSequence[str]): - Required. A list of full resource name of documents to - purge. In the format + Required. A list of full resource name of + documents to purge. In the format ``projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*``. Recommended max of 100 items. """ @@ -274,7 +303,8 @@ class InlineSource(proto.Message): class PurgeDocumentsResponse(proto.Message): r"""Response message for - [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1.DocumentService.PurgeDocuments] + `DocumentService.PurgeDocuments + `__ method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field. @@ -284,9 +314,10 @@ class PurgeDocumentsResponse(proto.Message): The total count of documents purged as a result of the operation. purge_sample (MutableSequence[str]): - A sample of document names that will be deleted. Only - populated if ``force`` is set to false. A max of 100 names - will be returned and the names are chosen at random. + A sample of document names that will be deleted. + Only populated if ``force`` is set to false. A + max of 100 names will be returned and the names + are chosen at random. """ purge_count: int = proto.Field( @@ -347,13 +378,15 @@ class PurgeDocumentsMetadata(proto.Message): class PurgeSuggestionDenyListEntriesRequest(proto.Message): r"""Request message for - [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.PurgeSuggestionDenyListEntries] + `CompletionService.PurgeSuggestionDenyListEntries + `__ method. Attributes: parent (str): - Required. The parent data store resource name for which to - import denylist entries. Follows pattern + Required. The parent data store resource name + for which to import denylist entries. Follows + pattern projects/*/locations/*/collections/*/dataStores/*. """ @@ -365,7 +398,8 @@ class PurgeSuggestionDenyListEntriesRequest(proto.Message): class PurgeSuggestionDenyListEntriesResponse(proto.Message): r"""Response message for - [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.PurgeSuggestionDenyListEntries] + `CompletionService.PurgeSuggestionDenyListEntries + `__ method. Attributes: @@ -415,13 +449,15 @@ class PurgeSuggestionDenyListEntriesMetadata(proto.Message): class PurgeCompletionSuggestionsRequest(proto.Message): r"""Request message for - [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1.CompletionService.PurgeCompletionSuggestions] + `CompletionService.PurgeCompletionSuggestions + `__ method. Attributes: parent (str): - Required. The parent data store resource name for which to - purge completion suggestions. Follows pattern + Required. The parent data store resource name + for which to purge completion suggestions. + Follows pattern projects/*/locations/*/collections/*/dataStores/*. """ @@ -433,7 +469,8 @@ class PurgeCompletionSuggestionsRequest(proto.Message): class PurgeCompletionSuggestionsResponse(proto.Message): r"""Response message for - [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1.CompletionService.PurgeCompletionSuggestions] + `CompletionService.PurgeCompletionSuggestions + `__ method. Attributes: diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/rank_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/rank_service.py index 523aabfa5335..9dee9f05ef12 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/rank_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/rank_service.py @@ -31,24 +31,30 @@ class RankingRecord(proto.Message): r"""Record message for - [RankService.Rank][google.cloud.discoveryengine.v1.RankService.Rank] - method. + `RankService.Rank + `__ method. Attributes: id (str): The unique ID to represent the record. title (str): - The title of the record. Empty by default. At least one of - [title][google.cloud.discoveryengine.v1.RankingRecord.title] - or - [content][google.cloud.discoveryengine.v1.RankingRecord.content] - should be set otherwise an INVALID_ARGUMENT error is thrown. + The title of the record. Empty by default. + At least one of + `title + `__ + or `content + `__ + should be set otherwise an INVALID_ARGUMENT + error is thrown. content (str): - The content of the record. Empty by default. At least one of - [title][google.cloud.discoveryengine.v1.RankingRecord.title] - or - [content][google.cloud.discoveryengine.v1.RankingRecord.content] - should be set otherwise an INVALID_ARGUMENT error is thrown. + The content of the record. Empty by default. + At least one of + `title + `__ + or `content + `__ + should be set otherwise an INVALID_ARGUMENT + error is thrown. score (float): The score of this record based on the given query and selected model. The score will be @@ -77,22 +83,22 @@ class RankingRecord(proto.Message): class RankRequest(proto.Message): r"""Request message for - [RankService.Rank][google.cloud.discoveryengine.v1.RankService.Rank] - method. + `RankService.Rank + `__ method. Attributes: ranking_config (str): - Required. The resource name of the rank service config, such - as + Required. The resource name of the rank service + config, such as ``projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config``. model (str): - The identifier of the model to use. It is one of: + The identifier of the model to use. It is one + of: + * ``semantic-ranker-512@latest``: Semantic + ranking model with maximum input token size 512. - - ``semantic-ranker-512@latest``: Semantic ranking model - with maximum input token size 512. - - It is set to ``semantic-ranker-512@latest`` by default if - unspecified. + It is set to ``semantic-ranker-512@latest`` by + default if unspecified. top_n (int): The number of results to return. If this is unset or no bigger than zero, returns all @@ -107,26 +113,32 @@ class RankRequest(proto.Message): record ID and score. By default, it is false, the response will contain record details. user_labels (MutableMapping[str, str]): - The user labels applied to a resource must meet the - following requirements: - - - Each resource can have multiple labels, up to a maximum of - 64. - - Each label must be a key-value pair. - - Keys have a minimum length of 1 character and a maximum - length of 63 characters and cannot be empty. Values can be - empty and have a maximum length of 63 characters. - - Keys and values can contain only lowercase letters, - numeric characters, underscores, and dashes. All - characters must use UTF-8 encoding, and international - characters are allowed. - - The key portion of a label must be unique. However, you - can use the same key with multiple resources. - - Keys must start with a lowercase letter or international - character. + The user labels applied to a resource must meet + the following requirements: + * Each resource can have multiple labels, up to + a maximum of 64. + + * Each label must be a key-value pair. + * Keys have a minimum length of 1 character and + a maximum length of 63 characters and cannot + be empty. Values can be empty and have a maximum + length of 63 characters. + + * Keys and values can contain only lowercase + letters, numeric characters, underscores, and + dashes. All characters must use UTF-8 encoding, + and international characters are allowed. + + * The key portion of a label must be unique. + However, you can use the same key with + multiple resources. + + * Keys must start with a lowercase letter or + international character. See `Google Cloud - Document `__ + Document + `__ for more details. """ @@ -164,8 +176,8 @@ class RankRequest(proto.Message): class RankResponse(proto.Message): r"""Response message for - [RankService.Rank][google.cloud.discoveryengine.v1.RankService.Rank] - method. + `RankService.Rank + `__ method. Attributes: records (MutableSequence[google.cloud.discoveryengine_v1.types.RankingRecord]): diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/recommendation_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/recommendation_service.py index aa40514fe133..5b436ab96e11 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/recommendation_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/recommendation_service.py @@ -38,38 +38,48 @@ class RecommendRequest(proto.Message): Attributes: serving_config (str): Required. Full resource name of a - [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig]: + `ServingConfig + `__: + ``projects/*/locations/global/collections/*/engines/*/servingConfigs/*``, or ``projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`` - One default serving config is created along with your - recommendation engine creation. The engine ID is used as the - ID of the default serving config. For example, for Engine + One default serving config is created along with + your recommendation engine creation. The engine + ID is used as the ID of the default serving + config. For example, for Engine ``projects/*/locations/global/collections/*/engines/my-engine``, you can use ``projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`` for your - [RecommendationService.Recommend][google.cloud.discoveryengine.v1.RecommendationService.Recommend] + `RecommendationService.Recommend + `__ requests. user_event (google.cloud.discoveryengine_v1.types.UserEvent): - Required. Context about the user, what they are looking at - and what action they took to trigger the Recommend request. - Note that this user event detail won't be ingested to - userEvent logs. Thus, a separate userEvent write request is + Required. Context about the user, what they are + looking at and what action they took to trigger + the Recommend request. Note that this user event + detail won't be ingested to userEvent logs. + Thus, a separate userEvent write request is required for event logging. Don't set - [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id] + `UserEvent.user_pseudo_id + `__ or - [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1.UserInfo.user_id] - to the same fixed ID for different users. If you are trying - to receive non-personalized recommendations (not - recommended; this can negatively impact model performance), - instead set - [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id] + `UserEvent.user_info.user_id + `__ + to the same fixed ID for different users. If you + are trying to receive non-personalized + recommendations (not recommended; this can + negatively impact model performance), instead + set + `UserEvent.user_pseudo_id + `__ to a random unique ID and leave - [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1.UserInfo.user_id] + `UserEvent.user_info.user_id + `__ unset. page_size (int): Maximum number of results to return. Set this @@ -78,95 +88,120 @@ class RecommendRequest(proto.Message): reasonable default. The maximum allowed value is 100. Values above 100 are set to 100. filter (str): - Filter for restricting recommendation results with a length - limit of 5,000 characters. Currently, only filter - expressions on the ``filter_tags`` attribute is supported. + Filter for restricting recommendation results + with a length limit of 5,000 characters. + Currently, only filter expressions on the + ``filter_tags`` attribute is supported. Examples: - - ``(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))`` - - ``(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))`` - - If ``attributeFilteringSyntax`` is set to true under the - ``params`` field, then attribute-based expressions are - expected instead of the above described tag-based syntax. - Examples: - - - (language: ANY("en", "es")) AND NOT (categories: - ANY("Movie")) - - (available: true) AND (language: ANY("en", "es")) OR - (categories: ANY("Movie")) - - If your filter blocks all results, the API returns generic - (unfiltered) popular Documents. If you only want results - strictly matching the filters, set ``strictFiltering`` to - ``true`` in - [RecommendRequest.params][google.cloud.discoveryengine.v1.RecommendRequest.params] + * ``(filter_tags: ANY("Red", "Blue") OR + filter_tags: ANY("Hot", "Cold"))`` * + ``(filter_tags: ANY("Red", "Blue")) AND NOT + (filter_tags: ANY("Green"))`` + + If ``attributeFilteringSyntax`` is set to true + under the ``params`` field, then attribute-based + expressions are expected instead of the above + described tag-based syntax. Examples: + + * (language: ANY("en", "es")) AND NOT + (categories: ANY("Movie")) * (available: true) + AND + (language: ANY("en", "es")) OR (categories: + ANY("Movie")) + + If your filter blocks all results, the API + returns generic (unfiltered) popular Documents. + If you only want results strictly matching the + filters, set ``strictFiltering`` to ``true`` in + `RecommendRequest.params + `__ to receive empty results instead. Note that the API never returns - [Document][google.cloud.discoveryengine.v1.Document]s with - ``storageStatus`` as ``EXPIRED`` or ``DELETED`` regardless - of filter choices. + `Document + `__s + with ``storageStatus`` as ``EXPIRED`` or + ``DELETED`` regardless of filter choices. validate_only (bool): - Use validate only mode for this recommendation query. If set - to ``true``, a fake model is used that returns arbitrary - Document IDs. Note that the validate only mode should only - be used for testing the API, or if the model is not ready. + Use validate only mode for this recommendation + query. If set to ``true``, a fake model is used + that returns arbitrary Document IDs. Note that + the validate only mode should only be used for + testing the API, or if the model is not ready. params (MutableMapping[str, google.protobuf.struct_pb2.Value]): Additional domain specific parameters for the recommendations. - Allowed values: - - ``returnDocument``: Boolean. If set to ``true``, the - associated Document object is returned in - [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1.RecommendResponse.RecommendationResult.document]. - - ``returnScore``: Boolean. If set to true, the - recommendation score corresponding to each returned - Document is set in - [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1.RecommendResponse.RecommendationResult.metadata]. - The given score indicates the probability of a Document - conversion given the user's context and history. - - ``strictFiltering``: Boolean. True by default. If set to - ``false``, the service returns generic (unfiltered) - popular Documents instead of empty if your filter blocks - all recommendation results. - - ``diversityLevel``: String. Default empty. If set to be - non-empty, then it needs to be one of: - - - ``no-diversity`` - - ``low-diversity`` - - ``medium-diversity`` - - ``high-diversity`` - - ``auto-diversity`` This gives request-level control and - adjusts recommendation results based on Document - category. - - - ``attributeFilteringSyntax``: Boolean. False by default. - If set to true, the ``filter`` field is interpreted - according to the new, attribute-based syntax. + * ``returnDocument``: Boolean. If set to + ``true``, the associated Document object is + returned in + `RecommendResponse.RecommendationResult.document + `__. + + * ``returnScore``: Boolean. If set to true, the + recommendation score corresponding to each + returned Document is set in + `RecommendResponse.RecommendationResult.metadata + `__. + The given score indicates the probability of a + Document conversion given the user's context + and history. + + * ``strictFiltering``: Boolean. True by default. + If set to ``false``, the service + returns generic (unfiltered) popular + Documents instead of empty if your filter + blocks all recommendation results. + + * ``diversityLevel``: String. Default empty. If + set to be non-empty, then it needs to be one + of: + + * ``no-diversity`` + * ``low-diversity`` + + * ``medium-diversity`` + * ``high-diversity`` + + * ``auto-diversity`` + This gives request-level control and adjusts + recommendation results based on Document + category. + + * ``attributeFilteringSyntax``: Boolean. False + by default. If set to true, the ``filter`` + field is interpreted according to the new, + attribute-based syntax. user_labels (MutableMapping[str, str]): - The user labels applied to a resource must meet the - following requirements: - - - Each resource can have multiple labels, up to a maximum of - 64. - - Each label must be a key-value pair. - - Keys have a minimum length of 1 character and a maximum - length of 63 characters and cannot be empty. Values can be - empty and have a maximum length of 63 characters. - - Keys and values can contain only lowercase letters, - numeric characters, underscores, and dashes. All - characters must use UTF-8 encoding, and international - characters are allowed. - - The key portion of a label must be unique. However, you - can use the same key with multiple resources. - - Keys must start with a lowercase letter or international - character. + The user labels applied to a resource must meet + the following requirements: + * Each resource can have multiple labels, up to + a maximum of 64. + + * Each label must be a key-value pair. + * Keys have a minimum length of 1 character and + a maximum length of 63 characters and cannot + be empty. Values can be empty and have a maximum + length of 63 characters. + + * Keys and values can contain only lowercase + letters, numeric characters, underscores, and + dashes. All characters must use UTF-8 encoding, + and international characters are allowed. + + * The key portion of a label must be unique. + However, you can use the same key with + multiple resources. + + * Keys must start with a lowercase letter or + international character. See `Requirements for - labels `__ + labels + `__ for more details. """ @@ -213,17 +248,20 @@ class RecommendResponse(proto.Message): represents the ranking (from the most relevant Document to the least). attribution_token (str): - A unique attribution token. This should be included in the - [UserEvent][google.cloud.discoveryengine.v1.UserEvent] logs - resulting from this recommendation, which enables accurate - attribution of recommendation model performance. + A unique attribution token. This should be + included in the `UserEvent + `__ + logs resulting from this recommendation, which + enables accurate attribution of recommendation + model performance. missing_ids (MutableSequence[str]): IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig. validate_only (bool): True if - [RecommendRequest.validate_only][google.cloud.discoveryengine.v1.RecommendRequest.validate_only] + `RecommendRequest.validate_only + `__ was set. """ @@ -236,15 +274,18 @@ class RecommendationResult(proto.Message): Resource ID of the recommended Document. document (google.cloud.discoveryengine_v1.types.Document): Set if ``returnDocument`` is set to true in - [RecommendRequest.params][google.cloud.discoveryengine.v1.RecommendRequest.params]. + `RecommendRequest.params + `__. metadata (MutableMapping[str, google.protobuf.struct_pb2.Value]): Additional Document metadata or annotations. Possible values: - - ``score``: Recommendation score in double value. Is set if - ``returnScore`` is set to true in - [RecommendRequest.params][google.cloud.discoveryengine.v1.RecommendRequest.params]. + * ``score``: Recommendation score in double + value. Is set if ``returnScore`` is set to + true in + `RecommendRequest.params + `__. """ id: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/schema.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/schema.py index 18e6d43e0a35..9d0dc820efb0 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/schema.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/schema.py @@ -48,12 +48,12 @@ class Schema(proto.Message): This field is a member of `oneof`_ ``schema``. name (str): - Immutable. The full resource name of the schema, in the - format of + Immutable. The full resource name of the schema, + in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}``. - This field must be a UTF-8 encoded string with a length - limit of 1024 characters. + This field must be a UTF-8 encoded string with a + length limit of 1024 characters. """ struct_schema: struct_pb2.Struct = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/schema_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/schema_service.py index a54f02bcbd97..6500a84a4b9d 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/schema_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/schema_service.py @@ -40,13 +40,14 @@ class GetSchemaRequest(proto.Message): r"""Request message for - [SchemaService.GetSchema][google.cloud.discoveryengine.v1.SchemaService.GetSchema] + `SchemaService.GetSchema + `__ method. Attributes: name (str): - Required. The full resource name of the schema, in the - format of + Required. The full resource name of the schema, + in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}``. """ @@ -58,33 +59,40 @@ class GetSchemaRequest(proto.Message): class ListSchemasRequest(proto.Message): r"""Request message for - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1.SchemaService.ListSchemas] + `SchemaService.ListSchemas + `__ method. Attributes: parent (str): - Required. The parent data store resource name, in the format - of + Required. The parent data store resource name, + in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}``. page_size (int): - The maximum number of - [Schema][google.cloud.discoveryengine.v1.Schema]s to return. - The service may return fewer than this value. + The maximum number of `Schema + `__s to + return. The service may return fewer than this + value. If unspecified, at most 100 - [Schema][google.cloud.discoveryengine.v1.Schema]s are + `Schema + `__s are returned. - The maximum value is 1000; values above 1000 are set to - 1000. + The maximum value is 1000; values above 1000 are + set to 1000. page_token (str): A page token, received from a previous - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1.SchemaService.ListSchemas] - call. Provide this to retrieve the subsequent page. - - When paginating, all other parameters provided to - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1.SchemaService.ListSchemas] - must match the call that provided the page token. + `SchemaService.ListSchemas + `__ + call. Provide this to retrieve the subsequent + page. + + When paginating, all other parameters provided + to `SchemaService.ListSchemas + `__ + must match the call that provided the page + token. """ parent: str = proto.Field( @@ -103,17 +111,20 @@ class ListSchemasRequest(proto.Message): class ListSchemasResponse(proto.Message): r"""Response message for - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1.SchemaService.ListSchemas] + `SchemaService.ListSchemas + `__ method. Attributes: schemas (MutableSequence[google.cloud.discoveryengine_v1.types.Schema]): - The [Schema][google.cloud.discoveryengine.v1.Schema]s. + The `Schema + `__s. next_page_token (str): A token that can be sent as - [ListSchemasRequest.page_token][google.cloud.discoveryengine.v1.ListSchemasRequest.page_token] - to retrieve the next page. If this field is omitted, there - are no subsequent pages. + `ListSchemasRequest.page_token + `__ + to retrieve the next page. If this field is + omitted, there are no subsequent pages. """ @property @@ -133,26 +144,31 @@ def raw_page(self): class CreateSchemaRequest(proto.Message): r"""Request message for - [SchemaService.CreateSchema][google.cloud.discoveryengine.v1.SchemaService.CreateSchema] + `SchemaService.CreateSchema + `__ method. Attributes: parent (str): - Required. The parent data store resource name, in the format - of + Required. The parent data store resource name, + in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}``. schema (google.cloud.discoveryengine_v1.types.Schema): - Required. The - [Schema][google.cloud.discoveryengine.v1.Schema] to create. + Required. The `Schema + `__ to + create. schema_id (str): Required. The ID to use for the - [Schema][google.cloud.discoveryengine.v1.Schema], which - becomes the final component of the - [Schema.name][google.cloud.discoveryengine.v1.Schema.name]. + `Schema + `__, + which becomes the final component of the + `Schema.name + `__. This field should conform to - `RFC-1034 `__ standard - with a length limit of 63 characters. + `RFC-1034 + `__ + standard with a length limit of 63 characters. """ parent: str = proto.Field( @@ -172,19 +188,22 @@ class CreateSchemaRequest(proto.Message): class UpdateSchemaRequest(proto.Message): r"""Request message for - [SchemaService.UpdateSchema][google.cloud.discoveryengine.v1.SchemaService.UpdateSchema] + `SchemaService.UpdateSchema + `__ method. Attributes: schema (google.cloud.discoveryengine_v1.types.Schema): - Required. The - [Schema][google.cloud.discoveryengine.v1.Schema] to update. + Required. The `Schema + `__ to + update. allow_missing (bool): - If set to true, and the - [Schema][google.cloud.discoveryengine.v1.Schema] is not - found, a new - [Schema][google.cloud.discoveryengine.v1.Schema] is created. - In this situation, ``update_mask`` is ignored. + If set to true, and the `Schema + `__ is + not found, a new `Schema + `__ is + created. In this situation, ``update_mask`` is + ignored. """ schema: gcd_schema.Schema = proto.Field( @@ -200,13 +219,14 @@ class UpdateSchemaRequest(proto.Message): class DeleteSchemaRequest(proto.Message): r"""Request message for - [SchemaService.DeleteSchema][google.cloud.discoveryengine.v1.SchemaService.DeleteSchema] + `SchemaService.DeleteSchema + `__ method. Attributes: name (str): - Required. The full resource name of the schema, in the - format of + Required. The full resource name of the schema, + in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}``. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/search_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/search_service.py index 0bbbbac3121a..56eb0d2d2d06 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/search_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/search_service.py @@ -35,164 +35,192 @@ class SearchRequest(proto.Message): r"""Request message for - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] + `SearchService.Search + `__ method. Attributes: serving_config (str): - Required. The resource name of the Search serving config, - such as + Required. The resource name of the Search + serving config, such as ``projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config``, or ``projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config``. - This field is used to identify the serving configuration - name, set of models used to make the search. + This field is used to identify the serving + configuration name, set of models used to make + the search. branch (str): The branch resource name, such as ``projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0``. - Use ``default_branch`` as the branch ID or leave this field - empty, to search documents under the default branch. + Use ``default_branch`` as the branch ID or leave + this field empty, to search documents under the + default branch. query (str): Raw search query. image_query (google.cloud.discoveryengine_v1.types.SearchRequest.ImageQuery): Raw image query. page_size (int): - Maximum number of - [Document][google.cloud.discoveryengine.v1.Document]s to - return. The maximum allowed value depends on the data type. - Values above the maximum value are coerced to the maximum - value. - - - Websites with basic indexing: Default ``10``, Maximum - ``25``. - - Websites with advanced indexing: Default ``25``, Maximum - ``50``. - - Other: Default ``50``, Maximum ``100``. - - If this field is negative, an ``INVALID_ARGUMENT`` is - returned. + Maximum number of `Document + `__s + to return. The maximum allowed value depends on + the data type. Values above the maximum value + are coerced to the maximum value. + + * Websites with basic indexing: Default ``10``, + Maximum ``25``. * Websites with advanced + indexing: Default ``25``, Maximum ``50``. + + * Other: Default ``50``, Maximum ``100``. + + If this field is negative, an + ``INVALID_ARGUMENT`` is returned. page_token (str): A page token received from a previous - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] - call. Provide this to retrieve the subsequent page. - - When paginating, all other parameters provided to - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] - must match the call that provided the page token. Otherwise, - an ``INVALID_ARGUMENT`` error is returned. + `SearchService.Search + `__ + call. Provide this to retrieve the subsequent + page. + + When paginating, all other parameters provided + to `SearchService.Search + `__ + must match the call that provided the page + token. Otherwise, an ``INVALID_ARGUMENT`` + error is returned. offset (int): - A 0-indexed integer that specifies the current offset (that - is, starting result location, amongst the - [Document][google.cloud.discoveryengine.v1.Document]s deemed - by the API as relevant) in search results. This field is - only considered if - [page_token][google.cloud.discoveryengine.v1.SearchRequest.page_token] + A 0-indexed integer that specifies the current + offset (that is, starting result location, + amongst the `Document + `__s + deemed by the API as relevant) in search + results. This field is only considered if + `page_token + `__ is unset. - If this field is negative, an ``INVALID_ARGUMENT`` is - returned. + If this field is negative, an + ``INVALID_ARGUMENT`` is returned. one_box_page_size (int): The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. data_store_specs (MutableSequence[google.cloud.discoveryengine_v1.types.SearchRequest.DataStoreSpec]): Specifications that define the specific - [DataStore][google.cloud.discoveryengine.v1.DataStore]s to - be searched, along with configurations for those data - stores. This is only considered for - [Engine][google.cloud.discoveryengine.v1.Engine]s with - multiple data stores. For engines with a single data store, - the specs directly under - [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] + `DataStore + `__s + to be searched, along with configurations for + those data stores. This is only considered for + `Engine + `__s + with multiple data stores. For engines with a + single data store, the specs directly under + `SearchRequest + `__ should be used. filter (str): - The filter syntax consists of an expression language for - constructing a predicate from one or more fields of the - documents being filtered. Filter expression is - case-sensitive. - - If this field is unrecognizable, an ``INVALID_ARGUMENT`` is - returned. - - Filtering in Vertex AI Search is done by mapping the LHS - filter key to a key property defined in the Vertex AI Search - backend -- this mapping is defined by the customer in their - schema. For example a media customer might have a field - 'name' in their schema. In this case the filter would look - like this: filter --> name:'ANY("king kong")' - - For more information about filtering including syntax and - filter operators, see - `Filter `__ + The filter syntax consists of an expression + language for constructing a predicate from one + or more fields of the documents being filtered. + Filter expression is case-sensitive. + + If this field is unrecognizable, an + ``INVALID_ARGUMENT`` is returned. + + Filtering in Vertex AI Search is done by mapping + the LHS filter key to a key property defined in + the Vertex AI Search backend -- this mapping is + defined by the customer in their schema. For + example a media customer might have a field + 'name' in their schema. In this case the filter + would look like this: filter --> name:'ANY("king + kong")' + + For more information about filtering including + syntax and filter operators, see + `Filter + `__ canonical_filter (str): - The default filter that is applied when a user performs a - search without checking any filters on the search page. - - The filter applied to every search request when quality - improvement such as query expansion is needed. In the case a - query does not have a sufficient amount of results this - filter will be used to determine whether or not to enable - the query expansion flow. The original filter will still be - used for the query expanded search. This field is strongly - recommended to achieve high search quality. + The default filter that is applied when a user + performs a search without checking any filters + on the search page. + + The filter applied to every search request when + quality improvement such as query expansion is + needed. In the case a query does not have a + sufficient amount of results this filter will be + used to determine whether or not to enable the + query expansion flow. The original filter will + still be used for the query expanded search. + This field is strongly recommended to achieve + high search quality. For more information about filter syntax, see - [SearchRequest.filter][google.cloud.discoveryengine.v1.SearchRequest.filter]. + `SearchRequest.filter + `__. order_by (str): - The order in which documents are returned. Documents can be - ordered by a field in an - [Document][google.cloud.discoveryengine.v1.Document] object. - Leave it unset if ordered by relevance. ``order_by`` - expression is case-sensitive. - - For more information on ordering the website search results, - see `Order web search - results `__. - For more information on ordering the healthcare search - results, see `Order healthcare search - results `__. - If this field is unrecognizable, an ``INVALID_ARGUMENT`` is - returned. + The order in which documents are returned. + Documents can be ordered by a field in an + `Document + `__ + object. Leave it unset if ordered by relevance. + ``order_by`` expression is case-sensitive. + + For more information on ordering the website + search results, see `Order web search + results + `__. + For more information on ordering the healthcare + search results, see `Order healthcare search + results + `__. + If this field is unrecognizable, an + ``INVALID_ARGUMENT`` is returned. user_info (google.cloud.discoveryengine_v1.types.UserInfo): - Information about the end user. Highly recommended for - analytics and personalization. - [UserInfo.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent] + Information about the end user. + Highly recommended for analytics and + personalization. `UserInfo.user_agent + `__ is used to deduce ``device_type`` for analytics. language_code (str): - The BCP-47 language code, such as "en-US" or "sr-Latn". For - more information, see `Standard - fields `__. - This field helps to better interpret the query. If a value - isn't specified, the query language code is automatically - detected, which may not be accurate. + The BCP-47 language code, such as "en-US" or + "sr-Latn". For more information, see `Standard + fields + `__. + This field helps to better interpret the query. + If a value isn't specified, the query language + code is automatically detected, which may not be + accurate. facet_specs (MutableSequence[google.cloud.discoveryengine_v1.types.SearchRequest.FacetSpec]): - Facet specifications for faceted search. If empty, no facets - are returned. - - A maximum of 100 values are allowed. Otherwise, an - ``INVALID_ARGUMENT`` error is returned. + Facet specifications for faceted search. If + empty, no facets are returned. + A maximum of 100 values are allowed. Otherwise, + an ``INVALID_ARGUMENT`` error is returned. boost_spec (google.cloud.discoveryengine_v1.types.SearchRequest.BoostSpec): - Boost specification to boost certain documents. For more - information on boosting, see - `Boosting `__ + Boost specification to boost certain documents. + For more information on boosting, see + `Boosting + `__ params (MutableMapping[str, google.protobuf.struct_pb2.Value]): Additional search parameters. - For public website search only, supported values are: + For public website search only, supported values + are: - - ``user_country_code``: string. Default empty. If set to - non-empty, results are restricted or boosted based on the - location provided. For example, - ``user_country_code: "au"`` + * ``user_country_code``: string. Default empty. + If set to non-empty, results are restricted + or boosted based on the location provided. + For example, ``user_country_code: "au"`` - For available codes see `Country - Codes `__ + For available codes see `Country + Codes + `__ - - ``search_type``: double. Default empty. Enables - non-webpage searching depending on the value. The only - valid non-default value is 1, which enables image - searching. For example, ``search_type: 1`` + * ``search_type``: double. Default empty. + Enables non-webpage searching depending on + the value. The only valid non-default value is + 1, which enables image searching. + For example, ``search_type: 1`` query_expansion_spec (google.cloud.discoveryengine_v1.types.SearchRequest.QueryExpansionSpec): The query expansion specification that specifies the conditions under which query @@ -202,23 +230,26 @@ class SearchRequest(proto.Message): specifies the mode under which spell correction takes effect. user_pseudo_id (str): - A unique identifier for tracking visitors. For example, this - could be implemented with an HTTP cookie, which should be - able to uniquely identify a visitor on a single device. This - unique identifier should not change if the visitor logs in - or out of the website. + A unique identifier for tracking visitors. For + example, this could be implemented with an HTTP + cookie, which should be able to uniquely + identify a visitor on a single device. This + unique identifier should not change if the + visitor logs in or out of the website. This field should NOT have a fixed value such as ``unknown_visitor``. This should be the same identifier as - [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id] + `UserEvent.user_pseudo_id + `__ and - [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id] + `CompleteQueryRequest.user_pseudo_id + `__ - The field must be a UTF-8 encoded string with a length limit - of 128 characters. Otherwise, an ``INVALID_ARGUMENT`` error - is returned. + The field must be a UTF-8 encoded string with a + length limit of 128 characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. content_search_spec (google.cloud.discoveryengine_v1.types.SearchRequest.ContentSearchSpec): A specification for configuring the behavior of content search. @@ -226,30 +257,37 @@ class SearchRequest(proto.Message): Whether to turn on safe search. This is only supported for website search. user_labels (MutableMapping[str, str]): - The user labels applied to a resource must meet the - following requirements: - - - Each resource can have multiple labels, up to a maximum of - 64. - - Each label must be a key-value pair. - - Keys have a minimum length of 1 character and a maximum - length of 63 characters and cannot be empty. Values can be - empty and have a maximum length of 63 characters. - - Keys and values can contain only lowercase letters, - numeric characters, underscores, and dashes. All - characters must use UTF-8 encoding, and international - characters are allowed. - - The key portion of a label must be unique. However, you - can use the same key with multiple resources. - - Keys must start with a lowercase letter or international - character. + The user labels applied to a resource must meet + the following requirements: + * Each resource can have multiple labels, up to + a maximum of 64. + + * Each label must be a key-value pair. + * Keys have a minimum length of 1 character and + a maximum length of 63 characters and cannot + be empty. Values can be empty and have a maximum + length of 63 characters. + + * Keys and values can contain only lowercase + letters, numeric characters, underscores, and + dashes. All characters must use UTF-8 encoding, + and international characters are allowed. + + * The key portion of a label must be unique. + However, you can use the same key with + multiple resources. + + * Keys must start with a lowercase letter or + international character. See `Google Cloud - Document `__ + Document + `__ for more details. search_as_you_type_spec (google.cloud.discoveryengine_v1.types.SearchRequest.SearchAsYouTypeSpec): - Search as you type configuration. Only supported for the - [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1.IndustryVertical.MEDIA] + Search as you type configuration. Only supported + for the `IndustryVertical.MEDIA + `__ vertical. display_spec (google.cloud.discoveryengine_v1.types.SearchRequest.DisplaySpec): Optional. Config for display feature, like @@ -302,35 +340,22 @@ class SearchRequest(proto.Message): Optional. The specification for returning the relevance score. ranking_expression (str): - The ranking expression controls the customized ranking on - retrieval documents. This overrides - [ServingConfig.ranking_expression][google.cloud.discoveryengine.v1.ServingConfig.ranking_expression]. - The syntax and supported features depend on the - ``ranking_expression_backend`` value. If - ``ranking_expression_backend`` is not provided, it defaults - to ``RANK_BY_EMBEDDING``. - - If - [ranking_expression_backend][google.cloud.discoveryengine.v1.SearchRequest.ranking_expression_backend] - is not provided or set to ``RANK_BY_EMBEDDING``, it should - be a single function or multiple functions that are joined - by "+". - - - ranking_expression = function, { " + ", function }; + The ranking expression controls the customized ranking on retrieval documents. This overrides [ServingConfig.ranking_expression][google.cloud.discoveryengine.v1.ServingConfig.ranking_expression]. The syntax and supported features depend on the ``ranking_expression_backend`` value. If ``ranking_expression_backend`` is not provided, it defaults to ``RANK_BY_EMBEDDING``. + + If [ranking_expression_backend][google.cloud.discoveryengine.v1.SearchRequest.ranking_expression_backend] is not provided or set to ``RANK_BY_EMBEDDING``, it should be a single function or multiple functions that are joined by "+". + + - ranking_expression = function, { " + ", function }; Supported functions: - - double \* relevance_score - - double \* dotProduct(embedding_field_path) + - double \* relevance_score + - double \* dotProduct(embedding_field_path) Function variables: - - ``relevance_score``: pre-defined keywords, used for - measure relevance between query and document. - - ``embedding_field_path``: the document embedding field - used with query embedding vector. - - ``dotProduct``: embedding function between - ``embedding_field_path`` and query embedding vector. + - ``relevance_score``: pre-defined keywords, used for measure relevance between query and document. + - ``embedding_field_path``: the document embedding field used with query embedding vector. + - ``dotProduct``: embedding function between ``embedding_field_path`` and query embedding vector. Example ranking expression: @@ -339,71 +364,34 @@ class SearchRequest(proto.Message): If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. - If - [ranking_expression_backend][google.cloud.discoveryengine.v1.SearchRequest.ranking_expression_backend] - is set to ``RANK_BY_FORMULA``, the following expression - types (and combinations of those chained using + or - - - operators) are supported: - - - ``double`` - - ``signal`` - - ``log(signal)`` - - ``exp(signal)`` - - ``rr(signal, double > 0)`` -- reciprocal rank - transformation with second argument being a denominator - constant. - - ``is_nan(signal)`` -- returns 0 if signal is NaN, 1 - otherwise. - - ``fill_nan(signal1, signal2 | double)`` -- if signal1 is - NaN, returns signal2 \| double, else returns signal1. - - Here are a few examples of ranking formulas that use the - supported ranking expression types: - - - ``0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`` - -- mostly rank by the logarithm of - ``keyword_similarity_score`` with slight - ``semantic_smilarity_score`` adjustment. - - ``0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)`` - -- rank by the exponent of ``semantic_similarity_score`` - filling the value with 0 if it's NaN, also add constant - 0.3 adjustment to the final score if - ``semantic_similarity_score`` is NaN. - - ``0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)`` - -- mostly rank by the reciprocal rank of - ``keyword_similarity_score`` with slight adjustment of - reciprocal rank of ``semantic_smilarity_score``. + If [ranking_expression_backend][google.cloud.discoveryengine.v1.SearchRequest.ranking_expression_backend] is set to ``RANK_BY_FORMULA``, the following expression types (and combinations of those chained using + or + + - operators) are supported: + + - ``double`` + - ``signal`` + - ``log(signal)`` + - ``exp(signal)`` + - ``rr(signal, double > 0)`` -- reciprocal rank transformation with second argument being a denominator constant. + - ``is_nan(signal)`` -- returns 0 if signal is NaN, 1 otherwise. + - ``fill_nan(signal1, signal2 | double)`` -- if signal1 is NaN, returns signal2 \| double, else returns signal1. + + Here are a few examples of ranking formulas that use the supported ranking expression types: + + - ``0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`` -- mostly rank by the logarithm of ``keyword_similarity_score`` with slight ``semantic_smilarity_score`` adjustment. + - ``0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)`` -- rank by the exponent of ``semantic_similarity_score`` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if ``semantic_similarity_score`` is NaN. + - ``0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)`` -- mostly rank by the reciprocal rank of ``keyword_similarity_score`` with slight adjustment of reciprocal rank of ``semantic_smilarity_score``. The following signals are supported: - - ``semantic_similarity_score``: semantic similarity - adjustment that is calculated using the embeddings - generated by a proprietary Google model. This score - determines how semantically similar a search query is to a - document. - - ``keyword_similarity_score``: keyword match adjustment - uses the Best Match 25 (BM25) ranking function. This score - is calculated using a probabilistic model to estimate the - probability that a document is relevant to a given query. - - ``relevance_score``: semantic relevance adjustment that - uses a proprietary Google model to determine the meaning - and intent behind a user's query in context with the - content in the documents. - - ``pctr_rank``: predicted conversion rate adjustment as a - rank use predicted Click-through rate (pCTR) to gauge the - relevance and attractiveness of a search result from a - user's perspective. A higher pCTR suggests that the result - is more likely to satisfy the user's query and intent, - making it a valuable signal for ranking. - - ``freshness_rank``: freshness adjustment as a rank - - ``document_age``: The time in hours elapsed since the - document was last updated, a floating-point number (e.g., - 0.25 means 15 minutes). - - ``topicality_rank``: topicality adjustment as a rank. Uses - proprietary Google model to determine the keyword-based - overlap between the query and the document. - - ``base_rank``: the default rank of the result + - ``semantic_similarity_score``: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. + - ``keyword_similarity_score``: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. + - ``relevance_score``: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. + - ``pctr_rank``: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. + - ``freshness_rank``: freshness adjustment as a rank + - ``document_age``: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). + - ``topicality_rank``: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. + - ``base_rank``: the default rank of the result ranking_expression_backend (google.cloud.discoveryengine_v1.types.SearchRequest.RankingExpressionBackend): The backend to use for the ranking expression evaluation. @@ -477,23 +465,28 @@ class DataStoreSpec(proto.Message): Attributes: data_store (str): Required. Full resource name of - [DataStore][google.cloud.discoveryengine.v1.DataStore], such - as + `DataStore + `__, + such as ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. filter (str): - Optional. Filter specification to filter documents in the - data store specified by data_store field. For more - information on filtering, see - `Filtering `__ + Optional. Filter specification to filter + documents in the data store specified by + data_store field. For more information on + filtering, see `Filtering + `__ boost_spec (google.cloud.discoveryengine_v1.types.SearchRequest.BoostSpec): - Optional. Boost specification to boost certain documents. - For more information on boosting, see - `Boosting `__ + Optional. Boost specification to boost certain + documents. For more information on boosting, see + `Boosting + `__ custom_search_operators (str): - Optional. Custom search operators which if specified will be - used to filter results from workspace data stores. For more - information on custom search operators, see - `SearchOperators `__. + Optional. Custom search operators which if + specified will be used to filter results from + workspace data stores. For more information on + custom search operators, see + `SearchOperators + `__. """ data_store: str = proto.Field( @@ -521,80 +514,91 @@ class FacetSpec(proto.Message): facet_key (google.cloud.discoveryengine_v1.types.SearchRequest.FacetSpec.FacetKey): Required. The facet key specification. limit (int): - Maximum facet values that are returned for this facet. If - unspecified, defaults to 20. The maximum allowed value is - 300. Values above 300 are coerced to 300. For aggregation in - healthcare search, when the [FacetKey.key] is - "healthcare_aggregation_key", the limit will be overridden - to 10,000 internally, regardless of the value set here. - - If this field is negative, an ``INVALID_ARGUMENT`` is - returned. + Maximum facet values that are returned for this + facet. If unspecified, defaults to 20. The + maximum allowed value is 300. Values above 300 + are coerced to 300. + For aggregation in healthcare search, when the + [FacetKey.key] is "healthcare_aggregation_key", + the limit will be overridden to 10,000 + internally, regardless of the value set here. + + If this field is negative, an + ``INVALID_ARGUMENT`` is returned. excluded_filter_keys (MutableSequence[str]): List of keys to exclude when faceting. By default, - [FacetKey.key][google.cloud.discoveryengine.v1.SearchRequest.FacetSpec.FacetKey.key] - is not excluded from the filter unless it is listed in this - field. - - Listing a facet key in this field allows its values to - appear as facet results, even when they are filtered out of - search results. Using this field does not affect what search - results are returned. - - For example, suppose there are 100 documents with the color - facet "Red" and 200 documents with the color facet "Blue". A - query containing the filter "color:ANY("Red")" and having - "color" as - [FacetKey.key][google.cloud.discoveryengine.v1.SearchRequest.FacetSpec.FacetKey.key] - would by default return only "Red" documents in the search - results, and also return "Red" with count 100 as the only - color facet. Although there are also blue documents - available, "Blue" would not be shown as an available facet - value. - - If "color" is listed in "excludedFilterKeys", then the query - returns the facet values "Red" with count 100 and "Blue" - with count 200, because the "color" key is now excluded from - the filter. Because this field doesn't affect search - results, the search results are still correctly filtered to - return only "Red" documents. - - A maximum of 100 values are allowed. Otherwise, an - ``INVALID_ARGUMENT`` error is returned. + `FacetKey.key + `__ + is not excluded from the filter unless it is + listed in this field. + + Listing a facet key in this field allows its + values to appear as facet results, even when + they are filtered out of search results. Using + this field does not affect what search results + are returned. + + For example, suppose there are 100 documents + with the color facet "Red" and 200 documents + with the color facet "Blue". A query containing + the filter "color:ANY("Red")" and having "color" + as `FacetKey.key + `__ + would by default return only "Red" documents in + the search results, and also return "Red" with + count 100 as the only color facet. Although + there are also blue documents available, "Blue" + would not be shown as an available facet value. + + If "color" is listed in "excludedFilterKeys", + then the query returns the facet values "Red" + with count 100 and "Blue" with count 200, + because the "color" key is now excluded from the + filter. Because this field doesn't affect search + results, the search results are still correctly + filtered to return only "Red" documents. + + A maximum of 100 values are allowed. Otherwise, + an ``INVALID_ARGUMENT`` error is returned. enable_dynamic_position (bool): - Enables dynamic position for this facet. If set to true, the - position of this facet among all facets in the response is - determined automatically. If dynamic facets are enabled, it - is ordered together. If set to false, the position of this - facet in the response is the same as in the request, and it - is ranked before the facets with dynamic position enable and - all dynamic facets. - - For example, you may always want to have rating facet - returned in the response, but it's not necessarily to always - display the rating facet at the top. In that case, you can - set enable_dynamic_position to true so that the position of - rating facet in response is determined automatically. - - Another example, assuming you have the following facets in - the request: - - - "rating", enable_dynamic_position = true - - - "price", enable_dynamic_position = false - - - "brands", enable_dynamic_position = false - - And also you have a dynamic facets enabled, which generates - a facet ``gender``. Then the final order of the facets in - the response can be ("price", "brands", "rating", "gender") - or ("price", "brands", "gender", "rating") depends on how - API orders "gender" and "rating" facets. However, notice - that "price" and "brands" are always ranked at first and - second position because their enable_dynamic_position is - false. + Enables dynamic position for this facet. If set + to true, the position of this facet among all + facets in the response is determined + automatically. If dynamic facets are enabled, it + is ordered together. If set to false, the + position of this facet in the response is the + same as in the request, and it is ranked before + the facets with dynamic position enable and all + dynamic facets. + + For example, you may always want to have rating + facet returned in the response, but it's not + necessarily to always display the rating facet + at the top. In that case, you can set + enable_dynamic_position to true so that the + position of rating facet in response is + determined automatically. + + Another example, assuming you have the following + facets in the request: + + * "rating", enable_dynamic_position = true + + * "price", enable_dynamic_position = false + + * "brands", enable_dynamic_position = false + + And also you have a dynamic facets enabled, + which generates a facet ``gender``. Then the + final order of the facets in the response can be + ("price", "brands", "rating", "gender") or + ("price", "brands", "gender", "rating") depends + on how API orders "gender" and "rating" facets. + However, notice that "price" and "brands" are + always ranked at first and second position + because their enable_dynamic_position is false. """ class FacetKey(proto.Message): @@ -602,21 +606,23 @@ class FacetKey(proto.Message): Attributes: key (str): - Required. Supported textual and numerical facet keys in - [Document][google.cloud.discoveryengine.v1.Document] object, - over which the facet values are computed. Facet key is - case-sensitive. + Required. Supported textual and numerical facet + keys in `Document + `__ + object, over which the facet values are + computed. Facet key is case-sensitive. intervals (MutableSequence[google.cloud.discoveryengine_v1.types.Interval]): Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30. restricted_values (MutableSequence[str]): - Only get facet for the given restricted values. Only - supported on textual fields. For example, suppose "category" - has three values "Action > 2022", "Action > 2021" and - "Sci-Fi > 2022". If set "restricted_values" to "Action > - 2022", the "category" facet only contains "Action > 2022". + Only get facet for the given restricted values. + Only supported on textual fields. For example, + suppose "category" has three values "Action > + 2022", "Action > 2021" and "Sci-Fi > 2022". If + set "restricted_values" to "Action > 2022", the + "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10. prefixes (MutableSequence[str]): Only get facet values that start with the @@ -644,18 +650,24 @@ class FacetKey(proto.Message): Allowed values are: - - "count desc", which means order by - [SearchResponse.Facet.values.count][google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValue.count] - descending. - - - "value desc", which means order by - [SearchResponse.Facet.values.value][google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValue.value] - descending. Only applies to textual facets. - - If not set, textual values are sorted in `natural - order `__; - numerical intervals are sorted in the order given by - [FacetSpec.FacetKey.intervals][google.cloud.discoveryengine.v1.SearchRequest.FacetSpec.FacetKey.intervals]. + * "count desc", which means order by + `SearchResponse.Facet.values.count + `__ + descending. + + * "value desc", which means order by + `SearchResponse.Facet.values.value + `__ + descending. + Only applies to textual facets. + + If not set, textual values are sorted in + `natural order + `__; + numerical intervals are sorted in the order + given by + `FacetSpec.FacetKey.intervals + `__. """ key: str = proto.Field( @@ -724,39 +736,46 @@ class ConditionBoostSpec(proto.Message): Attributes: condition (str): - An expression which specifies a boost condition. The syntax - and supported fields are the same as a filter expression. - See - [SearchRequest.filter][google.cloud.discoveryengine.v1.SearchRequest.filter] + An expression which specifies a boost condition. + The syntax and supported fields are the same as + a filter expression. See `SearchRequest.filter + `__ for detail syntax and limitations. Examples: - - To boost documents with document ID "doc_1" or "doc_2", - and color "Red" or "Blue": - ``(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`` + * To boost documents with document ID "doc_1" or + "doc_2", and color "Red" or "Blue": + + ``(document_id: ANY("doc_1", "doc_2")) AND + (color: ANY("Red", "Blue"))`` boost (float): - Strength of the condition boost, which should be in [-1, 1]. - Negative boost means demotion. Default is 0.0. - - Setting to 1.0 gives the document a big promotion. However, - it does not necessarily mean that the boosted document will - be the top result at all times, nor that other documents - will be excluded. Results could still be shown even when - none of them matches the condition. And results that are - significantly more relevant to the search query can still - trump your heavily favored but irrelevant documents. - - Setting to -1.0 gives the document a big demotion. However, - results that are deeply relevant might still be shown. The - document will have an upstream battle to get a fairly high + Strength of the condition boost, which should be + in [-1, 1]. Negative boost means demotion. + Default is 0.0. + + Setting to 1.0 gives the document a big + promotion. However, it does not necessarily mean + that the boosted document will be the top result + at all times, nor that other documents will be + excluded. Results could still be shown even when + none of them matches the condition. And results + that are significantly more relevant to the + search query can still trump your heavily + favored but irrelevant documents. + + Setting to -1.0 gives the document a big + demotion. However, results that are deeply + relevant might still be shown. The document will + have an upstream battle to get a fairly high ranking, but it is not blocked out completely. - Setting to 0.0 means no boost applied. The boosting - condition is ignored. Only one of the (condition, boost) - combination or the boost_control_spec below are set. If both - are set then the global boost is ignored and the more - fine-grained boost_control_spec is applied. + Setting to 0.0 means no boost applied. The + boosting condition is ignored. Only one of the + (condition, boost) combination or the + boost_control_spec below are set. If both are + set then the global boost is ignored and the + more fine-grained boost_control_spec is applied. boost_control_spec (google.cloud.discoveryengine_v1.types.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec): Complex specification for custom ranking based on customer defined attribute value. @@ -772,19 +791,22 @@ class BoostControlSpec(proto.Message): The name of the field whose value will be used to determine the boost amount. attribute_type (google.cloud.discoveryengine_v1.types.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType): - The attribute type to be used to determine the boost amount. - The attribute value can be derived from the field value of - the specified field_name. In the case of numerical it is + The attribute type to be used to determine the + boost amount. The attribute value can be derived + from the field value of the specified + field_name. In the case of numerical it is straightforward i.e. attribute_value = - numerical_field_value. In the case of freshness however, - attribute_value = (time.now() - datetime_field_value). + numerical_field_value. In the case of freshness + however, attribute_value = (time.now() - + datetime_field_value). interpolation_type (google.cloud.discoveryengine_v1.types.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType): The interpolation type to be applied to connect the control points listed below. control_points (MutableSequence[google.cloud.discoveryengine_v1.types.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint]): - The control points used to define the curve. The monotonic - function (defined through the interpolation_type above) - passes through the control points listed here. + The control points used to define the curve. The + monotonic function (defined through the + interpolation_type above) passes through the + control points listed here. """ class AttributeType(proto.Enum): @@ -795,19 +817,21 @@ class AttributeType(proto.Enum): ATTRIBUTE_TYPE_UNSPECIFIED (0): Unspecified AttributeType. NUMERICAL (1): - The value of the numerical field will be used to dynamically - update the boost amount. In this case, the attribute_value - (the x value) of the control point will be the actual value - of the numerical field for which the boost_amount is + The value of the numerical field will be used to + dynamically update the boost amount. In this + case, the attribute_value (the x value) of the + control point will be the actual value of the + numerical field for which the boost_amount is specified. FRESHNESS (2): - For the freshness use case the attribute value will be the - duration between the current time and the date in the - datetime field specified. The value must be formatted as an - XSD ``dayTimeDuration`` value (a restricted subset of an ISO - 8601 duration value). The pattern for this is: - ``[nD][T[nH][nM][nS]]``. For example, ``5D``, ``3DT12H30M``, - ``T24H``. + For the freshness use case the attribute value + will be the duration between the current time + and the date in the datetime field specified. + The value must be formatted as an XSD + ``dayTimeDuration`` value (a restricted subset + of an ISO 8601 duration value). The pattern for + this is: ```nD `__`nM `__]``. For + example, ``5D``, ``3DT12H30M``, ``T24H``. """ ATTRIBUTE_TYPE_UNSPECIFIED = 0 NUMERICAL = 1 @@ -838,13 +862,16 @@ class ControlPoint(proto.Message): Can be one of: 1. The numerical field value. - 2. The duration spec for freshness: The value must be - formatted as an XSD ``dayTimeDuration`` value (a - restricted subset of an ISO 8601 duration value). The - pattern for this is: ``[nD][T[nH][nM][nS]]``. + 2. The duration spec for freshness: + + The value must be formatted as an XSD + ``dayTimeDuration`` value (a restricted subset + of an ISO 8601 duration value). The pattern for + this is: ```nD `__`nM `__]``. boost_amount (float): - The value between -1 to 1 by which to boost the score if the - attribute_value evaluates to the value specified above. + The value between -1 to 1 by which to boost the + score if the attribute_value evaluates to the + value specified above. """ attribute_value: str = proto.Field( @@ -906,9 +933,9 @@ class QueryExpansionSpec(proto.Message): Attributes: condition (google.cloud.discoveryengine_v1.types.SearchRequest.QueryExpansionSpec.Condition): - The condition under which query expansion should occur. - Default to - [Condition.DISABLED][google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec.Condition.DISABLED]. + The condition under which query expansion should + occur. Default to `Condition.DISABLED + `__. pin_unexpanded_results (bool): Whether to pin unexpanded results. If this field is set to true, unexpanded products are @@ -922,13 +949,15 @@ class Condition(proto.Enum): Values: CONDITION_UNSPECIFIED (0): - Unspecified query expansion condition. In this case, server - behavior defaults to - [Condition.DISABLED][google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec.Condition.DISABLED]. + Unspecified query expansion condition. In this + case, server behavior defaults to + `Condition.DISABLED + `__. DISABLED (1): - Disabled query expansion. Only the exact search query is - used, even if - [SearchResponse.total_size][google.cloud.discoveryengine.v1.SearchResponse.total_size] + Disabled query expansion. Only the exact search + query is used, even if + `SearchResponse.total_size + `__ is zero. AUTO (2): Automatic query expansion built by the Search @@ -953,9 +982,10 @@ class SpellCorrectionSpec(proto.Message): Attributes: mode (google.cloud.discoveryengine_v1.types.SearchRequest.SpellCorrectionSpec.Mode): - The mode under which spell correction replaces the original - search query. Defaults to - [Mode.AUTO][google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec.Mode.AUTO]. + The mode under which spell correction + replaces the original search query. Defaults to + `Mode.AUTO + `__. """ class Mode(proto.Enum): @@ -964,14 +994,17 @@ class Mode(proto.Enum): Values: MODE_UNSPECIFIED (0): - Unspecified spell correction mode. In this case, server - behavior defaults to - [Mode.AUTO][google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec.Mode.AUTO]. + Unspecified spell correction mode. In this case, + server behavior defaults to + `Mode.AUTO + `__. SUGGESTION_ONLY (1): - Search API tries to find a spelling suggestion. If a - suggestion is found, it is put in the - [SearchResponse.corrected_query][google.cloud.discoveryengine.v1.SearchResponse.corrected_query]. - The spelling suggestion won't be used as the search query. + Search API tries to find a spelling suggestion. + If a suggestion is found, it is put in the + `SearchResponse.corrected_query + `__. + The spelling suggestion won't be used as the + search query. AUTO (2): Automatic spell correction built by the Search API. Search will be based on the @@ -993,28 +1026,32 @@ class ContentSearchSpec(proto.Message): Attributes: snippet_spec (google.cloud.discoveryengine_v1.types.SearchRequest.ContentSearchSpec.SnippetSpec): - If ``snippetSpec`` is not specified, snippets are not - included in the search response. + If ``snippetSpec`` is not specified, snippets + are not included in the search response. summary_spec (google.cloud.discoveryengine_v1.types.SearchRequest.ContentSearchSpec.SummarySpec): - If ``summarySpec`` is not specified, summaries are not - included in the search response. + If ``summarySpec`` is not specified, summaries + are not included in the search response. extractive_content_spec (google.cloud.discoveryengine_v1.types.SearchRequest.ContentSearchSpec.ExtractiveContentSpec): - If there is no extractive_content_spec provided, there will - be no extractive answer in the search response. + If there is no extractive_content_spec provided, + there will be no extractive answer in the search + response. search_result_mode (google.cloud.discoveryengine_v1.types.SearchRequest.ContentSearchSpec.SearchResultMode): - Specifies the search result mode. If unspecified, the search - result mode defaults to ``DOCUMENTS``. + Specifies the search result mode. If + unspecified, the search result mode defaults to + ``DOCUMENTS``. chunk_spec (google.cloud.discoveryengine_v1.types.SearchRequest.ContentSearchSpec.ChunkSpec): - Specifies the chunk spec to be returned from the search - response. Only available if the - [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.search_result_mode] + Specifies the chunk spec to be returned from the + search response. Only available if the + `SearchRequest.ContentSearchSpec.search_result_mode + `__ is set to - [CHUNKS][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS] + `CHUNKS + `__ """ class SearchResultMode(proto.Enum): - r"""Specifies the search result mode. If unspecified, the search result - mode defaults to ``DOCUMENTS``. + r"""Specifies the search result mode. If unspecified, the + search result mode defaults to ``DOCUMENTS``. Values: SEARCH_RESULT_MODE_UNSPECIFIED (0): @@ -1022,8 +1059,10 @@ class SearchResultMode(proto.Enum): DOCUMENTS (1): Returns documents in the search result. CHUNKS (2): - Returns chunks in the search result. Only available if the - [DocumentProcessingConfig.chunking_config][google.cloud.discoveryengine.v1.DocumentProcessingConfig.chunking_config] + Returns chunks in the search result. Only + available if the + `DocumentProcessingConfig.chunking_config + `__ is specified. """ SEARCH_RESULT_MODE_UNSPECIFIED = 0 @@ -1036,18 +1075,19 @@ class SnippetSpec(proto.Message): Attributes: max_snippet_count (int): - [DEPRECATED] This field is deprecated. To control snippet - return, use ``return_snippet`` field. For backwards - compatibility, we will return snippet if max_snippet_count > - 0. + [DEPRECATED] This field is deprecated. To + control snippet return, use ``return_snippet`` + field. For backwards compatibility, we will + return snippet if max_snippet_count > 0. reference_only (bool): - [DEPRECATED] This field is deprecated and will have no - affect on the snippet. + [DEPRECATED] This field is deprecated and will + have no affect on the snippet. return_snippet (bool): - If ``true``, then return snippet. If no snippet can be - generated, we return "No snippet is available for this - page." A ``snippet_status`` with ``SUCCESS`` or - ``NO_SNIPPET_AVAILABLE`` will also be returned. + If ``true``, then return snippet. If no snippet + can be generated, we return "No snippet is + available for this page." A ``snippet_status`` + with ``SUCCESS`` or ``NO_SNIPPET_AVAILABLE`` + will also be returned. """ max_snippet_count: int = proto.Field( @@ -1069,90 +1109,105 @@ class SummarySpec(proto.Message): Attributes: summary_result_count (int): - The number of top results to generate the summary from. If - the number of results returned is less than - ``summaryResultCount``, the summary is generated from all of - the results. - - At most 10 results for documents mode, or 50 for chunks - mode, can be used to generate a summary. The chunks mode is - used when - [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.search_result_mode] + The number of top results to generate the + summary from. If the number of results returned + is less than ``summaryResultCount``, the summary + is generated from all of the results. + + At most 10 results for documents mode, or 50 for + chunks mode, can be used to generate a summary. + The chunks mode is used when + `SearchRequest.ContentSearchSpec.search_result_mode + `__ is set to - [CHUNKS][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]. + `CHUNKS + `__. include_citations (bool): - Specifies whether to include citations in the summary. The - default value is ``false``. + Specifies whether to include citations in the + summary. The default value is ``false``. - When this field is set to ``true``, summaries include - in-line citation numbers. + When this field is set to ``true``, summaries + include in-line citation numbers. Example summary including citations: - BigQuery is Google Cloud's fully managed and completely - serverless enterprise data warehouse [1]. BigQuery supports - all data types, works across clouds, and has built-in - machine learning and business intelligence, all within a - unified platform [2, 3]. - - The citation numbers refer to the returned search results - and are 1-indexed. For example, [1] means that the sentence - is attributed to the first search result. [2, 3] means that - the sentence is attributed to both the second and third - search results. + BigQuery is Google Cloud's fully managed and + completely serverless enterprise data warehouse + [1]. BigQuery supports all data types, works + across clouds, and has built-in machine learning + and business intelligence, all within a unified + platform [2, 3]. + + The citation numbers refer to the returned + search results and are 1-indexed. For example, + [1] means that the sentence is attributed to the + first search result. [2, 3] means that the + sentence is attributed to both the second and + third search results. ignore_adversarial_query (bool): - Specifies whether to filter out adversarial queries. The - default value is ``false``. + Specifies whether to filter out adversarial + queries. The default value is ``false``. - Google employs search-query classification to detect - adversarial queries. No summary is returned if the search - query is classified as an adversarial query. For example, a - user might ask a question regarding negative comments about - the company or submit a query designed to generate unsafe, - policy-violating output. If this field is set to ``true``, - we skip generating summaries for adversarial queries and - return fallback messages instead. + Google employs search-query classification to + detect adversarial queries. No summary is + returned if the search query is classified as an + adversarial query. For example, a user might ask + a question regarding negative comments about the + company or submit a query designed to generate + unsafe, policy-violating output. If this field + is set to ``true``, we skip generating summaries + for adversarial queries and return fallback + messages instead. ignore_non_summary_seeking_query (bool): - Specifies whether to filter out queries that are not - summary-seeking. The default value is ``false``. - - Google employs search-query classification to detect - summary-seeking queries. No summary is returned if the - search query is classified as a non-summary seeking query. - For example, ``why is the sky blue`` and - ``Who is the best soccer player in the world?`` are - summary-seeking queries, but ``SFO airport`` and - ``world cup 2026`` are not. They are most likely - navigational queries. If this field is set to ``true``, we - skip generating summaries for non-summary seeking queries - and return fallback messages instead. + Specifies whether to filter out queries that are + not summary-seeking. The default value is + ``false``. + + Google employs search-query classification to + detect summary-seeking queries. No summary is + returned if the search query is classified as a + non-summary seeking query. For example, ``why is + the sky blue`` and ``Who is the best soccer + player in the world?`` are summary-seeking + queries, but ``SFO airport`` and ``world cup + 2026`` are not. They are most likely + navigational queries. If this field is set to + ``true``, we skip generating summaries for + non-summary seeking queries and return fallback + messages instead. ignore_low_relevant_content (bool): - Specifies whether to filter out queries that have low - relevance. The default value is ``false``. - - If this field is set to ``false``, all search results are - used regardless of relevance to generate answers. If set to - ``true``, only queries with high relevance search results - will generate answers. + Specifies whether to filter out queries that + have low relevance. The default value is + ``false``. + + If this field is set to ``false``, all search + results are used regardless of relevance to + generate answers. If set to ``true``, only + queries with high relevance search results will + generate answers. ignore_jail_breaking_query (bool): - Optional. Specifies whether to filter out jail-breaking - queries. The default value is ``false``. - - Google employs search-query classification to detect - jail-breaking queries. No summary is returned if the search - query is classified as a jail-breaking query. A user might - add instructions to the query to change the tone, style, - language, content of the answer, or ask the model to act as - a different entity, e.g. "Reply in the tone of a competing - company's CEO". If this field is set to ``true``, we skip - generating summaries for jail-breaking queries and return - fallback messages instead. + Optional. Specifies whether to filter out + jail-breaking queries. The default value is + ``false``. + + Google employs search-query classification to + detect jail-breaking queries. No summary is + returned if the search query is classified as a + jail-breaking query. A user might add + instructions to the query to change the tone, + style, language, content of the answer, or ask + the model to act as a different entity, e.g. + "Reply in the tone of a competing company's + CEO". If this field is set to ``true``, we skip + generating summaries for jail-breaking queries + and return fallback messages instead. model_prompt_spec (google.cloud.discoveryengine_v1.types.SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec): If specified, the spec will be used to modify the prompt provided to the LLM. language_code (str): - Language code for Summary. Use language tags defined by - `BCP47 `__. + Language code for Summary. Use language tags + defined by `BCP47 + `__. Note: This is an experimental feature. model_spec (google.cloud.discoveryengine_v1.types.SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec): If specified, the spec will be used to modify @@ -1192,15 +1247,19 @@ class ModelSpec(proto.Message): Supported values are: - - ``stable``: string. Default value when no value is - specified. Uses a generally available, fine-tuned model. - For more information, see `Answer generation model - versions and - lifecycle `__. - - ``preview``: string. (Public preview) Uses a preview - model. For more information, see `Answer generation model - versions and - lifecycle `__. + * ``stable``: string. Default value when no + value is specified. Uses a generally + available, fine-tuned model. For more + information, see `Answer generation model + versions and + lifecycle + `__. + + * ``preview``: string. (Public preview) Uses a + preview model. For more information, see + `Answer generation model versions and + lifecycle + `__. """ version: str = proto.Field( @@ -1259,53 +1318,63 @@ class ExtractiveContentSpec(proto.Message): Attributes: max_extractive_answer_count (int): - The maximum number of extractive answers returned in each - search result. + The maximum number of extractive answers + returned in each search result. - An extractive answer is a verbatim answer extracted from the - original document, which provides a precise and contextually - relevant answer to the search query. + An extractive answer is a verbatim answer + extracted from the original document, which + provides a precise and contextually relevant + answer to the search query. - If the number of matching answers is less than the - ``max_extractive_answer_count``, return all of the answers. - Otherwise, return the ``max_extractive_answer_count``. + If the number of matching answers is less than + the ``max_extractive_answer_count``, return all + of the answers. Otherwise, return the + ``max_extractive_answer_count``. At most five answers are returned for each - [SearchResult][google.cloud.discoveryengine.v1.SearchResponse.SearchResult]. + `SearchResult + `__. max_extractive_segment_count (int): - The max number of extractive segments returned in each - search result. Only applied if the - [DataStore][google.cloud.discoveryengine.v1.DataStore] is - set to - [DataStore.ContentConfig.CONTENT_REQUIRED][google.cloud.discoveryengine.v1.DataStore.ContentConfig.CONTENT_REQUIRED] + The max number of extractive segments returned + in each search result. Only applied if the + `DataStore + `__ + is set to + `DataStore.ContentConfig.CONTENT_REQUIRED + `__ or - [DataStore.solution_types][google.cloud.discoveryengine.v1.DataStore.solution_types] + `DataStore.solution_types + `__ is - [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_CHAT]. + `SOLUTION_TYPE_CHAT + `__. - An extractive segment is a text segment extracted from the - original document that is relevant to the search query, and, - in general, more verbose than an extractive answer. The - segment could then be used as input for LLMs to generate - summaries and answers. + An extractive segment is a text segment + extracted from the original document that is + relevant to the search query, and, in general, + more verbose than an extractive answer. The + segment could then be used as input for LLMs to + generate summaries and answers. If the number of matching segments is less than - ``max_extractive_segment_count``, return all of the - segments. Otherwise, return the + ``max_extractive_segment_count``, return all of + the segments. Otherwise, return the ``max_extractive_segment_count``. return_extractive_segment_score (bool): - Specifies whether to return the confidence score from the - extractive segments in each search result. This feature is - available only for new or allowlisted data stores. To - allowlist your data store, contact your Customer Engineer. - The default value is ``false``. + Specifies whether to return the confidence score + from the extractive segments in each search + result. This feature is available only for new + or allowlisted data stores. To allowlist your + data store, contact your Customer Engineer. The + default value is ``false``. num_previous_segments (int): - Specifies whether to also include the adjacent from each - selected segments. Return at most ``num_previous_segments`` + Specifies whether to also include the adjacent + from each selected segments. + Return at most ``num_previous_segments`` segments before each selected segments. num_next_segments (int): - Return at most ``num_next_segments`` segments after each - selected segments. + Return at most ``num_next_segments`` segments + after each selected segments. """ max_extractive_answer_count: int = proto.Field( @@ -1330,11 +1399,13 @@ class ExtractiveContentSpec(proto.Message): ) class ChunkSpec(proto.Message): - r"""Specifies the chunk spec to be returned from the search response. - Only available if the - [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.search_result_mode] + r"""Specifies the chunk spec to be returned from the search + response. Only available if the + `SearchRequest.ContentSearchSpec.search_result_mode + `__ is set to - [CHUNKS][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS] + `CHUNKS + `__ Attributes: num_previous_chunks (int): @@ -1391,9 +1462,10 @@ class SearchAsYouTypeSpec(proto.Message): Attributes: condition (google.cloud.discoveryengine_v1.types.SearchRequest.SearchAsYouTypeSpec.Condition): - The condition under which search as you type should occur. - Default to - [Condition.DISABLED][google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Condition.DISABLED]. + The condition under which search as you type + should occur. Default to + `Condition.DISABLED + `__. """ class Condition(proto.Enum): @@ -1403,7 +1475,8 @@ class Condition(proto.Enum): Values: CONDITION_UNSPECIFIED (0): Server behavior defaults to - [Condition.DISABLED][google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Condition.DISABLED]. + `Condition.DISABLED + `__. DISABLED (1): Disables Search As You Type. ENABLED (2): @@ -1470,38 +1543,48 @@ class SessionSpec(proto.Message): Attributes: query_id (str): - If set, the search result gets stored to the "turn" - specified by this query ID. + If set, the search result gets stored to the + "turn" specified by this query ID. - Example: Let's say the session looks like this: session { - name: ".../sessions/xxx" turns { query { text: "What is - foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } - turns { query { text: "How about bar then?" query_id: - ".../questions/zzz" } } } + Example: Let's say the session looks like this: - The user can call /search API with a request like this: + session { + name: ".../sessions/xxx" + turns { + query { text: "What is foo?" query_id: + ".../questions/yyy" } answer: "Foo is ..." + } + turns { + query { text: "How about bar then?" + query_id: ".../questions/zzz" } } + } - :: + The user can call /search API with a request + like this: session: ".../sessions/xxx" - session_spec { query_id: ".../questions/zzz" } - - Then, the API stores the search result, associated with the - last turn. The stored search result can be used by a - subsequent /answer API call (with the session ID and the - query ID specified). Also, it is possible to call /search - and /answer in parallel with the same session ID & query ID. + session_spec { query_id: ".../questions/zzz" + } + + Then, the API stores the search result, + associated with the last turn. The stored search + result can be used by a subsequent /answer API + call (with the session ID and the query ID + specified). Also, it is possible to call /search + and /answer in parallel with the same session ID + & query ID. search_result_persistence_count (int): - The number of top search results to persist. The persisted - search results can be used for the subsequent /answer api - call. + The number of top search results to persist. The + persisted search results can be used for the + subsequent /answer api call. - This field is similar to the ``summary_result_count`` field - in - [SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count]. + This field is similar to the + ``summary_result_count`` field in + `SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count + `__. - At most 10 results for documents mode, or 50 for chunks - mode. + At most 10 results for documents mode, or 50 for + chunks mode. This field is a member of `oneof`_ ``_search_result_persistence_count``. """ @@ -1676,7 +1759,8 @@ class RelevanceScoreSpec(proto.Message): class SearchResponse(proto.Message): r"""Response message for - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] + `SearchService.Search + `__ method. Attributes: @@ -1686,39 +1770,47 @@ class SearchResponse(proto.Message): facets (MutableSequence[google.cloud.discoveryengine_v1.types.SearchResponse.Facet]): Results of facets requested by user. total_size (int): - The estimated total count of matched items irrespective of - pagination. The count of - [results][google.cloud.discoveryengine.v1.SearchResponse.results] + The estimated total count of matched items + irrespective of pagination. The count of + `results + `__ returned by pagination may be less than the - [total_size][google.cloud.discoveryengine.v1.SearchResponse.total_size] + `total_size + `__ that matches. attribution_token (str): - A unique search token. This should be included in the - [UserEvent][google.cloud.discoveryengine.v1.UserEvent] logs - resulting from this search, which enables accurate - attribution of search model performance. This also helps to - identify a request during the customer support scenarios. + A unique search token. This should be included + in the `UserEvent + `__ + logs resulting from this search, which enables + accurate attribution of search model + performance. This also helps to identify a + request during the customer support scenarios. redirect_uri (str): - The URI of a customer-defined redirect page. If redirect - action is triggered, no search is performed, and only - [redirect_uri][google.cloud.discoveryengine.v1.SearchResponse.redirect_uri] + The URI of a customer-defined redirect page. If + redirect action is triggered, no search is + performed, and only `redirect_uri + `__ and - [attribution_token][google.cloud.discoveryengine.v1.SearchResponse.attribution_token] + `attribution_token + `__ are set in the response. next_page_token (str): A token that can be sent as - [SearchRequest.page_token][google.cloud.discoveryengine.v1.SearchRequest.page_token] - to retrieve the next page. If this field is omitted, there - are no subsequent pages. + `SearchRequest.page_token + `__ + to retrieve the next page. If this field is + omitted, there are no subsequent pages. corrected_query (str): - Contains the spell corrected query, if found. If the spell - correction type is AUTOMATIC, then the search results are - based on corrected_query. Otherwise the original query is - used for search. + Contains the spell corrected query, if found. If + the spell correction type is AUTOMATIC, then the + search results are based on corrected_query. + Otherwise the original query is used for search. summary (google.cloud.discoveryengine_v1.types.SearchResponse.Summary): - A summary as part of the search results. This field is only - returned if - [SearchRequest.ContentSearchSpec.summary_spec][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.summary_spec] + A summary as part of the search results. + This field is only returned if + `SearchRequest.ContentSearchSpec.summary_spec + `__ is set. query_expansion_info (google.cloud.discoveryengine_v1.types.SearchResponse.QueryExpansionInfo): Query expansion information for the returned @@ -1727,8 +1819,10 @@ class SearchResponse(proto.Message): Session information. Only set if - [SearchRequest.session][google.cloud.discoveryengine.v1.SearchRequest.session] - is provided. See its description for more details. + `SearchRequest.session + `__ + is provided. See its description for more + details. search_link_promotions (MutableSequence[google.cloud.discoveryengine_v1.types.SearchLinkPromotion]): Promotions for site search. """ @@ -1738,17 +1832,21 @@ class SearchResult(proto.Message): Attributes: id (str): - [Document.id][google.cloud.discoveryengine.v1.Document.id] - of the searched - [Document][google.cloud.discoveryengine.v1.Document]. + `Document.id + `__ + of the searched `Document + `__. document (google.cloud.discoveryengine_v1.types.Document): - The document data snippet in the search response. Only - fields that are marked as ``retrievable`` are populated. + The document data snippet in the search + response. Only fields that are marked as + ``retrievable`` are populated. chunk (google.cloud.discoveryengine_v1.types.Chunk): The chunk data in the search response if the - [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.search_result_mode] + `SearchRequest.ContentSearchSpec.search_result_mode + `__ is set to - [CHUNKS][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]. + `CHUNKS + `__. model_scores (MutableMapping[str, google.cloud.discoveryengine_v1.types.DoubleList]): Output only. Google provided available scores. @@ -1896,9 +1994,10 @@ class Facet(proto.Message): Attributes: key (str): - The key for this facet. For example, ``"colors"`` or - ``"price"``. It matches - [SearchRequest.FacetSpec.FacetKey.key][google.cloud.discoveryengine.v1.SearchRequest.FacetSpec.FacetKey.key]. + The key for this facet. For example, + ``"colors"`` or ``"price"``. It matches + `SearchRequest.FacetSpec.FacetKey.key + `__. values (MutableSequence[google.cloud.discoveryengine_v1.types.SearchResponse.Facet.FacetValue]): The facet values for this field. dynamic_facet (bool): @@ -1922,9 +2021,10 @@ class FacetValue(proto.Message): This field is a member of `oneof`_ ``facet_value``. interval (google.cloud.discoveryengine_v1.types.Interval): - Interval value for a facet, such as [10, 20) for facet - "price". It matches - [SearchRequest.FacetSpec.FacetKey.intervals][google.cloud.discoveryengine.v1.SearchRequest.FacetSpec.FacetKey.intervals]. + Interval value for a facet, such as `10, 20) for + facet "price". It matches + [SearchRequest.FacetSpec.FacetKey.intervals + `__. This field is a member of `oneof`_ ``facet_value``. count (int): @@ -1992,14 +2092,16 @@ class SummarySkippedReason(proto.Enum): The adversarial query ignored case. Only used when - [SummarySpec.ignore_adversarial_query][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec.ignore_adversarial_query] + `SummarySpec.ignore_adversarial_query + `__ is set to ``true``. NON_SUMMARY_SEEKING_QUERY_IGNORED (2): The non-summary seeking query ignored case. - Google skips the summary if the query is chit chat. Only - used when - [SummarySpec.ignore_non_summary_seeking_query][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_summary_seeking_query] + Google skips the summary if the query is chit + chat. Only used when + `SummarySpec.ignore_non_summary_seeking_query + `__ is set to ``true``. OUT_OF_DOMAIN_QUERY_IGNORED (3): The out-of-domain query ignored case. @@ -2028,8 +2130,8 @@ class SummarySkippedReason(proto.Enum): JAIL_BREAKING_QUERY_IGNORED (7): The jail-breaking query ignored case. - For example, "Reply in the tone of a competing company's - CEO". Only used when + For example, "Reply in the tone of a competing + company's CEO". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to ``true``. CUSTOMER_POLICY_VIOLATION (8): @@ -2041,8 +2143,8 @@ class SummarySkippedReason(proto.Enum): NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 (9): The non-answer seeking query ignored case. - Google skips the summary if the query doesn't have clear - intent. Only used when + Google skips the summary if the query doesn't + have clear intent. Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] is set to ``true``. TIME_OUT (10): @@ -2137,9 +2239,9 @@ class CitationSource(proto.Message): Attributes: reference_index (int): Document reference index from - SummaryWithMetadata.references. It is 0-indexed and the - value will be zero if the reference_index is not set - explicitly. + SummaryWithMetadata.references. It is 0-indexed + and the value will be zero if the + reference_index is not set explicitly. """ reference_index: int = proto.Field( @@ -2155,9 +2257,10 @@ class Reference(proto.Message): Title of the document. document (str): Required. - [Document.name][google.cloud.discoveryengine.v1.Document.name] - of the document. Full resource name of the referenced - document, in the format + `Document.name + `__ + of the document. Full resource name of the + referenced document, in the format ``projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*``. uri (str): Cloud Storage or HTTP uri for the document. @@ -2267,9 +2370,10 @@ class QueryExpansionInfo(proto.Message): Bool describing whether query expansion has occurred. pinned_result_count (int): - Number of pinned results. This field will only be set when - expansion happens and - [SearchRequest.QueryExpansionSpec.pin_unexpanded_results][google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec.pin_unexpanded_results] + Number of pinned results. This field will only + be set when expansion happens and + `SearchRequest.QueryExpansionSpec.pin_unexpanded_results + `__ is set to true. """ @@ -2287,10 +2391,12 @@ class SessionInfo(proto.Message): Attributes: name (str): - Name of the session. If the auto-session mode is used (when - [SearchRequest.session][google.cloud.discoveryengine.v1.SearchRequest.session] - ends with "-"), this field holds the newly generated session - name. + Name of the session. + If the auto-session mode is used (when + `SearchRequest.session + `__ + ends with "-"), this field holds the newly + generated session name. query_id (str): Query ID that corresponds to this search API call. One session can have multiple turns, each diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/search_tuning_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/search_tuning_service.py index c054af1613aa..055ca583be5d 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/search_tuning_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/search_tuning_service.py @@ -37,16 +37,17 @@ class ListCustomModelsRequest(proto.Message): r"""Request message for - [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1.SearchTuningService.ListCustomModels] + `SearchTuningService.ListCustomModels + `__ method. Attributes: data_store (str): - Required. The resource name of the parent Data Store, such - as + Required. The resource name of the parent Data + Store, such as ``projects/*/locations/global/collections/default_collection/dataStores/default_data_store``. - This field is used to identify the data store where to fetch - the models from. + This field is used to identify the data store + where to fetch the models from. """ data_store: str = proto.Field( @@ -57,7 +58,8 @@ class ListCustomModelsRequest(proto.Message): class ListCustomModelsResponse(proto.Message): r"""Response message for - [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1.SearchTuningService.ListCustomModels] + `SearchTuningService.ListCustomModels + `__ method. Attributes: @@ -76,7 +78,8 @@ class ListCustomModelsResponse(proto.Message): class TrainCustomModelRequest(proto.Message): r"""Request message for - [SearchTuningService.TrainCustomModel][google.cloud.discoveryengine.v1.SearchTuningService.TrainCustomModel] + `SearchTuningService.TrainCustomModel + `__ method. @@ -88,15 +91,16 @@ class TrainCustomModelRequest(proto.Message): This field is a member of `oneof`_ ``training_input``. data_store (str): - Required. The resource name of the Data Store, such as + Required. The resource name of the Data Store, + such as ``projects/*/locations/global/collections/default_collection/dataStores/default_data_store``. - This field is used to identify the data store where to train - the models. + This field is used to identify the data store + where to train the models. model_type (str): Model to be trained. Supported values are: - - **search-tuning**: Fine tuning the search system based on - data provided. + * **search-tuning**: Fine tuning the search + system based on data provided. error_config (google.cloud.discoveryengine_v1.types.ImportErrorConfig): The desired location of errors incurred during the data ingestion and training. @@ -109,39 +113,45 @@ class GcsTrainingInput(proto.Message): Attributes: corpus_data_path (str): - The Cloud Storage corpus data which could be associated in - train data. The data path format is - ``gs:///``. A newline - delimited jsonl/ndjson file. + The Cloud Storage corpus data which could be + associated in train data. The data path format + is ``gs:///``. + A newline delimited jsonl/ndjson file. + + For search-tuning model, each line should have + the _id, title and text. Example: - For search-tuning model, each line should have the \_id, - title and text. Example: - ``{"_id": "doc1", title: "relevant doc", "text": "relevant text"}`` + ``{"_id": "doc1", title: "relevant doc", "text": + "relevant text"}`` query_data_path (str): - The gcs query data which could be associated in train data. - The data path format is - ``gs:///``. A newline - delimited jsonl/ndjson file. + The gcs query data which could be associated in + train data. The data path format is + ``gs:///``. A + newline delimited jsonl/ndjson file. - For search-tuning model, each line should have the \_id and - text. Example: {"\_id": "query1", "text": "example query"} + For search-tuning model, each line should have + the _id and text. Example: {"_id": "query1", + "text": "example query"} train_data_path (str): - Cloud Storage training data path whose format should be - ``gs:///``. The file should - be in tsv format. Each line should have the doc_id and - query_id and score (number). - - For search-tuning model, it should have the query-id - corpus-id score as tsv file header. The score should be a - number in ``[0, inf+)``. The larger the number is, the more - relevant the pair is. Example: - - - ``query-id\tcorpus-id\tscore`` - - ``query1\tdoc1\t1`` + Cloud Storage training data path whose format + should be + ``gs:///``. The + file should be in tsv format. Each line should + have the doc_id and query_id and score (number). + + For search-tuning model, it should have the + query-id corpus-id score as tsv file header. The + score should be a number in ``[0, inf+)``. The + larger the number is, the more relevant the pair + is. Example: + + * ``query-id\tcorpus-id\tscore`` + * ``query1\tdoc1\t1`` test_data_path (str): - Cloud Storage test data. Same format as train_data_path. If - not provided, a random 80/20 train/test split will be - performed on train_data_path. + Cloud Storage test data. Same format as + train_data_path. If not provided, a random 80/20 + train/test split will be performed on + train_data_path. """ corpus_data_path: str = proto.Field( @@ -188,7 +198,8 @@ class GcsTrainingInput(proto.Message): class TrainCustomModelResponse(proto.Message): r"""Response of the - [TrainCustomModelRequest][google.cloud.discoveryengine.v1.TrainCustomModelRequest]. + `TrainCustomModelRequest + `__. This message is returned by the google.longrunning.Operations.response field. @@ -202,15 +213,20 @@ class TrainCustomModelResponse(proto.Message): model_status (str): The trained model status. Possible values are: - - **bad-data**: The training data quality is bad. - - **no-improvement**: Tuning didn't improve performance. - Won't deploy. - - **in-progress**: Model training job creation is in - progress. - - **training**: Model is actively training. - - **evaluating**: The model is evaluating trained metrics. - - **indexing**: The model trained metrics are indexing. - - **ready**: The model is ready for serving. + * **bad-data**: The training data quality is + bad. + + * **no-improvement**: Tuning didn't improve + performance. Won't deploy. * **in-progress**: + Model training job creation is in progress. + + * **training**: Model is actively training. + * **evaluating**: The model is evaluating + trained metrics. + + * **indexing**: The model trained metrics are + indexing. * **ready**: The model is ready for + serving. metrics (MutableMapping[str, float]): The metrics of the trained model. model_name (str): diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/serving_config.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/serving_config.py index a8e4f0566f16..b49fd8941e64 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/serving_config.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/serving_config.py @@ -57,78 +57,92 @@ class ServingConfig(proto.Message): Immutable. Fully qualified name ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`` display_name (str): - Required. The human readable serving config display name. - Used in Discovery UI. + Required. The human readable serving config + display name. Used in Discovery UI. - This field must be a UTF-8 encoded string with a length - limit of 128 characters. Otherwise, an INVALID_ARGUMENT - error is returned. + This field must be a UTF-8 encoded string with a + length limit of 128 characters. Otherwise, an + INVALID_ARGUMENT error is returned. solution_type (google.cloud.discoveryengine_v1.types.SolutionType): Required. Immutable. Specifies the solution type that a serving config can be associated with. model_id (str): - The id of the model to use at serving time. Currently only - RecommendationModels are supported. Can be changed but only - to a compatible model (e.g. others-you-may-like CTR to - others-you-may-like CVR). - - Required when - [SolutionType][google.cloud.discoveryengine.v1.SolutionType] + The id of the model to use at serving time. + Currently only RecommendationModels are + supported. Can be changed but only to a + compatible model (e.g. others-you-may-like CTR + to others-you-may-like CVR). + + Required when `SolutionType + `__ is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + `SOLUTION_TYPE_RECOMMENDATION + `__. diversity_level (str): - How much diversity to use in recommendation model results - e.g. ``medium-diversity`` or ``high-diversity``. Currently - supported values: + How much diversity to use in recommendation + model results e.g. ``medium-diversity`` or + ``high-diversity``. Currently supported values: - - ``no-diversity`` - - ``low-diversity`` - - ``medium-diversity`` - - ``high-diversity`` - - ``auto-diversity`` + * ``no-diversity`` + * ``low-diversity`` - If not specified, we choose default based on recommendation - model type. Default value: ``no-diversity``. + * ``medium-diversity`` + * ``high-diversity`` - Can only be set if - [SolutionType][google.cloud.discoveryengine.v1.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. - ranking_expression (str): - The ranking expression controls the customized ranking on - retrieval documents. To leverage this, document embedding is - required. The ranking expression setting in ServingConfig - applies to all search requests served by the serving config. - However, if ``SearchRequest.ranking_expression`` is - specified, it overrides the ServingConfig ranking - expression. + * ``auto-diversity`` - The ranking expression is a single function or multiple - functions that are joined by "+". + If not specified, we choose default based on + recommendation model type. Default value: + ``no-diversity``. - - ranking_expression = function, { " + ", function }; + Can only be set if + `SolutionType + `__ + is `SOLUTION_TYPE_RECOMMENDATION + `__. + ranking_expression (str): + The ranking expression controls the customized + ranking on retrieval documents. To leverage + this, document embedding is required. The + ranking expression setting in ServingConfig + applies to all search requests served by the + serving config. However, if + ``SearchRequest.ranking_expression`` is + specified, it overrides the ServingConfig + ranking expression. + + The ranking expression is a single function or + multiple functions that are joined by "+". + + * ranking_expression = function, { " + ", + function }; Supported functions: - - double \* relevance_score - - double \* dotProduct(embedding_field_path) + * double * relevance_score + * double * dotProduct(embedding_field_path) Function variables: - - ``relevance_score``: pre-defined keywords, used for - measure relevance between query and document. - - ``embedding_field_path``: the document embedding field - used with query embedding vector. - - ``dotProduct``: embedding function between - embedding_field_path and query embedding vector. + * ``relevance_score``: pre-defined keywords, + used for measure relevance between query and + document. + + * ``embedding_field_path``: the document + embedding field used with query embedding + vector. - Example ranking expression: + * ``dotProduct``: embedding function between + embedding_field_path and query embedding + vector. - :: + Example ranking expression: - If document has an embedding field doc_embedding, the ranking expression - could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. + If document has an embedding field + doc_embedding, the ranking expression could + be ``0.5 * relevance_score + 0.3 * + dotProduct(doc_embedding)``. create_time (google.protobuf.timestamp_pb2.Timestamp): Output only. ServingConfig created timestamp. update_time (google.protobuf.timestamp_pb2.Timestamp): @@ -146,52 +160,64 @@ class ServingConfig(proto.Message): the serving config. Maximum of 20 boost controls. redirect_control_ids (MutableSequence[str]): - IDs of the redirect controls. Only the first triggered - redirect action is applied, even if multiple apply. Maximum - number of specifications is 100. + IDs of the redirect controls. Only the first + triggered redirect action is applied, even if + multiple apply. Maximum number of specifications + is 100. Can only be set if - [SolutionType][google.cloud.discoveryengine.v1.SolutionType] - is - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH]. + `SolutionType + `__ + is `SOLUTION_TYPE_SEARCH + `__. synonyms_control_ids (MutableSequence[str]): - Condition synonyms specifications. If multiple synonyms - conditions match, all matching synonyms controls in the list - will execute. Maximum number of specifications is 100. + Condition synonyms specifications. If multiple + synonyms conditions match, all matching synonyms + controls in the list will execute. Maximum + number of specifications is 100. Can only be set if - [SolutionType][google.cloud.discoveryengine.v1.SolutionType] - is - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH]. + `SolutionType + `__ + is `SOLUTION_TYPE_SEARCH + `__. oneway_synonyms_control_ids (MutableSequence[str]): - Condition oneway synonyms specifications. If multiple oneway - synonyms conditions match, all matching oneway synonyms - controls in the list will execute. Maximum number of - specifications is 100. + Condition oneway synonyms specifications. If + multiple oneway synonyms conditions match, all + matching oneway synonyms controls in the list + will execute. Maximum number of specifications + is 100. Can only be set if - [SolutionType][google.cloud.discoveryengine.v1.SolutionType] - is - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH]. + `SolutionType + `__ + is `SOLUTION_TYPE_SEARCH + `__. dissociate_control_ids (MutableSequence[str]): - Condition do not associate specifications. If multiple do - not associate conditions match, all matching do not - associate controls in the list will execute. Order does not - matter. Maximum number of specifications is 100. + Condition do not associate specifications. If + multiple do not associate conditions match, all + matching do not associate controls in the list + will execute. + Order does not matter. + Maximum number of specifications is 100. Can only be set if - [SolutionType][google.cloud.discoveryengine.v1.SolutionType] - is - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH]. + `SolutionType + `__ + is `SOLUTION_TYPE_SEARCH + `__. replacement_control_ids (MutableSequence[str]): - Condition replacement specifications. Applied according to - the order in the list. A previously replaced term can not be - re-replaced. Maximum number of specifications is 100. + Condition replacement specifications. + Applied according to the order in the list. + A previously replaced term can not be + re-replaced. Maximum number of specifications is + 100. Can only be set if - [SolutionType][google.cloud.discoveryengine.v1.SolutionType] - is - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH]. + `SolutionType + `__ + is `SOLUTION_TYPE_SEARCH + `__. ignore_control_ids (MutableSequence[str]): Condition ignore specifications. If multiple ignore conditions match, all matching ignore @@ -205,22 +231,24 @@ class ServingConfig(proto.Message): """ class MediaConfig(proto.Message): - r"""Specifies the configurations needed for Media Discovery. Currently - we support: - - - ``demote_content_watched``: Threshold for watched content - demotion. Customers can specify if using watched content demotion - or use viewed detail page. Using the content watched demotion, - customers need to specify the watched minutes or percentage - exceeds the threshold, the content will be demoted in the - recommendation result. - - ``promote_fresh_content``: cutoff days for fresh content - promotion. Customers can specify if using content freshness - promotion. If the content was published within the cutoff days, - the content will be promoted in the recommendation result. Can - only be set if - [SolutionType][google.cloud.discoveryengine.v1.SolutionType] is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + r"""Specifies the configurations needed for Media Discovery. + Currently we support: + + * ``demote_content_watched``: Threshold for watched content + demotion. Customers can specify if using watched content + demotion or use viewed detail page. Using the content watched + demotion, customers need to specify the watched minutes or + percentage exceeds the threshold, the content will be demoted in + the recommendation result. + + * ``promote_fresh_content``: cutoff days for fresh content + promotion. Customers can specify if using content freshness + promotion. If the content was published within the cutoff days, + the content will be promoted in the recommendation result. + Can only be set if + `SolutionType `__ + is `SOLUTION_TYPE_RECOMMENDATION + `__. This message has `oneof`_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. @@ -231,9 +259,9 @@ class MediaConfig(proto.Message): Attributes: content_watched_percentage_threshold (float): - Specifies the content watched percentage threshold for - demotion. Threshold value must be between [0, 1.0] - inclusive. + Specifies the content watched percentage + threshold for demotion. Threshold value must be + between [0, 1.0] inclusive. This field is a member of `oneof`_ ``demote_content_watched``. content_watched_seconds_threshold (float): @@ -242,17 +270,20 @@ class MediaConfig(proto.Message): This field is a member of `oneof`_ ``demote_content_watched``. demotion_event_type (str): - Specifies the event type used for demoting recommendation - result. Currently supported values: + Specifies the event type used for demoting + recommendation result. Currently supported + values: + + * ``view-item``: Item viewed. + * ``media-play``: Start/resume watching a video, + playing a song, etc. - - ``view-item``: Item viewed. - - ``media-play``: Start/resume watching a video, playing a - song, etc. - - ``media-complete``: Finished or stopped midway through a - video, song, etc. + * ``media-complete``: Finished or stopped midway + through a video, song, etc. - If unset, watch history demotion will not be applied. - Content freshness demotion will still be applied. + If unset, watch history demotion will not be + applied. Content freshness demotion will still + be applied. demote_content_watched_past_days (int): Optional. Specifies the number of days to look back for demoting watched content. If set @@ -289,10 +320,11 @@ class MediaConfig(proto.Message): ) class GenericConfig(proto.Message): - r"""Specifies the configurations needed for Generic Discovery.Currently - we support: + r"""Specifies the configurations needed for Generic + Discovery.Currently we support: - - ``content_search_spec``: configuration for generic content search. + * ``content_search_spec``: configuration for generic content + search. Attributes: content_search_spec (google.cloud.discoveryengine_v1.types.SearchRequest.ContentSearchSpec): diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/serving_config_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/serving_config_service.py index a98b56d80234..d7d62e60f5ea 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/serving_config_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/serving_config_service.py @@ -38,10 +38,12 @@ class UpdateServingConfigRequest(proto.Message): Required. The ServingConfig to update. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] + `ServingConfig + `__ to update. The following are NOT supported: - - [ServingConfig.name][google.cloud.discoveryengine.v1.ServingConfig.name] + * `ServingConfig.name + `__ If not set, all supported fields are updated. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/session.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/session.py index ce86a30fea33..4c9d8d124653 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/session.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/session.py @@ -92,18 +92,22 @@ class Turn(proto.Message): call) happened in this turn. detailed_answer (google.cloud.discoveryengine_v1.types.Answer): Output only. In - [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1.ConversationalSearchService.GetSession] + `ConversationalSearchService.GetSession + `__ API, if - [GetSessionRequest.include_answer_details][google.cloud.discoveryengine.v1.GetSessionRequest.include_answer_details] - is set to true, this field will be populated when getting - answer query session. + `GetSessionRequest.include_answer_details + `__ + is set to true, this field will be populated + when getting answer query session. detailed_assist_answer (google.cloud.discoveryengine_v1.types.AssistAnswer): Output only. In - [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1.ConversationalSearchService.GetSession] + `ConversationalSearchService.GetSession + `__ API, if - [GetSessionRequest.include_answer_details][google.cloud.discoveryengine.v1.GetSessionRequest.include_answer_details] - is set to true, this field will be populated when getting - assistant session. + `GetSessionRequest.include_answer_details + `__ + is set to true, this field will be populated + when getting assistant session. query_config (MutableMapping[str, str]): Optional. Represents metadata related to the query config, for example LLM model and version diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/site_search_engine.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/site_search_engine.py index d9e98efc17a5..7d2692c8233b 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/site_search_engine.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/site_search_engine.py @@ -38,8 +38,8 @@ class SiteSearchEngine(proto.Message): Attributes: name (str): - The fully qualified resource name of the site search engine. - Format: + The fully qualified resource name of the site + search engine. Format: ``projects/*/locations/*/dataStores/*/siteSearchEngine`` """ @@ -54,30 +54,34 @@ class TargetSite(proto.Message): Attributes: name (str): - Output only. The fully qualified resource name of the target - site. + Output only. The fully qualified resource name + of the target site. ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`` The ``target_site_id`` is system-generated. provided_uri_pattern (str): - Required. Input only. The user provided URI pattern from - which the ``generated_uri_pattern`` is generated. + Required. Input only. The user provided URI + pattern from which the ``generated_uri_pattern`` + is generated. type_ (google.cloud.discoveryengine_v1.types.TargetSite.Type): The type of the target site, e.g., whether the site is to be included or excluded. exact_match (bool): - Immutable. If set to false, a uri_pattern is generated to - include all pages whose address contains the - provided_uri_pattern. If set to true, an uri_pattern is - generated to try to be an exact match of the - provided_uri_pattern or just the specific page if the - provided_uri_pattern is a specific one. provided_uri_pattern - is always normalized to generate the URI pattern to be used - by the search engine. + Immutable. If set to false, a uri_pattern is + generated to include all pages whose address + contains the provided_uri_pattern. If set to + true, an uri_pattern is generated to try to be + an exact match of the provided_uri_pattern or + just the specific page if the + provided_uri_pattern is a specific one. + provided_uri_pattern is always normalized to + generate the URI pattern to be used by the + search engine. generated_uri_pattern (str): - Output only. This is system-generated based on the - provided_uri_pattern. + Output only. This is system-generated based on + the provided_uri_pattern. root_domain_uri (str): - Output only. Root domain of the provided_uri_pattern. + Output only. Root domain of the + provided_uri_pattern. site_verification_info (google.cloud.discoveryengine_v1.types.SiteVerificationInfo): Output only. Site ownership and validity verification status. @@ -95,9 +99,9 @@ class Type(proto.Enum): Values: TYPE_UNSPECIFIED (0): - This value is unused. In this case, server behavior defaults - to - [Type.INCLUDE][google.cloud.discoveryengine.v1.TargetSite.Type.INCLUDE]. + This value is unused. In this case, server + behavior defaults to `Type.INCLUDE + `__. INCLUDE (1): Include the target site. EXCLUDE (2): @@ -280,8 +284,8 @@ class Sitemap(proto.Message): This field is a member of `oneof`_ ``feed``. name (str): - Output only. The fully qualified resource name of the - sitemap. + Output only. The fully qualified resource name + of the sitemap. ``projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*`` The ``sitemap_id`` suffix is system-generated. create_time (google.protobuf.timestamp_pb2.Timestamp): diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/site_search_engine_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/site_search_engine_service.py index b4a266e68246..9b7776cd9685 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/site_search_engine_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/site_search_engine_service.py @@ -66,19 +66,22 @@ class GetSiteSearchEngineRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.GetSiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngineService.GetSiteSearchEngine] + `SiteSearchEngineService.GetSiteSearchEngine + `__ method. Attributes: name (str): Required. Resource name of - [SiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. - If the caller does not have permission to access the - [SiteSearchEngine], regardless of whether or not it exists, - a PERMISSION_DENIED error is returned. + If the caller does not have permission to access + the [SiteSearchEngine], regardless of whether or + not it exists, a PERMISSION_DENIED error is + returned. """ name: str = proto.Field( @@ -89,19 +92,21 @@ class GetSiteSearchEngineRequest(proto.Message): class CreateTargetSiteRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.CreateTargetSite] + `SiteSearchEngineService.CreateTargetSite + `__ method. Attributes: parent (str): Required. Parent resource name of - [TargetSite][google.cloud.discoveryengine.v1.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. target_site (google.cloud.discoveryengine_v1.types.TargetSite): - Required. The - [TargetSite][google.cloud.discoveryengine.v1.TargetSite] to - create. + Required. The `TargetSite + `__ + to create. """ parent: str = proto.Field( @@ -117,7 +122,8 @@ class CreateTargetSiteRequest(proto.Message): class CreateTargetSiteMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.CreateTargetSite] + `SiteSearchEngineService.CreateTargetSite + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -143,16 +149,18 @@ class CreateTargetSiteMetadata(proto.Message): class BatchCreateTargetSitesRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchCreateTargetSites] + `SiteSearchEngineService.BatchCreateTargetSites + `__ method. Attributes: parent (str): - Required. The parent resource shared by all TargetSites - being created. + Required. The parent resource shared by all + TargetSites being created. ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. - The parent field in the CreateBookRequest messages must - either be empty or match this field. + The parent field in the CreateBookRequest + messages must either be empty or match this + field. requests (MutableSequence[google.cloud.discoveryengine_v1.types.CreateTargetSiteRequest]): Required. The request message specifying the resources to create. A maximum of 20 TargetSites @@ -172,23 +180,26 @@ class BatchCreateTargetSitesRequest(proto.Message): class GetTargetSiteRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.GetTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.GetTargetSite] + `SiteSearchEngineService.GetTargetSite + `__ method. Attributes: name (str): Required. Full resource name of - [TargetSite][google.cloud.discoveryengine.v1.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}``. - If the caller does not have permission to access the - [TargetSite][google.cloud.discoveryengine.v1.TargetSite], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. + If the caller does not have permission to access + the `TargetSite + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. - If the requested - [TargetSite][google.cloud.discoveryengine.v1.TargetSite] + If the requested `TargetSite + `__ does not exist, a NOT_FOUND error is returned. """ @@ -200,20 +211,23 @@ class GetTargetSiteRequest(proto.Message): class UpdateTargetSiteRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.UpdateTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.UpdateTargetSite] + `SiteSearchEngineService.UpdateTargetSite + `__ method. Attributes: target_site (google.cloud.discoveryengine_v1.types.TargetSite): - Required. The target site to update. If the caller does not - have permission to update the - [TargetSite][google.cloud.discoveryengine.v1.TargetSite], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. - - If the - [TargetSite][google.cloud.discoveryengine.v1.TargetSite] to - update does not exist, a NOT_FOUND error is returned. + Required. The target site to update. + If the caller does not have permission to update + the `TargetSite + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. + + If the `TargetSite + `__ + to update does not exist, a NOT_FOUND error is + returned. """ target_site: gcd_site_search_engine.TargetSite = proto.Field( @@ -225,7 +239,8 @@ class UpdateTargetSiteRequest(proto.Message): class UpdateTargetSiteMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.UpdateTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.UpdateTargetSite] + `SiteSearchEngineService.UpdateTargetSite + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -251,23 +266,26 @@ class UpdateTargetSiteMetadata(proto.Message): class DeleteTargetSiteRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.DeleteTargetSite] + `SiteSearchEngineService.DeleteTargetSite + `__ method. Attributes: name (str): Required. Full resource name of - [TargetSite][google.cloud.discoveryengine.v1.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}``. - If the caller does not have permission to access the - [TargetSite][google.cloud.discoveryengine.v1.TargetSite], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. + If the caller does not have permission to access + the `TargetSite + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. - If the requested - [TargetSite][google.cloud.discoveryengine.v1.TargetSite] + If the requested `TargetSite + `__ does not exist, a NOT_FOUND error is returned. """ @@ -279,7 +297,8 @@ class DeleteTargetSiteRequest(proto.Message): class DeleteTargetSiteMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1.SiteSearchEngineService.DeleteTargetSite] + `SiteSearchEngineService.DeleteTargetSite + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -305,34 +324,39 @@ class DeleteTargetSiteMetadata(proto.Message): class ListTargetSitesRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.ListTargetSites] + `SiteSearchEngineService.ListTargetSites + `__ method. Attributes: parent (str): - Required. The parent site search engine resource name, such - as + Required. The parent site search engine resource + name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. If the caller does not have permission to list - [TargetSite][google.cloud.discoveryengine.v1.TargetSite]s - under this site search engine, regardless of whether or not - this branch exists, a PERMISSION_DENIED error is returned. + `TargetSite + `__s + under this site search engine, regardless of + whether or not this branch exists, a + PERMISSION_DENIED error is returned. page_size (int): - Requested page size. Server may return fewer items than - requested. If unspecified, server will pick an appropriate - default. The maximum value is 1000; values above 1000 will - be coerced to 1000. + Requested page size. Server may return fewer + items than requested. If unspecified, server + will pick an appropriate default. The maximum + value is 1000; values above 1000 will be coerced + to 1000. - If this field is negative, an INVALID_ARGUMENT error is - returned. + If this field is negative, an INVALID_ARGUMENT + error is returned. page_token (str): - A page token, received from a previous ``ListTargetSites`` - call. Provide this to retrieve the subsequent page. + A page token, received from a previous + ``ListTargetSites`` call. Provide this to + retrieve the subsequent page. - When paginating, all other parameters provided to - ``ListTargetSites`` must match the call that provided the - page token. + When paginating, all other parameters provided + to ``ListTargetSites`` must match the call that + provided the page token. """ parent: str = proto.Field( @@ -351,16 +375,17 @@ class ListTargetSitesRequest(proto.Message): class ListTargetSitesResponse(proto.Message): r"""Response message for - [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.ListTargetSites] + `SiteSearchEngineService.ListTargetSites + `__ method. Attributes: target_sites (MutableSequence[google.cloud.discoveryengine_v1.types.TargetSite]): List of TargetSites. next_page_token (str): - A token that can be sent as ``page_token`` to retrieve the - next page. If this field is omitted, there are no subsequent - pages. + A token that can be sent as ``page_token`` to + retrieve the next page. If this field is + omitted, there are no subsequent pages. total_size (int): The total number of items matching the request. This will always be populated in the @@ -390,7 +415,8 @@ def raw_page(self): class BatchCreateTargetSiteMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchCreateTargetSites] + `SiteSearchEngineService.BatchCreateTargetSites + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -416,7 +442,8 @@ class BatchCreateTargetSiteMetadata(proto.Message): class BatchCreateTargetSitesResponse(proto.Message): r"""Response message for - [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchCreateTargetSites] + `SiteSearchEngineService.BatchCreateTargetSites + `__ method. Attributes: @@ -435,18 +462,20 @@ class BatchCreateTargetSitesResponse(proto.Message): class CreateSitemapRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.CreateSitemap][google.cloud.discoveryengine.v1.SiteSearchEngineService.CreateSitemap] + `SiteSearchEngineService.CreateSitemap + `__ method. Attributes: parent (str): Required. Parent resource name of the - [SiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine``. sitemap (google.cloud.discoveryengine_v1.types.Sitemap): - Required. The - [Sitemap][google.cloud.discoveryengine.v1.Sitemap] to + Required. The `Sitemap + `__ to create. """ @@ -463,23 +492,27 @@ class CreateSitemapRequest(proto.Message): class DeleteSitemapRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.DeleteSitemap][google.cloud.discoveryengine.v1.SiteSearchEngineService.DeleteSitemap] + `SiteSearchEngineService.DeleteSitemap + `__ method. Attributes: name (str): Required. Full resource name of - [Sitemap][google.cloud.discoveryengine.v1.Sitemap], such as + `Sitemap + `__, + such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}``. - If the caller does not have permission to access the - [Sitemap][google.cloud.discoveryengine.v1.Sitemap], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. + If the caller does not have permission to access + the `Sitemap + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. - If the requested - [Sitemap][google.cloud.discoveryengine.v1.Sitemap] does not - exist, a NOT_FOUND error is returned. + If the requested `Sitemap + `__ + does not exist, a NOT_FOUND error is returned. """ name: str = proto.Field( @@ -490,30 +523,36 @@ class DeleteSitemapRequest(proto.Message): class FetchSitemapsRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.FetchSitemaps][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchSitemaps] + `SiteSearchEngineService.FetchSitemaps + `__ method. Attributes: parent (str): Required. Parent resource name of the - [SiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine``. matcher (google.cloud.discoveryengine_v1.types.FetchSitemapsRequest.Matcher): Optional. If specified, fetches the matching - [Sitemap][google.cloud.discoveryengine.v1.Sitemap]s. If not - specified, fetches all - [Sitemap][google.cloud.discoveryengine.v1.Sitemap]s in the - [DataStore][google.cloud.discoveryengine.v1.DataStore]. + `Sitemap + `__s. + If not specified, fetches all `Sitemap + `__s in + the `DataStore + `__. """ class UrisMatcher(proto.Message): - r"""Matcher for the [Sitemap][google.cloud.discoveryengine.v1.Sitemap]s - by their uris. + r"""Matcher for the `Sitemap + `__s by their uris. Attributes: uris (MutableSequence[str]): - The [Sitemap][google.cloud.discoveryengine.v1.Sitemap] uris. + The `Sitemap + `__ + uris. """ uris: MutableSequence[str] = proto.RepeatedField( @@ -522,8 +561,9 @@ class UrisMatcher(proto.Message): ) class Matcher(proto.Message): - r"""Matcher for the [Sitemap][google.cloud.discoveryengine.v1.Sitemap]s. - Currently only supports uris matcher. + r"""Matcher for the `Sitemap + `__s. Currently only + supports uris matcher. .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields @@ -555,7 +595,8 @@ class Matcher(proto.Message): class CreateSitemapMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.CreateSitemap][google.cloud.discoveryengine.v1.SiteSearchEngineService.CreateSitemap] + `SiteSearchEngineService.CreateSitemap + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -581,7 +622,8 @@ class CreateSitemapMetadata(proto.Message): class DeleteSitemapMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.DeleteSitemap][google.cloud.discoveryengine.v1.SiteSearchEngineService.DeleteSitemap] + `SiteSearchEngineService.DeleteSitemap + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -607,22 +649,25 @@ class DeleteSitemapMetadata(proto.Message): class FetchSitemapsResponse(proto.Message): r"""Response message for - [SiteSearchEngineService.FetchSitemaps][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchSitemaps] + `SiteSearchEngineService.FetchSitemaps + `__ method. Attributes: sitemaps_metadata (MutableSequence[google.cloud.discoveryengine_v1.types.FetchSitemapsResponse.SitemapMetadata]): - List of [Sitemap][google.cloud.discoveryengine.v1.Sitemap]s + List of `Sitemap + `__s fetched. """ class SitemapMetadata(proto.Message): - r"""Contains a [Sitemap][google.cloud.discoveryengine.v1.Sitemap] and - its metadata. + r"""Contains a `Sitemap `__ + and its metadata. Attributes: sitemap (google.cloud.discoveryengine_v1.types.Sitemap): - The [Sitemap][google.cloud.discoveryengine.v1.Sitemap]. + The `Sitemap + `__. """ sitemap: gcd_site_search_engine.Sitemap = proto.Field( @@ -640,13 +685,15 @@ class SitemapMetadata(proto.Message): class EnableAdvancedSiteSearchRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.EnableAdvancedSiteSearch] + `SiteSearchEngineService.EnableAdvancedSiteSearch + `__ method. Attributes: site_search_engine (str): Required. Full resource name of the - [SiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine``. """ @@ -659,7 +706,8 @@ class EnableAdvancedSiteSearchRequest(proto.Message): class EnableAdvancedSiteSearchResponse(proto.Message): r"""Response message for - [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.EnableAdvancedSiteSearch] + `SiteSearchEngineService.EnableAdvancedSiteSearch + `__ method. """ @@ -667,7 +715,8 @@ class EnableAdvancedSiteSearchResponse(proto.Message): class EnableAdvancedSiteSearchMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.EnableAdvancedSiteSearch] + `SiteSearchEngineService.EnableAdvancedSiteSearch + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -693,13 +742,15 @@ class EnableAdvancedSiteSearchMetadata(proto.Message): class DisableAdvancedSiteSearchRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.DisableAdvancedSiteSearch] + `SiteSearchEngineService.DisableAdvancedSiteSearch + `__ method. Attributes: site_search_engine (str): Required. Full resource name of the - [SiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine``. """ @@ -712,7 +763,8 @@ class DisableAdvancedSiteSearchRequest(proto.Message): class DisableAdvancedSiteSearchResponse(proto.Message): r"""Response message for - [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.DisableAdvancedSiteSearch] + `SiteSearchEngineService.DisableAdvancedSiteSearch + `__ method. """ @@ -720,7 +772,8 @@ class DisableAdvancedSiteSearchResponse(proto.Message): class DisableAdvancedSiteSearchMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1.SiteSearchEngineService.DisableAdvancedSiteSearch] + `SiteSearchEngineService.DisableAdvancedSiteSearch + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -746,21 +799,24 @@ class DisableAdvancedSiteSearchMetadata(proto.Message): class RecrawlUrisRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1.SiteSearchEngineService.RecrawlUris] + `SiteSearchEngineService.RecrawlUris + `__ method. Attributes: site_search_engine (str): Required. Full resource name of the - [SiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine``. uris (MutableSequence[str]): - Required. List of URIs to crawl. At most 10K URIs are - supported, otherwise an INVALID_ARGUMENT error is thrown. - Each URI should match at least one - [TargetSite][google.cloud.discoveryengine.v1.TargetSite] in - ``site_search_engine``. + Required. List of URIs to crawl. At most 10K + URIs are supported, otherwise an + INVALID_ARGUMENT error is thrown. Each URI + should match at least one `TargetSite + `__ + in ``site_search_engine``. site_credential (str): Optional. Credential id to use for crawling. """ @@ -781,12 +837,14 @@ class RecrawlUrisRequest(proto.Message): class RecrawlUrisResponse(proto.Message): r"""Response message for - [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1.SiteSearchEngineService.RecrawlUris] + `SiteSearchEngineService.RecrawlUris + `__ method. Attributes: failure_samples (MutableSequence[google.cloud.discoveryengine_v1.types.RecrawlUrisResponse.FailureInfo]): - Details for a sample of up to 10 ``failed_uris``. + Details for a sample of up to 10 + ``failed_uris``. failed_uris (MutableSequence[str]): URIs that were not crawled before the LRO terminated. @@ -870,7 +928,8 @@ class CorpusType(proto.Enum): class RecrawlUrisMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1.SiteSearchEngineService.RecrawlUris] + `SiteSearchEngineService.RecrawlUris + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -902,8 +961,8 @@ class RecrawlUrisMetadata(proto.Message): Total number of URIs that don't match any TargetSites. valid_uris_count (int): - Total number of unique URIs in the request that are not in - invalid_uris. + Total number of unique URIs in the request that + are not in invalid_uris. success_count (int): Total number of URIs that have been crawled so far. @@ -969,13 +1028,14 @@ class RecrawlUrisMetadata(proto.Message): class BatchVerifyTargetSitesRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchVerifyTargetSites] + `SiteSearchEngineService.BatchVerifyTargetSites + `__ method. Attributes: parent (str): - Required. The parent resource shared by all TargetSites - being verified. + Required. The parent resource shared by all + TargetSites being verified. ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. """ @@ -987,7 +1047,8 @@ class BatchVerifyTargetSitesRequest(proto.Message): class BatchVerifyTargetSitesResponse(proto.Message): r"""Response message for - [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchVerifyTargetSites] + `SiteSearchEngineService.BatchVerifyTargetSites + `__ method. """ @@ -995,7 +1056,8 @@ class BatchVerifyTargetSitesResponse(proto.Message): class BatchVerifyTargetSitesMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchVerifyTargetSites] + `SiteSearchEngineService.BatchVerifyTargetSites + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -1021,30 +1083,33 @@ class BatchVerifyTargetSitesMetadata(proto.Message): class FetchDomainVerificationStatusRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchDomainVerificationStatus] + `SiteSearchEngineService.FetchDomainVerificationStatus + `__ method. Attributes: site_search_engine (str): - Required. The site search engine resource under which we - fetch all the domain verification status. + Required. The site search engine resource under + which we fetch all the domain verification + status. ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. page_size (int): - Requested page size. Server may return fewer items than - requested. If unspecified, server will pick an appropriate - default. The maximum value is 1000; values above 1000 will - be coerced to 1000. + Requested page size. Server may return fewer + items than requested. If unspecified, server + will pick an appropriate default. The maximum + value is 1000; values above 1000 will be coerced + to 1000. - If this field is negative, an INVALID_ARGUMENT error is - returned. + If this field is negative, an INVALID_ARGUMENT + error is returned. page_token (str): A page token, received from a previous - ``FetchDomainVerificationStatus`` call. Provide this to - retrieve the subsequent page. + ``FetchDomainVerificationStatus`` call. Provide + this to retrieve the subsequent page. - When paginating, all other parameters provided to - ``FetchDomainVerificationStatus`` must match the call that - provided the page token. + When paginating, all other parameters provided + to ``FetchDomainVerificationStatus`` must match + the call that provided the page token. """ site_search_engine: str = proto.Field( @@ -1063,7 +1128,8 @@ class FetchDomainVerificationStatusRequest(proto.Message): class FetchDomainVerificationStatusResponse(proto.Message): r"""Response message for - [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchDomainVerificationStatus] + `SiteSearchEngineService.FetchDomainVerificationStatus + `__ method. Attributes: @@ -1071,9 +1137,9 @@ class FetchDomainVerificationStatusResponse(proto.Message): List of TargetSites containing the site verification status. next_page_token (str): - A token that can be sent as ``page_token`` to retrieve the - next page. If this field is omitted, there are no subsequent - pages. + A token that can be sent as ``page_token`` to + retrieve the next page. If this field is + omitted, there are no subsequent pages. total_size (int): The total number of items matching the request. This will always be populated in the diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/user_event.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/user_event.py index 4bed1bf502f0..4ab2ff6052e3 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/user_event.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/user_event.py @@ -49,206 +49,248 @@ class UserEvent(proto.Message): Generic values: - - ``search``: Search for Documents. - - ``view-item``: Detailed page view of a Document. - - ``view-item-list``: View of a panel or ordered list of - Documents. - - ``view-home-page``: View of the home page. - - ``view-category-page``: View of a category page, e.g. Home - > Men > Jeans - - ``add-feedback``: Add a user feedback. + * ``search``: Search for Documents. + * ``view-item``: Detailed page view of a + Document. + + * ``view-item-list``: View of a panel or ordered + list of Documents. * ``view-home-page``: View of + the home page. + + * ``view-category-page``: View of a category + page, e.g. Home > Men > Jeans * + ``add-feedback``: Add a user feedback. Retail-related values: - - ``add-to-cart``: Add an item(s) to cart, e.g. in Retail - online shopping - - ``purchase``: Purchase an item(s) + * ``add-to-cart``: Add an item(s) to cart, e.g. + in Retail online shopping * ``purchase``: + Purchase an item(s) Media-related values: - - ``media-play``: Start/resume watching a video, playing a - song, etc. - - ``media-complete``: Finished or stopped midway through a - video, song, etc. + * ``media-play``: Start/resume watching a video, + playing a song, etc. * ``media-complete``: + Finished or stopped midway through a video, + song, etc. Custom conversion value: - - ``conversion``: Customer defined conversion event. + * ``conversion``: Customer defined conversion + event. conversion_type (str): Optional. Conversion type. Required if - [UserEvent.event_type][google.cloud.discoveryengine.v1.UserEvent.event_type] - is ``conversion``. This is a customer-defined conversion - name in lowercase letters or numbers separated by "-", such - as "watch", "good-visit" etc. + `UserEvent.event_type + `__ + is ``conversion``. This is a customer-defined + conversion name in lowercase letters or numbers + separated by "-", such as "watch", "good-visit" + etc. Do not set the field if - [UserEvent.event_type][google.cloud.discoveryengine.v1.UserEvent.event_type] - is not ``conversion``. This mixes the custom conversion - event with predefined events like ``search``, ``view-item`` - etc. + `UserEvent.event_type + `__ + is not ``conversion``. This mixes the custom + conversion event with predefined events like + ``search``, ``view-item`` etc. user_pseudo_id (str): - Required. A unique identifier for tracking visitors. - - For example, this could be implemented with an HTTP cookie, - which should be able to uniquely identify a visitor on a - single device. This unique identifier should not change if - the visitor log in/out of the website. - - Do not set the field to the same fixed ID for different - users. This mixes the event history of those users together, - which results in degraded model quality. - - The field must be a UTF-8 encoded string with a length limit - of 128 characters. Otherwise, an ``INVALID_ARGUMENT`` error - is returned. + Required. A unique identifier for tracking + visitors. + For example, this could be implemented with an + HTTP cookie, which should be able to uniquely + identify a visitor on a single device. This + unique identifier should not change if the + visitor log in/out of the website. + + Do not set the field to the same fixed ID for + different users. This mixes the event history of + those users together, which results in degraded + model quality. + + The field must be a UTF-8 encoded string with a + length limit of 128 characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. - The field should not contain PII or user-data. We recommend - to use Google Analytics `Client - ID `__ + The field should not contain PII or user-data. + We recommend to use Google Analytics `Client + ID + `__ for this field. engine (str): - The [Engine][google.cloud.discoveryengine.v1.Engine] + The `Engine + `__ resource name, in the form of ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. Optional. Only required for - [Engine][google.cloud.discoveryengine.v1.Engine] produced - user events. For example, user events from blended search. + `Engine + `__ + produced user events. For example, user events + from blended search. data_store (str): - The [DataStore][google.cloud.discoveryengine.v1.DataStore] + The `DataStore + `__ resource full name, of the form ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. - Optional. Only required for user events whose data store - can't by determined by - [UserEvent.engine][google.cloud.discoveryengine.v1.UserEvent.engine] - or - [UserEvent.documents][google.cloud.discoveryengine.v1.UserEvent.documents]. - If data store is set in the parent of write/import/collect - user event requests, this field can be omitted. + Optional. Only required for user events whose + data store can't by determined by + `UserEvent.engine + `__ + or `UserEvent.documents + `__. + If data store is set in the parent of + write/import/collect user event requests, this + field can be omitted. event_time (google.protobuf.timestamp_pb2.Timestamp): Only required for - [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1.UserEventService.ImportUserEvents] - method. Timestamp of when the user event happened. + `UserEventService.ImportUserEvents + `__ + method. Timestamp of when the user event + happened. user_info (google.cloud.discoveryengine_v1.types.UserInfo): Information about the end user. direct_user_request (bool): - Should set to true if the request is made directly from the - end user, in which case the - [UserEvent.user_info.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent] + Should set to true if the request is made + directly from the end user, in which case the + `UserEvent.user_info.user_agent + `__ can be populated from the HTTP request. - This flag should be set only if the API request is made - directly from the end user such as a mobile app (and not if - a gateway or a server is processing and pushing the user - events). + This flag should be set only if the API request + is made directly from the end user such as a + mobile app (and not if a gateway or a server is + processing and pushing the user events). - This should not be set when using the JavaScript tag in - [UserEventService.CollectUserEvent][google.cloud.discoveryengine.v1.UserEventService.CollectUserEvent]. + This should not be set when using the JavaScript + tag in `UserEventService.CollectUserEvent + `__. session_id (str): - A unique identifier for tracking a visitor session with a - length limit of 128 bytes. A session is an aggregation of an - end user behavior in a time span. + A unique identifier for tracking a visitor + session with a length limit of 128 bytes. A + session is an aggregation of an end user + behavior in a time span. A general guideline to populate the session_id: - 1. If user has no activity for 30 min, a new session_id - should be assigned. - 2. The session_id should be unique across users, suggest use - uuid or add - [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id] - as prefix. + 1. If user has no activity for 30 min, a new + session_id should be assigned. + 2. The session_id should be unique across users, + suggest use uuid or add + `UserEvent.user_pseudo_id + `__ + as prefix. page_info (google.cloud.discoveryengine_v1.types.PageInfo): - Page metadata such as categories and other critical - information for certain event types such as - ``view-category-page``. + Page metadata such as categories and other + critical information for certain event types + such as ``view-category-page``. attribution_token (str): - Token to attribute an API response to user action(s) to - trigger the event. - - Highly recommended for user events that are the result of - [RecommendationService.Recommend][google.cloud.discoveryengine.v1.RecommendationService.Recommend]. - This field enables accurate attribution of recommendation - model performance. + Token to attribute an API response to user + action(s) to trigger the event. + Highly recommended for user events that are the + result of `RecommendationService.Recommend + `__. + This field enables accurate attribution of + recommendation model performance. The value must be one of: - - [RecommendResponse.attribution_token][google.cloud.discoveryengine.v1.RecommendResponse.attribution_token] - for events that are the result of - [RecommendationService.Recommend][google.cloud.discoveryengine.v1.RecommendationService.Recommend]. - - [SearchResponse.attribution_token][google.cloud.discoveryengine.v1.SearchResponse.attribution_token] - for events that are the result of - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]. - - This token enables us to accurately attribute page view or - conversion completion back to the event and the particular - predict response containing this clicked/purchased product. - If user clicks on product K in the recommendation results, - pass - [RecommendResponse.attribution_token][google.cloud.discoveryengine.v1.RecommendResponse.attribution_token] - as a URL parameter to product K's page. When recording - events on product K's page, log the - [RecommendResponse.attribution_token][google.cloud.discoveryengine.v1.RecommendResponse.attribution_token] + * `RecommendResponse.attribution_token + `__ + for events that are the result of + `RecommendationService.Recommend + `__. + + * `SearchResponse.attribution_token + `__ + for events that are the result of + `SearchService.Search + `__. + + This token enables us to accurately attribute + page view or conversion completion back to the + event and the particular predict response + containing this clicked/purchased product. If + user clicks on product K in the recommendation + results, pass + `RecommendResponse.attribution_token + `__ + as a URL parameter to product K's page. When + recording events on product K's page, log the + `RecommendResponse.attribution_token + `__ to this field. filter (str): - The filter syntax consists of an expression language for - constructing a predicate from one or more fields of the - documents being filtered. + The filter syntax consists of an expression + language for constructing a predicate from one + or more fields of the documents being filtered. - One example is for ``search`` events, the associated - [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] + One example is for ``search`` events, the + associated `SearchRequest + `__ may contain a filter expression in - [SearchRequest.filter][google.cloud.discoveryengine.v1.SearchRequest.filter] - conforming to https://google.aip.dev/160#filtering. - - Similarly, for ``view-item-list`` events that are generated - from a - [RecommendRequest][google.cloud.discoveryengine.v1.RecommendRequest], + `SearchRequest.filter + `__ + conforming to + https://google.aip.dev/160#filtering. + + Similarly, for ``view-item-list`` events that + are generated from a `RecommendRequest + `__, this field may be populated directly from - [RecommendRequest.filter][google.cloud.discoveryengine.v1.RecommendRequest.filter] - conforming to https://google.aip.dev/160#filtering. + `RecommendRequest.filter + `__ + conforming to + https://google.aip.dev/160#filtering. - The value must be a UTF-8 encoded string with a length limit - of 1,000 characters. Otherwise, an ``INVALID_ARGUMENT`` - error is returned. + The value must be a UTF-8 encoded string with a + length limit of 1,000 characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. documents (MutableSequence[google.cloud.discoveryengine_v1.types.DocumentInfo]): - List of - [Document][google.cloud.discoveryengine.v1.Document]s + List of `Document + `__s associated with this user event. - This field is optional except for the following event types: - - - ``view-item`` - - ``add-to-cart`` - - ``purchase`` - - ``media-play`` - - ``media-complete`` - - In a ``search`` event, this field represents the documents - returned to the end user on the current page (the end user - may have not finished browsing the whole page yet). When a - new page is returned to the end user, after - pagination/filtering/ordering even for the same query, a new - ``search`` event with different - [UserEvent.documents][google.cloud.discoveryengine.v1.UserEvent.documents] + This field is optional except for the following + event types: + + * ``view-item`` + * ``add-to-cart`` + + * ``purchase`` + * ``media-play`` + + * ``media-complete`` + + In a ``search`` event, this field represents the + documents returned to the end user on the + current page (the end user may have not finished + browsing the whole page yet). When a new page is + returned to the end user, after + pagination/filtering/ordering even for the same + query, a new ``search`` event with different + `UserEvent.documents + `__ is desired. panel (google.cloud.discoveryengine_v1.types.PanelInfo): Panel metadata associated with this user event. search_info (google.cloud.discoveryengine_v1.types.SearchInfo): - [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] + `SearchService.Search + `__ details related to the event. This field should be set for ``search`` event. completion_info (google.cloud.discoveryengine_v1.types.CompletionInfo): - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1.CompletionService.CompleteQuery] + `CompletionService.CompleteQuery + `__ details related to the event. - This field should be set for ``search`` event when - autocomplete function is enabled and the user clicks a - suggestion for search. + This field should be set for ``search`` event + when autocomplete function is enabled and the + user clicks a suggestion for search. transaction_info (google.cloud.discoveryengine_v1.types.TransactionInfo): The transaction metadata (if any) associated with this user event. @@ -262,34 +304,42 @@ class UserEvent(proto.Message): associated with promotions. Currently, this field is restricted to at most one ID. attributes (MutableMapping[str, google.cloud.discoveryengine_v1.types.CustomAttribute]): - Extra user event features to include in the recommendation - model. These attributes must NOT contain data that needs to - be parsed or processed further, e.g. JSON or other - encodings. - - If you provide custom attributes for ingested user events, - also include them in the user events that you associate with - prediction requests. Custom attribute formatting must be - consistent between imported events and events provided with - prediction requests. This lets the Discovery Engine API use - those custom attributes when training models and serving - predictions, which helps improve recommendation quality. - - This field needs to pass all below criteria, otherwise an - ``INVALID_ARGUMENT`` error is returned: - - - The key must be a UTF-8 encoded string with a length limit - of 5,000 characters. - - For text attributes, at most 400 values are allowed. Empty - values are not allowed. Each value must be a UTF-8 encoded - string with a length limit of 256 characters. - - For number attributes, at most 400 values are allowed. - - For product recommendations, an example of extra user - information is ``traffic_channel``, which is how a user - arrives at the site. Users can arrive at the site by coming - to the site directly, coming through Google search, or in - other ways. + Extra user event features to include in the + recommendation model. These attributes must NOT + contain data that needs to be parsed or + processed further, e.g. JSON or other encodings. + + If you provide custom attributes for ingested + user events, also include them in the user + events that you associate with prediction + requests. Custom attribute formatting must be + consistent between imported events and events + provided with prediction requests. This lets the + Discovery Engine API use those custom attributes + when training models and serving predictions, + which helps improve recommendation quality. + + This field needs to pass all below criteria, + otherwise an ``INVALID_ARGUMENT`` error is + returned: + + * The key must be a UTF-8 encoded string with a + length limit of 5,000 characters. + + * For text attributes, at most 400 values are + allowed. Empty values are not allowed. Each + value must be a UTF-8 encoded string with a + length limit of 256 characters. + + * For number attributes, at most 400 values are + allowed. + + For product recommendations, an example of extra + user information is ``traffic_channel``, which + is how a user arrives at the site. Users can + arrive + at the site by coming to the site directly, + coming through Google search, or in other ways. media_info (google.cloud.discoveryengine_v1.types.MediaInfo): Media-specific info. panels (MutableSequence[google.cloud.discoveryengine_v1.types.PanelInfo]): @@ -406,31 +456,36 @@ class PageInfo(proto.Message): pageview_id (str): A unique ID of a web page view. - This should be kept the same for all user events triggered - from the same pageview. For example, an item detail page - view could trigger multiple events as the user is browsing - the page. The ``pageview_id`` property should be kept the - same for all these events so that they can be grouped + This should be kept the same for all user events + triggered from the same pageview. For example, + an item detail page view could trigger multiple + events as the user is browsing the page. The + ``pageview_id`` property should be kept the same + for all these events so that they can be grouped together properly. - When using the client side event reporting with JavaScript - pixel and Google Tag Manager, this value is filled in - automatically. + When using the client side event reporting with + JavaScript pixel and Google Tag Manager, this + value is filled in automatically. page_category (str): - The most specific category associated with a category page. - - To represent full path of category, use '>' sign to separate - different hierarchies. If '>' is part of the category name, - replace it with other character(s). - - Category pages include special pages such as sales or - promotions. For instance, a special sale page may have the - category hierarchy: - ``"pageCategory" : "Sales > 2017 Black Friday Deals"``. - - Required for ``view-category-page`` events. Other event - types should not set this field. Otherwise, an - ``INVALID_ARGUMENT`` error is returned. + The most specific category associated with a + category page. + To represent full path of category, use '>' sign + to separate different hierarchies. If '>' is + part of the category name, replace it with other + character(s). + + Category pages include special pages such as + sales or promotions. For instance, a special + sale page may have the category hierarchy: + + ``"pageCategory" : "Sales > 2017 Black Friday + Deals"``. + + Required for ``view-category-page`` events. + Other event types should not set this field. + Otherwise, an ``INVALID_ARGUMENT`` error is + returned. uri (str): Complete URL (window.location.href) of the user's current page. @@ -476,49 +531,56 @@ class SearchInfo(proto.Message): The user's search query. See - [SearchRequest.query][google.cloud.discoveryengine.v1.SearchRequest.query] + `SearchRequest.query + `__ for definition. - The value must be a UTF-8 encoded string with a length limit - of 5,000 characters. Otherwise, an ``INVALID_ARGUMENT`` - error is returned. + The value must be a UTF-8 encoded string with a + length limit of 5,000 characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. At least one of - [search_query][google.cloud.discoveryengine.v1.SearchInfo.search_query] - or - [PageInfo.page_category][google.cloud.discoveryengine.v1.PageInfo.page_category] - is required for ``search`` events. Other event types should - not set this field. Otherwise, an ``INVALID_ARGUMENT`` error - is returned. + `search_query + `__ + or `PageInfo.page_category + `__ + is required for ``search`` events. Other event + types should not set this field. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. order_by (str): - The order in which products are returned, if applicable. - + The order in which products are returned, if + applicable. See - [SearchRequest.order_by][google.cloud.discoveryengine.v1.SearchRequest.order_by] + `SearchRequest.order_by + `__ for definition and syntax. - The value must be a UTF-8 encoded string with a length limit - of 1,000 characters. Otherwise, an ``INVALID_ARGUMENT`` - error is returned. - - This can only be set for ``search`` events. Other event - types should not set this field. Otherwise, an + The value must be a UTF-8 encoded string with a + length limit of 1,000 characters. Otherwise, an ``INVALID_ARGUMENT`` error is returned. + + This can only be set for ``search`` events. + Other event types should not set this field. + Otherwise, an ``INVALID_ARGUMENT`` error is + returned. offset (int): - An integer that specifies the current offset for pagination - (the 0-indexed starting location, amongst the products - deemed by the API as relevant). + An integer that specifies the current offset for + pagination (the 0-indexed starting location, + amongst the products deemed by the API as + relevant). See - [SearchRequest.offset][google.cloud.discoveryengine.v1.SearchRequest.offset] + `SearchRequest.offset + `__ for definition. - If this field is negative, an ``INVALID_ARGUMENT`` is - returned. + If this field is negative, an + ``INVALID_ARGUMENT`` is returned. - This can only be set for ``search`` events. Other event - types should not set this field. Otherwise, an - ``INVALID_ARGUMENT`` error is returned. + This can only be set for ``search`` events. + Other event types should not set this field. + Otherwise, an ``INVALID_ARGUMENT`` error is + returned. This field is a member of `oneof`_ ``_offset``. """ @@ -545,10 +607,12 @@ class CompletionInfo(proto.Message): Attributes: selected_suggestion (str): End user selected - [CompleteQueryResponse.QuerySuggestion.suggestion][google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion.suggestion]. + `CompleteQueryResponse.QuerySuggestion.suggestion + `__. selected_position (int): End user selected - [CompleteQueryResponse.QuerySuggestion.suggestion][google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion.suggestion] + `CompleteQueryResponse.QuerySuggestion.suggestion + `__ position, starting from 0. """ @@ -587,43 +651,49 @@ class TransactionInfo(proto.Message): This field is a member of `oneof`_ ``_tax``. cost (float): - All the costs associated with the products. These can be - manufacturing costs, shipping expenses not borne by the end - user, or any other costs, such that: - - - Profit = - [value][google.cloud.discoveryengine.v1.TransactionInfo.value] - - - [tax][google.cloud.discoveryengine.v1.TransactionInfo.tax] - - - [cost][google.cloud.discoveryengine.v1.TransactionInfo.cost] + All the costs associated with the products. + These can be manufacturing costs, shipping + expenses not borne by the end user, or any other + costs, such that: + + * Profit = `value + `__ + - `tax + `__ + - `cost + `__ This field is a member of `oneof`_ ``_cost``. discount_value (float): - The total discount(s) value applied to this transaction. - This figure should be excluded from - [TransactionInfo.value][google.cloud.discoveryengine.v1.TransactionInfo.value] + The total discount(s) value applied to this + transaction. This figure should be excluded from + `TransactionInfo.value + `__ For example, if a user paid - [TransactionInfo.value][google.cloud.discoveryengine.v1.TransactionInfo.value] - amount, then nominal (pre-discount) value of the transaction - is the sum of - [TransactionInfo.value][google.cloud.discoveryengine.v1.TransactionInfo.value] + `TransactionInfo.value + `__ + amount, then nominal (pre-discount) value of the + transaction is the sum of `TransactionInfo.value + `__ and - [TransactionInfo.discount_value][google.cloud.discoveryengine.v1.TransactionInfo.discount_value] + `TransactionInfo.discount_value + `__ - This means that profit is calculated the same way, - regardless of the discount value, and that - [TransactionInfo.discount_value][google.cloud.discoveryengine.v1.TransactionInfo.discount_value] + This means that profit is calculated the same + way, regardless of the discount value, and that + `TransactionInfo.discount_value + `__ can be larger than - [TransactionInfo.value][google.cloud.discoveryengine.v1.TransactionInfo.value]: + `TransactionInfo.value + `__: - - Profit = - [value][google.cloud.discoveryengine.v1.TransactionInfo.value] - - - [tax][google.cloud.discoveryengine.v1.TransactionInfo.tax] - - - [cost][google.cloud.discoveryengine.v1.TransactionInfo.cost] + * Profit = `value + `__ + - `tax + `__ + - `cost + `__ This field is a member of `oneof`_ ``_discount_value``. """ @@ -670,32 +740,37 @@ class DocumentInfo(proto.Message): Attributes: id (str): - The [Document][google.cloud.discoveryengine.v1.Document] + The `Document + `__ resource ID. This field is a member of `oneof`_ ``document_descriptor``. name (str): - The [Document][google.cloud.discoveryengine.v1.Document] + The `Document + `__ resource full name, of the form: + ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`` This field is a member of `oneof`_ ``document_descriptor``. uri (str): - The [Document][google.cloud.discoveryengine.v1.Document] URI - - only allowed for website data stores. + The `Document + `__ + URI - only allowed for website data stores. This field is a member of `oneof`_ ``document_descriptor``. quantity (int): - Quantity of the Document associated with the user event. - Defaults to 1. - - For example, this field is 2 if two quantities of the same - Document are involved in a ``add-to-cart`` event. + Quantity of the Document associated with the + user event. Defaults to 1. + For example, this field is 2 if two quantities + of the same Document are involved in a + ``add-to-cart`` event. - Required for events of the following event types: + Required for events of the following event + types: - - ``add-to-cart`` - - ``purchase`` + * ``add-to-cart`` + * ``purchase`` This field is a member of `oneof`_ ``_quantity``. promotion_ids (MutableSequence[str]): @@ -706,14 +781,15 @@ class DocumentInfo(proto.Message): Output only. Whether the referenced Document can be found in the data store. conversion_value (float): - Optional. The conversion value associated with this - Document. Must be set if - [UserEvent.event_type][google.cloud.discoveryengine.v1.UserEvent.event_type] + Optional. The conversion value associated with + this Document. Must be set if + `UserEvent.event_type + `__ is "conversion". - For example, a value of 1000 signifies that 1000 seconds - were spent viewing a Document for the ``watch`` conversion - type. + For example, a value of 1000 signifies that 1000 + seconds were spent viewing a Document for the + ``watch`` conversion type. This field is a member of `oneof`_ ``_conversion_value``. """ @@ -764,16 +840,18 @@ class PanelInfo(proto.Message): display_name (str): The display name of the panel. panel_position (int): - The ordered position of the panel, if shown to the user with - other panels. If set, then - [total_panels][google.cloud.discoveryengine.v1.PanelInfo.total_panels] + The ordered position of the panel, if shown to + the user with other panels. If set, then + `total_panels + `__ must also be set. This field is a member of `oneof`_ ``_panel_position``. total_panels (int): - The total number of panels, including this one, shown to the - user. Must be set if - [panel_position][google.cloud.discoveryengine.v1.PanelInfo.panel_position] + The total number of panels, including this one, + shown to the user. Must be set if + `panel_position + `__ is set. This field is a member of `oneof`_ ``_total_panels``. @@ -814,20 +892,24 @@ class MediaInfo(proto.Message): Attributes: media_progress_duration (google.protobuf.duration_pb2.Duration): - The media progress time in seconds, if applicable. For - example, if the end user has finished 90 seconds of a - playback video, then - [MediaInfo.media_progress_duration.seconds][google.protobuf.Duration.seconds] - should be set to 90. + The media progress time in seconds, if + applicable. For example, if the end user has + finished 90 seconds of a playback video, then + `MediaInfo.media_progress_duration.seconds + `__ should be + set to 90. media_progress_percentage (float): Media progress should be computed using only the - [media_progress_duration][google.cloud.discoveryengine.v1.MediaInfo.media_progress_duration] + `media_progress_duration + `__ relative to the media total length. - This value must be between ``[0, 1.0]`` inclusive. + This value must be between ``[0, 1.0]`` + inclusive. - If this is not a playback or the progress cannot be computed - (e.g. ongoing livestream), this field should be unset. + If this is not a playback or the progress cannot + be computed (e.g. ongoing livestream), this + field should be unset. This field is a member of `oneof`_ ``_media_progress_percentage``. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/user_event_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/user_event_service.py index c547864b34f8..8dc86fdb7b50 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/user_event_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/user_event_service.py @@ -37,18 +37,22 @@ class WriteUserEventRequest(proto.Message): Attributes: parent (str): - Required. The parent resource name. If the write user event - action is applied in - [DataStore][google.cloud.discoveryengine.v1.DataStore] + Required. The parent resource name. + If the write user event action is applied in + `DataStore + `__ level, the format is: + ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}``. If the write user event action is applied in - [Location][google.cloud.location.Location] level, for - example, the event with - [Document][google.cloud.discoveryengine.v1.Document] across - multiple - [DataStore][google.cloud.discoveryengine.v1.DataStore], the - format is: ``projects/{project}/locations/{location}``. + `Location `__ + level, for example, the event with `Document + `__ + across multiple `DataStore + `__, + the format is: + + ``projects/{project}/locations/{location}``. user_event (google.cloud.discoveryengine_v1.types.UserEvent): Required. User event to write. @@ -82,18 +86,22 @@ class CollectUserEventRequest(proto.Message): Attributes: parent (str): - Required. The parent resource name. If the collect user - event action is applied in - [DataStore][google.cloud.discoveryengine.v1.DataStore] + Required. The parent resource name. + If the collect user event action is applied in + `DataStore + `__ level, the format is: + ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}``. If the collect user event action is applied in - [Location][google.cloud.location.Location] level, for - example, the event with - [Document][google.cloud.discoveryengine.v1.Document] across - multiple - [DataStore][google.cloud.discoveryengine.v1.DataStore], the - format is: ``projects/{project}/locations/{location}``. + `Location `__ + level, for example, the event with `Document + `__ + across multiple `DataStore + `__, + the format is: + + ``projects/{project}/locations/{location}``. user_event (str): Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/user_license.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/user_license.py index 203b5ed77612..e7e6fa4bcad9 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/user_license.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/user_license.py @@ -73,15 +73,17 @@ class LicenseAssignmentState(proto.Enum): ASSIGNED (1): License assigned to the user. UNASSIGNED (2): - No license assigned to the user. Deprecated, translated to - NO_LICENSE. + No license assigned to the user. + Deprecated, translated to NO_LICENSE. NO_LICENSE (3): No license assigned to the user. NO_LICENSE_ATTEMPTED_LOGIN (4): - User attempted to login but no license assigned to the user. - This state is only used for no user first time login attempt - but cannot get license assigned. Users already logged in but - cannot get license assigned will be assigned NO_LICENSE + User attempted to login but no license assigned + to the user. This state is only used for no user + first time login attempt but cannot get license + assigned. + Users already logged in but cannot get license + assigned will be assigned NO_LICENSE state(License could be unassigned by admin). """ LICENSE_ASSIGNMENT_STATE_UNSPECIFIED = 0 diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/user_license_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/user_license_service.py index 44d117f50b75..4b3cd422c487 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/user_license_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/types/user_license_service.py @@ -38,45 +38,51 @@ class ListUserLicensesRequest(proto.Message): r"""Request message for - [UserLicenseService.ListUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.ListUserLicenses]. + `UserLicenseService.ListUserLicenses + `__. Attributes: parent (str): - Required. The parent [UserStore][] resource name, format: + Required. The parent [UserStore][] resource + name, format: ``projects/{project}/locations/{location}/userStores/{user_store_id}``. page_size (int): - Optional. Requested page size. Server may return fewer items - than requested. If unspecified, defaults to 10. The maximum - value is 50; values above 50 will be coerced to 50. + Optional. Requested page size. Server may return + fewer items than requested. If unspecified, + defaults to 10. The maximum value is 50; values + above 50 will be coerced to 50. - If this field is negative, an INVALID_ARGUMENT error is - returned. + If this field is negative, an INVALID_ARGUMENT + error is returned. page_token (str): Optional. A page token, received from a previous - ``ListUserLicenses`` call. Provide this to retrieve the - subsequent page. + ``ListUserLicenses`` call. Provide this to + retrieve the subsequent page. - When paginating, all other parameters provided to - ``ListUserLicenses`` must match the call that provided the - page token. + When paginating, all other parameters provided + to ``ListUserLicenses`` must match the call that + provided the page token. filter (str): Optional. Filter for the list request. Supported fields: - - ``license_assignment_state`` + * ``license_assignment_state`` Examples: - - ``license_assignment_state = ASSIGNED`` to list assigned - user licenses. - - ``license_assignment_state = NO_LICENSE`` to list not - licensed users. - - ``license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN`` - to list users who attempted login but no license assigned. - - ``license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN`` - to filter out users who attempted login but no license - assigned. + * ``license_assignment_state = ASSIGNED`` to + list assigned user licenses. * + ``license_assignment_state = NO_LICENSE`` to + list not licensed users. + + * ``license_assignment_state = + NO_LICENSE_ATTEMPTED_LOGIN`` to list users who + attempted login but no license assigned. + + * ``license_assignment_state != + NO_LICENSE_ATTEMPTED_LOGIN`` to filter out users + who attempted login but no license assigned. """ parent: str = proto.Field( @@ -99,16 +105,18 @@ class ListUserLicensesRequest(proto.Message): class ListUserLicensesResponse(proto.Message): r"""Response message for - [UserLicenseService.ListUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.ListUserLicenses]. + `UserLicenseService.ListUserLicenses + `__. Attributes: user_licenses (MutableSequence[google.cloud.discoveryengine_v1.types.UserLicense]): All the customer's - [UserLicense][google.cloud.discoveryengine.v1.UserLicense]s. + `UserLicense + `__s. next_page_token (str): - A token, which can be sent as ``page_token`` to retrieve the - next page. If this field is omitted, there are no subsequent - pages. + A token, which can be sent as ``page_token`` to + retrieve the next page. If this field is + omitted, there are no subsequent pages. """ @property @@ -128,7 +136,8 @@ def raw_page(self): class BatchUpdateUserLicensesRequest(proto.Message): r"""Request message for - [UserLicenseService.BatchUpdateUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.BatchUpdateUserLicenses] + `UserLicenseService.BatchUpdateUserLicenses + `__ method. @@ -141,7 +150,8 @@ class BatchUpdateUserLicensesRequest(proto.Message): This field is a member of `oneof`_ ``source``. parent (str): - Required. The parent [UserStore][] resource name, format: + Required. The parent [UserStore][] resource + name, format: ``projects/{project}/locations/{location}/userStores/{user_store_id}``. delete_unassigned_user_licenses (bool): Optional. If true, if user licenses removed @@ -156,9 +166,10 @@ class InlineSource(proto.Message): Attributes: user_licenses (MutableSequence[google.cloud.discoveryengine_v1.types.UserLicense]): - Required. A list of user licenses to update. Each user - license must have a valid - [UserLicense.user_principal][google.cloud.discoveryengine.v1.UserLicense.user_principal]. + Required. A list of user licenses to update. + Each user license must have a valid + `UserLicense.user_principal + `__. update_mask (google.protobuf.field_mask_pb2.FieldMask): Optional. The list of fields to update. """ @@ -192,7 +203,8 @@ class InlineSource(proto.Message): class BatchUpdateUserLicensesMetadata(proto.Message): r"""Metadata related to the progress of the - [UserLicenseService.BatchUpdateUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.BatchUpdateUserLicenses] + `UserLicenseService.BatchUpdateUserLicenses + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -231,7 +243,8 @@ class BatchUpdateUserLicensesMetadata(proto.Message): class BatchUpdateUserLicensesResponse(proto.Message): r"""Response message for - [UserLicenseService.BatchUpdateUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.BatchUpdateUserLicenses] + `UserLicenseService.BatchUpdateUserLicenses + `__ method. Attributes: diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/gapic_version.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/gapic_version.py index 6b356a66811e..fd79d4e761b7 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/gapic_version.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "0.15.0" # {x-release-please-version} +__version__ = "0.4.0" # {x-release-please-version} diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/acl_config_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/acl_config_service/async_client.py index d035bf351f59..d97ea3dc630a 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/acl_config_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/acl_config_service/async_client.py @@ -394,8 +394,8 @@ async def get_acl_config( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> acl_config.AclConfig: - r"""Gets the - [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig]. + r"""Gets the `AclConfig + `__. .. code-block:: python @@ -429,13 +429,16 @@ async def sample_get_acl_config(): GetAclConfigRequest method. name (:class:`str`): Required. Resource name of - [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig], - such as ``projects/*/locations/*/aclConfig``. - - If the caller does not have permission to access the - [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + `AclConfig + `__, + such as + ``projects/*/locations/*/aclConfig``. + + If the caller does not have permission + to access the `AclConfig + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/acl_config_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/acl_config_service/client.py index 3dfd53322b7a..9bf73a2e6623 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/acl_config_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/acl_config_service/client.py @@ -813,8 +813,8 @@ def get_acl_config( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> acl_config.AclConfig: - r"""Gets the - [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig]. + r"""Gets the `AclConfig + `__. .. code-block:: python @@ -848,13 +848,16 @@ def sample_get_acl_config(): GetAclConfigRequest method. name (str): Required. Resource name of - [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig], - such as ``projects/*/locations/*/aclConfig``. - - If the caller does not have permission to access the - [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + `AclConfig + `__, + such as + ``projects/*/locations/*/aclConfig``. + + If the caller does not have permission + to access the `AclConfig + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/acl_config_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/acl_config_service/transports/grpc.py index 43d56bd1e0cd..301821485a23 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/acl_config_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/acl_config_service/transports/grpc.py @@ -358,8 +358,8 @@ def get_acl_config( ) -> Callable[[acl_config_service.GetAclConfigRequest], acl_config.AclConfig]: r"""Return a callable for the get acl config method over gRPC. - Gets the - [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig]. + Gets the `AclConfig + `__. Returns: Callable[[~.GetAclConfigRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/acl_config_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/acl_config_service/transports/grpc_asyncio.py index 3cdaf8d90c3a..bc7c16b89e97 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/acl_config_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/acl_config_service/transports/grpc_asyncio.py @@ -370,8 +370,8 @@ def get_acl_config( ]: r"""Return a callable for the get acl config method over gRPC. - Gets the - [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig]. + Gets the `AclConfig + `__. Returns: Callable[[~.GetAclConfigRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/chunk_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/chunk_service/async_client.py index 7960129d3aeb..dec342e0d600 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/chunk_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/chunk_service/async_client.py @@ -67,8 +67,8 @@ class ChunkServiceAsyncClient: """Service for displaying processed - [Chunk][google.cloud.discoveryengine.v1alpha.Chunk] information of - the customer's unstructured data. + `Chunk `__ + information of the customer's unstructured data. """ _client: ChunkServiceClient @@ -301,8 +301,8 @@ async def get_chunk( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> chunk.Chunk: - r"""Gets a - [Document][google.cloud.discoveryengine.v1alpha.Document]. + r"""Gets a `Document + `__. .. code-block:: python @@ -333,22 +333,27 @@ async def sample_get_chunk(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.GetChunkRequest, dict]]): The request object. Request message for - [ChunkService.GetChunk][google.cloud.discoveryengine.v1alpha.ChunkService.GetChunk] + `ChunkService.GetChunk + `__ method. name (:class:`str`): Required. Full resource name of - [Chunk][google.cloud.discoveryengine.v1alpha.Chunk], + `Chunk + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}``. - If the caller does not have permission to access the - [Chunk][google.cloud.discoveryengine.v1alpha.Chunk], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + If the caller does not have permission + to access the `Chunk + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. - If the requested - [Chunk][google.cloud.discoveryengine.v1alpha.Chunk] does - not exist, a ``NOT_FOUND`` error is returned. + If the requested `Chunk + `__ + does not exist, a ``NOT_FOUND`` error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -426,8 +431,8 @@ async def list_chunks( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListChunksAsyncPager: - r"""Gets a list of - [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s. + r"""Gets a list of `Chunk + `__s. .. code-block:: python @@ -459,17 +464,20 @@ async def sample_list_chunks(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.ListChunksRequest, dict]]): The request object. Request message for - [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks] + `ChunkService.ListChunks + `__ method. parent (:class:`str`): - Required. The parent document resource name, such as + Required. The parent document resource + name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}``. - If the caller does not have permission to list - [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s - under this document, regardless of whether or not this - document exists, a ``PERMISSION_DENIED`` error is - returned. + If the caller does not have permission + to list `Chunk + `__s + under this document, regardless of + whether or not this document exists, a + ``PERMISSION_DENIED`` error is returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -485,11 +493,13 @@ async def sample_list_chunks(): Returns: google.cloud.discoveryengine_v1alpha.services.chunk_service.pagers.ListChunksAsyncPager: Response message for - [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks] - method. + `ChunkService.ListChunks + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/chunk_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/chunk_service/client.py index 54952471aac3..3ee47cb0eef5 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/chunk_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/chunk_service/client.py @@ -111,8 +111,8 @@ def get_transport_class( class ChunkServiceClient(metaclass=ChunkServiceClientMeta): """Service for displaying processed - [Chunk][google.cloud.discoveryengine.v1alpha.Chunk] information of - the customer's unstructured data. + `Chunk `__ + information of the customer's unstructured data. """ @staticmethod @@ -753,8 +753,8 @@ def get_chunk( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> chunk.Chunk: - r"""Gets a - [Document][google.cloud.discoveryengine.v1alpha.Document]. + r"""Gets a `Document + `__. .. code-block:: python @@ -785,22 +785,27 @@ def sample_get_chunk(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.GetChunkRequest, dict]): The request object. Request message for - [ChunkService.GetChunk][google.cloud.discoveryengine.v1alpha.ChunkService.GetChunk] + `ChunkService.GetChunk + `__ method. name (str): Required. Full resource name of - [Chunk][google.cloud.discoveryengine.v1alpha.Chunk], + `Chunk + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}``. - If the caller does not have permission to access the - [Chunk][google.cloud.discoveryengine.v1alpha.Chunk], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + If the caller does not have permission + to access the `Chunk + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. - If the requested - [Chunk][google.cloud.discoveryengine.v1alpha.Chunk] does - not exist, a ``NOT_FOUND`` error is returned. + If the requested `Chunk + `__ + does not exist, a ``NOT_FOUND`` error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -875,8 +880,8 @@ def list_chunks( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListChunksPager: - r"""Gets a list of - [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s. + r"""Gets a list of `Chunk + `__s. .. code-block:: python @@ -908,17 +913,20 @@ def sample_list_chunks(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.ListChunksRequest, dict]): The request object. Request message for - [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks] + `ChunkService.ListChunks + `__ method. parent (str): - Required. The parent document resource name, such as + Required. The parent document resource + name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}``. - If the caller does not have permission to list - [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s - under this document, regardless of whether or not this - document exists, a ``PERMISSION_DENIED`` error is - returned. + If the caller does not have permission + to list `Chunk + `__s + under this document, regardless of + whether or not this document exists, a + ``PERMISSION_DENIED`` error is returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -934,11 +942,13 @@ def sample_list_chunks(): Returns: google.cloud.discoveryengine_v1alpha.services.chunk_service.pagers.ListChunksPager: Response message for - [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks] - method. + `ChunkService.ListChunks + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/chunk_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/chunk_service/transports/grpc.py index 46433ded4f84..d746bed4778c 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/chunk_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/chunk_service/transports/grpc.py @@ -113,8 +113,8 @@ class ChunkServiceGrpcTransport(ChunkServiceTransport): """gRPC backend transport for ChunkService. Service for displaying processed - [Chunk][google.cloud.discoveryengine.v1alpha.Chunk] information of - the customer's unstructured data. + `Chunk `__ + information of the customer's unstructured data. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -329,8 +329,8 @@ def grpc_channel(self) -> grpc.Channel: def get_chunk(self) -> Callable[[chunk_service.GetChunkRequest], chunk.Chunk]: r"""Return a callable for the get chunk method over gRPC. - Gets a - [Document][google.cloud.discoveryengine.v1alpha.Document]. + Gets a `Document + `__. Returns: Callable[[~.GetChunkRequest], @@ -356,8 +356,8 @@ def list_chunks( ) -> Callable[[chunk_service.ListChunksRequest], chunk_service.ListChunksResponse]: r"""Return a callable for the list chunks method over gRPC. - Gets a list of - [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s. + Gets a list of `Chunk + `__s. Returns: Callable[[~.ListChunksRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/chunk_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/chunk_service/transports/grpc_asyncio.py index 5698a2ab1916..3e57c836ec43 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/chunk_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/chunk_service/transports/grpc_asyncio.py @@ -119,8 +119,8 @@ class ChunkServiceGrpcAsyncIOTransport(ChunkServiceTransport): """gRPC AsyncIO backend transport for ChunkService. Service for displaying processed - [Chunk][google.cloud.discoveryengine.v1alpha.Chunk] information of - the customer's unstructured data. + `Chunk `__ + information of the customer's unstructured data. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -339,8 +339,8 @@ def get_chunk( ) -> Callable[[chunk_service.GetChunkRequest], Awaitable[chunk.Chunk]]: r"""Return a callable for the get chunk method over gRPC. - Gets a - [Document][google.cloud.discoveryengine.v1alpha.Document]. + Gets a `Document + `__. Returns: Callable[[~.GetChunkRequest], @@ -368,8 +368,8 @@ def list_chunks( ]: r"""Return a callable for the list chunks method over gRPC. - Gets a list of - [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s. + Gets a list of `Chunk + `__s. Returns: Callable[[~.ListChunksRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/chunk_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/chunk_service/transports/rest.py index 1a05ebd9eaeb..4a3d06d904c8 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/chunk_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/chunk_service/transports/rest.py @@ -273,8 +273,8 @@ class ChunkServiceRestTransport(_BaseChunkServiceRestTransport): """REST backend synchronous transport for ChunkService. Service for displaying processed - [Chunk][google.cloud.discoveryengine.v1alpha.Chunk] information of - the customer's unstructured data. + `Chunk `__ + information of the customer's unstructured data. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -390,7 +390,8 @@ def __call__( Args: request (~.chunk_service.GetChunkRequest): The request object. Request message for - [ChunkService.GetChunk][google.cloud.discoveryengine.v1alpha.ChunkService.GetChunk] + `ChunkService.GetChunk + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -543,7 +544,8 @@ def __call__( Args: request (~.chunk_service.ListChunksRequest): The request object. Request message for - [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks] + `ChunkService.ListChunks + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -556,7 +558,8 @@ def __call__( Returns: ~.chunk_service.ListChunksResponse: Response message for - [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks] + `ChunkService.ListChunks + `__ method. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/completion_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/completion_service/async_client.py index 664c2c4995ec..01915fb0a4f3 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/completion_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/completion_service/async_client.py @@ -340,7 +340,8 @@ async def sample_complete_query(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.CompleteQueryRequest, dict]]): The request object. Request message for - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery] + `CompletionService.CompleteQuery + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -353,8 +354,9 @@ async def sample_complete_query(): Returns: google.cloud.discoveryengine_v1alpha.types.CompleteQueryResponse: Response message for - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery] - method. + `CompletionService.CompleteQuery + `__ + method. """ # Create or coerce a protobuf request object. @@ -402,7 +404,8 @@ async def import_suggestion_deny_list_entries( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: r"""Imports all - [SuggestionDenyListEntry][google.cloud.discoveryengine.v1alpha.SuggestionDenyListEntry] + `SuggestionDenyListEntry + `__ for a DataStore. .. code-block:: python @@ -443,7 +446,8 @@ async def sample_import_suggestion_deny_list_entries(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.ImportSuggestionDenyListEntriesRequest, dict]]): The request object. Request message for - [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.ImportSuggestionDenyListEntries] + `CompletionService.ImportSuggestionDenyListEntries + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -455,11 +459,15 @@ async def sample_import_suggestion_deny_list_entries(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.ImportSuggestionDenyListEntriesResponse` Response message for - [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.ImportSuggestionDenyListEntries] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.ImportSuggestionDenyListEntriesResponse` + Response message for + `CompletionService.ImportSuggestionDenyListEntries + `__ + method. """ # Create or coerce a protobuf request object. @@ -515,7 +523,8 @@ async def purge_suggestion_deny_list_entries( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: r"""Permanently deletes all - [SuggestionDenyListEntry][google.cloud.discoveryengine.v1alpha.SuggestionDenyListEntry] + `SuggestionDenyListEntry + `__ for a DataStore. .. code-block:: python @@ -551,7 +560,8 @@ async def sample_purge_suggestion_deny_list_entries(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.PurgeSuggestionDenyListEntriesRequest, dict]]): The request object. Request message for - [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.PurgeSuggestionDenyListEntries] + `CompletionService.PurgeSuggestionDenyListEntries + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -563,11 +573,15 @@ async def sample_purge_suggestion_deny_list_entries(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.PurgeSuggestionDenyListEntriesResponse` Response message for - [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.PurgeSuggestionDenyListEntries] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.PurgeSuggestionDenyListEntriesResponse` + Response message for + `CompletionService.PurgeSuggestionDenyListEntries + `__ + method. """ # Create or coerce a protobuf request object. @@ -621,7 +635,8 @@ async def import_completion_suggestions( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: r"""Imports - [CompletionSuggestion][google.cloud.discoveryengine.v1alpha.CompletionSuggestion]s + `CompletionSuggestion + `__s for a DataStore. .. code-block:: python @@ -662,7 +677,8 @@ async def sample_import_completion_suggestions(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.ImportCompletionSuggestionsRequest, dict]]): The request object. Request message for - [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.ImportCompletionSuggestions] + `CompletionService.ImportCompletionSuggestions + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -674,14 +690,18 @@ async def sample_import_completion_suggestions(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.ImportCompletionSuggestionsResponse` Response of the - [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.ImportCompletionSuggestions] - method. If the long running operation is done, this - message is returned by the - google.longrunning.Operations.response field if the - operation is successful. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.ImportCompletionSuggestionsResponse` + Response of the + `CompletionService.ImportCompletionSuggestions + `__ + method. If the long running operation is + done, this message is returned by the + google.longrunning.Operations.response + field if the operation is successful. """ # Create or coerce a protobuf request object. @@ -735,7 +755,8 @@ async def purge_completion_suggestions( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: r"""Permanently deletes all - [CompletionSuggestion][google.cloud.discoveryengine.v1alpha.CompletionSuggestion]s + `CompletionSuggestion + `__s for a DataStore. .. code-block:: python @@ -771,7 +792,8 @@ async def sample_purge_completion_suggestions(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.PurgeCompletionSuggestionsRequest, dict]]): The request object. Request message for - [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.PurgeCompletionSuggestions] + `CompletionService.PurgeCompletionSuggestions + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -783,11 +805,15 @@ async def sample_purge_completion_suggestions(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.PurgeCompletionSuggestionsResponse` Response message for - [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.PurgeCompletionSuggestions] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.PurgeCompletionSuggestionsResponse` + Response message for + `CompletionService.PurgeCompletionSuggestions + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/completion_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/completion_service/client.py index 8b451d6f52f1..55cf6715a4f0 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/completion_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/completion_service/client.py @@ -764,7 +764,8 @@ def sample_complete_query(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.CompleteQueryRequest, dict]): The request object. Request message for - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery] + `CompletionService.CompleteQuery + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -777,8 +778,9 @@ def sample_complete_query(): Returns: google.cloud.discoveryengine_v1alpha.types.CompleteQueryResponse: Response message for - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery] - method. + `CompletionService.CompleteQuery + `__ + method. """ # Create or coerce a protobuf request object. @@ -824,7 +826,8 @@ def import_suggestion_deny_list_entries( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: r"""Imports all - [SuggestionDenyListEntry][google.cloud.discoveryengine.v1alpha.SuggestionDenyListEntry] + `SuggestionDenyListEntry + `__ for a DataStore. .. code-block:: python @@ -865,7 +868,8 @@ def sample_import_suggestion_deny_list_entries(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.ImportSuggestionDenyListEntriesRequest, dict]): The request object. Request message for - [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.ImportSuggestionDenyListEntries] + `CompletionService.ImportSuggestionDenyListEntries + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -877,11 +881,15 @@ def sample_import_suggestion_deny_list_entries(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.ImportSuggestionDenyListEntriesResponse` Response message for - [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.ImportSuggestionDenyListEntries] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.ImportSuggestionDenyListEntriesResponse` + Response message for + `CompletionService.ImportSuggestionDenyListEntries + `__ + method. """ # Create or coerce a protobuf request object. @@ -937,7 +945,8 @@ def purge_suggestion_deny_list_entries( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: r"""Permanently deletes all - [SuggestionDenyListEntry][google.cloud.discoveryengine.v1alpha.SuggestionDenyListEntry] + `SuggestionDenyListEntry + `__ for a DataStore. .. code-block:: python @@ -973,7 +982,8 @@ def sample_purge_suggestion_deny_list_entries(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.PurgeSuggestionDenyListEntriesRequest, dict]): The request object. Request message for - [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.PurgeSuggestionDenyListEntries] + `CompletionService.PurgeSuggestionDenyListEntries + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -985,11 +995,15 @@ def sample_purge_suggestion_deny_list_entries(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.PurgeSuggestionDenyListEntriesResponse` Response message for - [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.PurgeSuggestionDenyListEntries] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.PurgeSuggestionDenyListEntriesResponse` + Response message for + `CompletionService.PurgeSuggestionDenyListEntries + `__ + method. """ # Create or coerce a protobuf request object. @@ -1043,7 +1057,8 @@ def import_completion_suggestions( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: r"""Imports - [CompletionSuggestion][google.cloud.discoveryengine.v1alpha.CompletionSuggestion]s + `CompletionSuggestion + `__s for a DataStore. .. code-block:: python @@ -1084,7 +1099,8 @@ def sample_import_completion_suggestions(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.ImportCompletionSuggestionsRequest, dict]): The request object. Request message for - [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.ImportCompletionSuggestions] + `CompletionService.ImportCompletionSuggestions + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1096,14 +1112,18 @@ def sample_import_completion_suggestions(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.ImportCompletionSuggestionsResponse` Response of the - [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.ImportCompletionSuggestions] - method. If the long running operation is done, this - message is returned by the - google.longrunning.Operations.response field if the - operation is successful. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.ImportCompletionSuggestionsResponse` + Response of the + `CompletionService.ImportCompletionSuggestions + `__ + method. If the long running operation is + done, this message is returned by the + google.longrunning.Operations.response + field if the operation is successful. """ # Create or coerce a protobuf request object. @@ -1157,7 +1177,8 @@ def purge_completion_suggestions( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: r"""Permanently deletes all - [CompletionSuggestion][google.cloud.discoveryengine.v1alpha.CompletionSuggestion]s + `CompletionSuggestion + `__s for a DataStore. .. code-block:: python @@ -1193,7 +1214,8 @@ def sample_purge_completion_suggestions(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.PurgeCompletionSuggestionsRequest, dict]): The request object. Request message for - [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.PurgeCompletionSuggestions] + `CompletionService.PurgeCompletionSuggestions + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1205,11 +1227,15 @@ def sample_purge_completion_suggestions(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.PurgeCompletionSuggestionsResponse` Response message for - [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.PurgeCompletionSuggestions] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.PurgeCompletionSuggestionsResponse` + Response message for + `CompletionService.PurgeCompletionSuggestions + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/completion_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/completion_service/transports/grpc.py index e45e1cf97665..3b479c708e57 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/completion_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/completion_service/transports/grpc.py @@ -384,7 +384,8 @@ def import_suggestion_deny_list_entries( entries method over gRPC. Imports all - [SuggestionDenyListEntry][google.cloud.discoveryengine.v1alpha.SuggestionDenyListEntry] + `SuggestionDenyListEntry + `__ for a DataStore. Returns: @@ -417,7 +418,8 @@ def purge_suggestion_deny_list_entries( entries method over gRPC. Permanently deletes all - [SuggestionDenyListEntry][google.cloud.discoveryengine.v1alpha.SuggestionDenyListEntry] + `SuggestionDenyListEntry + `__ for a DataStore. Returns: @@ -449,7 +451,8 @@ def import_completion_suggestions( r"""Return a callable for the import completion suggestions method over gRPC. Imports - [CompletionSuggestion][google.cloud.discoveryengine.v1alpha.CompletionSuggestion]s + `CompletionSuggestion + `__s for a DataStore. Returns: @@ -481,7 +484,8 @@ def purge_completion_suggestions( r"""Return a callable for the purge completion suggestions method over gRPC. Permanently deletes all - [CompletionSuggestion][google.cloud.discoveryengine.v1alpha.CompletionSuggestion]s + `CompletionSuggestion + `__s for a DataStore. Returns: diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/completion_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/completion_service/transports/grpc_asyncio.py index 7959c031d026..868cc81b5f4f 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/completion_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/completion_service/transports/grpc_asyncio.py @@ -393,7 +393,8 @@ def import_suggestion_deny_list_entries( entries method over gRPC. Imports all - [SuggestionDenyListEntry][google.cloud.discoveryengine.v1alpha.SuggestionDenyListEntry] + `SuggestionDenyListEntry + `__ for a DataStore. Returns: @@ -427,7 +428,8 @@ def purge_suggestion_deny_list_entries( entries method over gRPC. Permanently deletes all - [SuggestionDenyListEntry][google.cloud.discoveryengine.v1alpha.SuggestionDenyListEntry] + `SuggestionDenyListEntry + `__ for a DataStore. Returns: @@ -460,7 +462,8 @@ def import_completion_suggestions( r"""Return a callable for the import completion suggestions method over gRPC. Imports - [CompletionSuggestion][google.cloud.discoveryengine.v1alpha.CompletionSuggestion]s + `CompletionSuggestion + `__s for a DataStore. Returns: @@ -493,7 +496,8 @@ def purge_completion_suggestions( r"""Return a callable for the purge completion suggestions method over gRPC. Permanently deletes all - [CompletionSuggestion][google.cloud.discoveryengine.v1alpha.CompletionSuggestion]s + `CompletionSuggestion + `__s for a DataStore. Returns: diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/completion_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/completion_service/transports/rest.py index da9b8ec81c86..1a5b9669b3f1 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/completion_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/completion_service/transports/rest.py @@ -747,7 +747,8 @@ def __call__( Args: request (~.completion_service.CompleteQueryRequest): The request object. Request message for - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery] + `CompletionService.CompleteQuery + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -760,7 +761,8 @@ def __call__( Returns: ~.completion_service.CompleteQueryResponse: Response message for - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery] + `CompletionService.CompleteQuery + `__ method. """ @@ -901,7 +903,8 @@ def __call__( Args: request (~.import_config.ImportCompletionSuggestionsRequest): The request object. Request message for - [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.ImportCompletionSuggestions] + `CompletionService.ImportCompletionSuggestions + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1063,7 +1066,8 @@ def __call__( Args: request (~.import_config.ImportSuggestionDenyListEntriesRequest): The request object. Request message for - [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.ImportSuggestionDenyListEntries] + `CompletionService.ImportSuggestionDenyListEntries + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1226,7 +1230,8 @@ def __call__( Args: request (~.purge_config.PurgeCompletionSuggestionsRequest): The request object. Request message for - [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.PurgeCompletionSuggestions] + `CompletionService.PurgeCompletionSuggestions + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1383,7 +1388,8 @@ def __call__( Args: request (~.purge_config.PurgeSuggestionDenyListEntriesRequest): The request object. Request message for - [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.PurgeSuggestionDenyListEntries] + `CompletionService.PurgeSuggestionDenyListEntries + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/control_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/control_service/async_client.py index e207dc52b9f7..5ab396583e53 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/control_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/control_service/async_client.py @@ -313,10 +313,12 @@ async def create_control( ) -> gcd_control.Control: r"""Creates a Control. - By default 1000 controls are allowed for a data store. A request - can be submitted to adjust this limit. If the - [Control][google.cloud.discoveryengine.v1alpha.Control] to - create already exists, an ALREADY_EXISTS error is returned. + By default 1000 controls are allowed for a data store. A + request can be submitted to adjust this limit. If the + `Control + `__ to + create already exists, an ALREADY_EXISTS error is + returned. .. code-block:: python @@ -357,8 +359,8 @@ async def sample_create_control(): request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.CreateControlRequest, dict]]): The request object. Request for CreateControl method. parent (:class:`str`): - Required. Full resource name of parent data store. - Format: + Required. Full resource name of parent + data store. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`` or ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}``. @@ -372,12 +374,13 @@ async def sample_create_control(): on the ``request`` instance; if ``request`` is provided, this should not be set. control_id (:class:`str`): - Required. The ID to use for the Control, which will - become the final component of the Control's resource - name. + Required. The ID to use for the Control, + which will become the final component of + the Control's resource name. - This value must be within 1-63 characters. Valid - characters are /[a-z][0-9]-\_/. + This value must be within 1-63 + characters. Valid characters are /`a-z + <0-9>`__-_/. This corresponds to the ``control_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -392,11 +395,13 @@ async def sample_create_control(): Returns: google.cloud.discoveryengine_v1alpha.types.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig] - to be considered at serving time. Permitted actions - dependent on SolutionType. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ # Create or coerce a protobuf request object. @@ -463,8 +468,9 @@ async def delete_control( ) -> None: r"""Deletes a Control. - If the [Control][google.cloud.discoveryengine.v1alpha.Control] - to delete does not exist, a NOT_FOUND error is returned. + If the `Control + `__ to + delete does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -493,8 +499,8 @@ async def sample_delete_control(): request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.DeleteControlRequest, dict]]): The request object. Request for DeleteControl method. name (:class:`str`): - Required. The resource name of the Control to delete. - Format: + Required. The resource name of the + Control to delete. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`` This corresponds to the ``name`` field @@ -566,9 +572,10 @@ async def update_control( ) -> gcd_control.Control: r"""Updates a Control. - [Control][google.cloud.discoveryengine.v1alpha.Control] action - type cannot be changed. If the - [Control][google.cloud.discoveryengine.v1alpha.Control] to + `Control + `__ action + type cannot be changed. If the `Control + `__ to update does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -613,14 +620,19 @@ async def sample_update_control(): on the ``request`` instance; if ``request`` is provided, this should not be set. update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - Optional. Indicates which fields in the provided - [Control][google.cloud.discoveryengine.v1alpha.Control] - to update. The following are NOT supported: + Optional. Indicates which fields in the + provided `Control + `__ + to update. The following are NOT + supported: - - [Control.name][google.cloud.discoveryengine.v1alpha.Control.name] - - [Control.solution_type][google.cloud.discoveryengine.v1alpha.Control.solution_type] + * `Control.name + `__ + * `Control.solution_type + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported + fields are updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -635,11 +647,13 @@ async def sample_update_control(): Returns: google.cloud.discoveryengine_v1alpha.types.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig] - to be considered at serving time. Permitted actions - dependent on SolutionType. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ # Create or coerce a protobuf request object. @@ -736,8 +750,8 @@ async def sample_get_control(): request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.GetControlRequest, dict]]): The request object. Request for GetControl method. name (:class:`str`): - Required. The resource name of the Control to get. - Format: + Required. The resource name of the + Control to get. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`` This corresponds to the ``name`` field @@ -753,11 +767,13 @@ async def sample_get_control(): Returns: google.cloud.discoveryengine_v1alpha.types.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig] - to be considered at serving time. Permitted actions - dependent on SolutionType. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ # Create or coerce a protobuf request object. @@ -819,7 +835,8 @@ async def list_controls( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListControlsAsyncPager: r"""Lists all Controls by their parent - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. + `DataStore + `__. .. code-block:: python @@ -852,7 +869,8 @@ async def sample_list_controls(): request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.ListControlsRequest, dict]]): The request object. Request for ListControls method. parent (:class:`str`): - Required. The data store resource name. Format: + Required. The data store resource name. + Format: ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`` or ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}``. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/control_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/control_service/client.py index b3f1a5a38e84..180fe81251d4 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/control_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/control_service/client.py @@ -758,10 +758,12 @@ def create_control( ) -> gcd_control.Control: r"""Creates a Control. - By default 1000 controls are allowed for a data store. A request - can be submitted to adjust this limit. If the - [Control][google.cloud.discoveryengine.v1alpha.Control] to - create already exists, an ALREADY_EXISTS error is returned. + By default 1000 controls are allowed for a data store. A + request can be submitted to adjust this limit. If the + `Control + `__ to + create already exists, an ALREADY_EXISTS error is + returned. .. code-block:: python @@ -802,8 +804,8 @@ def sample_create_control(): request (Union[google.cloud.discoveryengine_v1alpha.types.CreateControlRequest, dict]): The request object. Request for CreateControl method. parent (str): - Required. Full resource name of parent data store. - Format: + Required. Full resource name of parent + data store. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`` or ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}``. @@ -817,12 +819,13 @@ def sample_create_control(): on the ``request`` instance; if ``request`` is provided, this should not be set. control_id (str): - Required. The ID to use for the Control, which will - become the final component of the Control's resource - name. + Required. The ID to use for the Control, + which will become the final component of + the Control's resource name. - This value must be within 1-63 characters. Valid - characters are /[a-z][0-9]-\_/. + This value must be within 1-63 + characters. Valid characters are /`a-z + <0-9>`__-_/. This corresponds to the ``control_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -837,11 +840,13 @@ def sample_create_control(): Returns: google.cloud.discoveryengine_v1alpha.types.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig] - to be considered at serving time. Permitted actions - dependent on SolutionType. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ # Create or coerce a protobuf request object. @@ -905,8 +910,9 @@ def delete_control( ) -> None: r"""Deletes a Control. - If the [Control][google.cloud.discoveryengine.v1alpha.Control] - to delete does not exist, a NOT_FOUND error is returned. + If the `Control + `__ to + delete does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -935,8 +941,8 @@ def sample_delete_control(): request (Union[google.cloud.discoveryengine_v1alpha.types.DeleteControlRequest, dict]): The request object. Request for DeleteControl method. name (str): - Required. The resource name of the Control to delete. - Format: + Required. The resource name of the + Control to delete. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`` This corresponds to the ``name`` field @@ -1005,9 +1011,10 @@ def update_control( ) -> gcd_control.Control: r"""Updates a Control. - [Control][google.cloud.discoveryengine.v1alpha.Control] action - type cannot be changed. If the - [Control][google.cloud.discoveryengine.v1alpha.Control] to + `Control + `__ action + type cannot be changed. If the `Control + `__ to update does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -1052,14 +1059,19 @@ def sample_update_control(): on the ``request`` instance; if ``request`` is provided, this should not be set. update_mask (google.protobuf.field_mask_pb2.FieldMask): - Optional. Indicates which fields in the provided - [Control][google.cloud.discoveryengine.v1alpha.Control] - to update. The following are NOT supported: + Optional. Indicates which fields in the + provided `Control + `__ + to update. The following are NOT + supported: - - [Control.name][google.cloud.discoveryengine.v1alpha.Control.name] - - [Control.solution_type][google.cloud.discoveryengine.v1alpha.Control.solution_type] + * `Control.name + `__ + * `Control.solution_type + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported + fields are updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -1074,11 +1086,13 @@ def sample_update_control(): Returns: google.cloud.discoveryengine_v1alpha.types.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig] - to be considered at serving time. Permitted actions - dependent on SolutionType. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ # Create or coerce a protobuf request object. @@ -1172,8 +1186,8 @@ def sample_get_control(): request (Union[google.cloud.discoveryengine_v1alpha.types.GetControlRequest, dict]): The request object. Request for GetControl method. name (str): - Required. The resource name of the Control to get. - Format: + Required. The resource name of the + Control to get. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`` This corresponds to the ``name`` field @@ -1189,11 +1203,13 @@ def sample_get_control(): Returns: google.cloud.discoveryengine_v1alpha.types.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig] - to be considered at serving time. Permitted actions - dependent on SolutionType. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ # Create or coerce a protobuf request object. @@ -1252,7 +1268,8 @@ def list_controls( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListControlsPager: r"""Lists all Controls by their parent - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. + `DataStore + `__. .. code-block:: python @@ -1285,7 +1302,8 @@ def sample_list_controls(): request (Union[google.cloud.discoveryengine_v1alpha.types.ListControlsRequest, dict]): The request object. Request for ListControls method. parent (str): - Required. The data store resource name. Format: + Required. The data store resource name. + Format: ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`` or ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}``. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/control_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/control_service/transports/grpc.py index 62991007eaaa..edd78df49981 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/control_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/control_service/transports/grpc.py @@ -337,10 +337,12 @@ def create_control( Creates a Control. - By default 1000 controls are allowed for a data store. A request - can be submitted to adjust this limit. If the - [Control][google.cloud.discoveryengine.v1alpha.Control] to - create already exists, an ALREADY_EXISTS error is returned. + By default 1000 controls are allowed for a data store. A + request can be submitted to adjust this limit. If the + `Control + `__ to + create already exists, an ALREADY_EXISTS error is + returned. Returns: Callable[[~.CreateControlRequest], @@ -368,8 +370,9 @@ def delete_control( Deletes a Control. - If the [Control][google.cloud.discoveryengine.v1alpha.Control] - to delete does not exist, a NOT_FOUND error is returned. + If the `Control + `__ to + delete does not exist, a NOT_FOUND error is returned. Returns: Callable[[~.DeleteControlRequest], @@ -397,9 +400,10 @@ def update_control( Updates a Control. - [Control][google.cloud.discoveryengine.v1alpha.Control] action - type cannot be changed. If the - [Control][google.cloud.discoveryengine.v1alpha.Control] to + `Control + `__ action + type cannot be changed. If the `Control + `__ to update does not exist, a NOT_FOUND error is returned. Returns: @@ -455,7 +459,8 @@ def list_controls( r"""Return a callable for the list controls method over gRPC. Lists all Controls by their parent - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. + `DataStore + `__. Returns: Callable[[~.ListControlsRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/control_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/control_service/transports/grpc_asyncio.py index d7c20e6d8b90..a9db0023ee78 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/control_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/control_service/transports/grpc_asyncio.py @@ -347,10 +347,12 @@ def create_control( Creates a Control. - By default 1000 controls are allowed for a data store. A request - can be submitted to adjust this limit. If the - [Control][google.cloud.discoveryengine.v1alpha.Control] to - create already exists, an ALREADY_EXISTS error is returned. + By default 1000 controls are allowed for a data store. A + request can be submitted to adjust this limit. If the + `Control + `__ to + create already exists, an ALREADY_EXISTS error is + returned. Returns: Callable[[~.CreateControlRequest], @@ -378,8 +380,9 @@ def delete_control( Deletes a Control. - If the [Control][google.cloud.discoveryengine.v1alpha.Control] - to delete does not exist, a NOT_FOUND error is returned. + If the `Control + `__ to + delete does not exist, a NOT_FOUND error is returned. Returns: Callable[[~.DeleteControlRequest], @@ -409,9 +412,10 @@ def update_control( Updates a Control. - [Control][google.cloud.discoveryengine.v1alpha.Control] action - type cannot be changed. If the - [Control][google.cloud.discoveryengine.v1alpha.Control] to + `Control + `__ action + type cannot be changed. If the `Control + `__ to update does not exist, a NOT_FOUND error is returned. Returns: @@ -468,7 +472,8 @@ def list_controls( r"""Return a callable for the list controls method over gRPC. Lists all Controls by their parent - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. + `DataStore + `__. Returns: Callable[[~.ListControlsRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/control_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/control_service/transports/rest.py index 11b7c06ce997..d05046932f2f 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/control_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/control_service/transports/rest.py @@ -537,11 +537,13 @@ def __call__( Returns: ~.gcd_control.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig] - to be considered at serving time. Permitted actions - dependent on ``SolutionType``. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ @@ -797,11 +799,13 @@ def __call__( Returns: ~.control.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig] - to be considered at serving time. Permitted actions - dependent on ``SolutionType``. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ @@ -1095,11 +1099,13 @@ def __call__( Returns: ~.gcd_control.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig] - to be considered at serving time. Permitted actions - dependent on ``SolutionType``. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/conversational_search_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/conversational_search_service/async_client.py index 5a0ed037092d..60a74006d7f1 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/conversational_search_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/conversational_search_service/async_client.py @@ -385,17 +385,18 @@ async def sample_converse_conversation(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.ConverseConversationRequest, dict]]): The request object. Request message for - [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.ConverseConversation] + `ConversationalSearchService.ConverseConversation + `__ method. name (:class:`str`): - Required. The resource name of the Conversation to get. - Format: + Required. The resource name of the + Conversation to get. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}``. Use ``projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-`` - to activate auto session mode, which automatically - creates a new conversation inside a ConverseConversation - session. + to activate auto session mode, which + automatically creates a new conversation + inside a ConverseConversation session. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -416,8 +417,9 @@ async def sample_converse_conversation(): Returns: google.cloud.discoveryengine_v1alpha.types.ConverseConversationResponse: Response message for - [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.ConverseConversation] - method. + `ConversationalSearchService.ConverseConversation + `__ + method. """ # Create or coerce a protobuf request object. @@ -487,9 +489,10 @@ async def create_conversation( ) -> gcd_conversation.Conversation: r"""Creates a Conversation. - If the - [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] - to create already exists, an ALREADY_EXISTS error is returned. + If the `Conversation + `__ + to create already exists, an ALREADY_EXISTS error is + returned. .. code-block:: python @@ -522,8 +525,8 @@ async def sample_create_conversation(): The request object. Request for CreateConversation method. parent (:class:`str`): - Required. Full resource name of parent data store. - Format: + Required. Full resource name of parent + data store. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field @@ -614,8 +617,8 @@ async def delete_conversation( ) -> None: r"""Deletes a Conversation. - If the - [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] + If the `Conversation + `__ to delete does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -646,8 +649,8 @@ async def sample_delete_conversation(): The request object. Request for DeleteConversation method. name (:class:`str`): - Required. The resource name of the Conversation to - delete. Format: + Required. The resource name of the + Conversation to delete. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`` This corresponds to the ``name`` field @@ -723,9 +726,11 @@ async def update_conversation( ) -> gcd_conversation.Conversation: r"""Updates a Conversation. - [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] + `Conversation + `__ action type cannot be changed. If the - [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] + `Conversation + `__ to update does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -764,12 +769,16 @@ async def sample_update_conversation(): should not be set. update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): Indicates which fields in the provided - [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] - to update. The following are NOT supported: + `Conversation + `__ + to update. The following are NOT + supported: - - [Conversation.name][google.cloud.discoveryengine.v1alpha.Conversation.name] + * `Conversation.name + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported + fields are updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -886,8 +895,8 @@ async def sample_get_conversation(): request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.GetConversationRequest, dict]]): The request object. Request for GetConversation method. name (:class:`str`): - Required. The resource name of the Conversation to get. - Format: + Required. The resource name of the + Conversation to get. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`` This corresponds to the ``name`` field @@ -970,7 +979,8 @@ async def list_conversations( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListConversationsAsyncPager: r"""Lists all Conversations by their parent - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. + `DataStore + `__. .. code-block:: python @@ -1003,7 +1013,8 @@ async def sample_list_conversations(): request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.ListConversationsRequest, dict]]): The request object. Request for ListConversations method. parent (:class:`str`): - Required. The data store resource name. Format: + Required. The data store resource name. + Format: ``projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field @@ -1133,7 +1144,8 @@ async def sample_answer_query(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.AnswerQueryRequest, dict]]): The request object. Request message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.AnswerQuery] + `ConversationalSearchService.AnswerQuery + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -1146,8 +1158,9 @@ async def sample_answer_query(): Returns: google.cloud.discoveryengine_v1alpha.types.AnswerQueryResponse: Response message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.AnswerQuery] - method. + `ConversationalSearchService.AnswerQuery + `__ + method. """ # Create or coerce a protobuf request object. @@ -1227,8 +1240,8 @@ async def sample_get_answer(): request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.GetAnswerRequest, dict]]): The request object. Request for GetAnswer method. name (:class:`str`): - Required. The resource name of the Answer to get. - Format: + Required. The resource name of the + Answer to get. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`` This corresponds to the ``name`` field @@ -1309,8 +1322,10 @@ async def create_session( ) -> gcd_session.Session: r"""Creates a Session. - If the [Session][google.cloud.discoveryengine.v1alpha.Session] - to create already exists, an ALREADY_EXISTS error is returned. + If the `Session + `__ to + create already exists, an ALREADY_EXISTS error is + returned. .. code-block:: python @@ -1342,8 +1357,8 @@ async def sample_create_session(): request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.CreateSessionRequest, dict]]): The request object. Request for CreateSession method. parent (:class:`str`): - Required. Full resource name of parent data store. - Format: + Required. Full resource name of parent + data store. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field @@ -1430,8 +1445,9 @@ async def delete_session( ) -> None: r"""Deletes a Session. - If the [Session][google.cloud.discoveryengine.v1alpha.Session] - to delete does not exist, a NOT_FOUND error is returned. + If the `Session + `__ to + delete does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -1460,8 +1476,8 @@ async def sample_delete_session(): request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.DeleteSessionRequest, dict]]): The request object. Request for DeleteSession method. name (:class:`str`): - Required. The resource name of the Session to delete. - Format: + Required. The resource name of the + Session to delete. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` This corresponds to the ``name`` field @@ -1535,9 +1551,10 @@ async def update_session( ) -> gcd_session.Session: r"""Updates a Session. - [Session][google.cloud.discoveryengine.v1alpha.Session] action - type cannot be changed. If the - [Session][google.cloud.discoveryengine.v1alpha.Session] to + `Session + `__ action + type cannot be changed. If the `Session + `__ to update does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -1575,12 +1592,16 @@ async def sample_update_session(): should not be set. update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): Indicates which fields in the provided - [Session][google.cloud.discoveryengine.v1alpha.Session] - to update. The following are NOT supported: + `Session + `__ + to update. The following are NOT + supported: - - [Session.name][google.cloud.discoveryengine.v1alpha.Session.name] + * `Session.name + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported + fields are updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -1693,8 +1714,8 @@ async def sample_get_session(): request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.GetSessionRequest, dict]]): The request object. Request for GetSession method. name (:class:`str`): - Required. The resource name of the Session to get. - Format: + Required. The resource name of the + Session to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` This corresponds to the ``name`` field @@ -1773,7 +1794,8 @@ async def list_sessions( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListSessionsAsyncPager: r"""Lists all Sessions by their parent - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. + `DataStore + `__. .. code-block:: python @@ -1806,7 +1828,8 @@ async def sample_list_sessions(): request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.ListSessionsRequest, dict]]): The request object. Request for ListSessions method. parent (:class:`str`): - Required. The data store resource name. Format: + Required. The data store resource name. + Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/conversational_search_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/conversational_search_service/client.py index b2176d642e37..5c8214af3ca8 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/conversational_search_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/conversational_search_service/client.py @@ -935,17 +935,18 @@ def sample_converse_conversation(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.ConverseConversationRequest, dict]): The request object. Request message for - [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.ConverseConversation] + `ConversationalSearchService.ConverseConversation + `__ method. name (str): - Required. The resource name of the Conversation to get. - Format: + Required. The resource name of the + Conversation to get. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}``. Use ``projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-`` - to activate auto session mode, which automatically - creates a new conversation inside a ConverseConversation - session. + to activate auto session mode, which + automatically creates a new conversation + inside a ConverseConversation session. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -966,8 +967,9 @@ def sample_converse_conversation(): Returns: google.cloud.discoveryengine_v1alpha.types.ConverseConversationResponse: Response message for - [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.ConverseConversation] - method. + `ConversationalSearchService.ConverseConversation + `__ + method. """ # Create or coerce a protobuf request object. @@ -1034,9 +1036,10 @@ def create_conversation( ) -> gcd_conversation.Conversation: r"""Creates a Conversation. - If the - [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] - to create already exists, an ALREADY_EXISTS error is returned. + If the `Conversation + `__ + to create already exists, an ALREADY_EXISTS error is + returned. .. code-block:: python @@ -1069,8 +1072,8 @@ def sample_create_conversation(): The request object. Request for CreateConversation method. parent (str): - Required. Full resource name of parent data store. - Format: + Required. Full resource name of parent + data store. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field @@ -1158,8 +1161,8 @@ def delete_conversation( ) -> None: r"""Deletes a Conversation. - If the - [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] + If the `Conversation + `__ to delete does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -1190,8 +1193,8 @@ def sample_delete_conversation(): The request object. Request for DeleteConversation method. name (str): - Required. The resource name of the Conversation to - delete. Format: + Required. The resource name of the + Conversation to delete. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`` This corresponds to the ``name`` field @@ -1264,9 +1267,11 @@ def update_conversation( ) -> gcd_conversation.Conversation: r"""Updates a Conversation. - [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] + `Conversation + `__ action type cannot be changed. If the - [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] + `Conversation + `__ to update does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -1305,12 +1310,16 @@ def sample_update_conversation(): should not be set. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] - to update. The following are NOT supported: + `Conversation + `__ + to update. The following are NOT + supported: - - [Conversation.name][google.cloud.discoveryengine.v1alpha.Conversation.name] + * `Conversation.name + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported + fields are updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -1424,8 +1433,8 @@ def sample_get_conversation(): request (Union[google.cloud.discoveryengine_v1alpha.types.GetConversationRequest, dict]): The request object. Request for GetConversation method. name (str): - Required. The resource name of the Conversation to get. - Format: + Required. The resource name of the + Conversation to get. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`` This corresponds to the ``name`` field @@ -1505,7 +1514,8 @@ def list_conversations( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListConversationsPager: r"""Lists all Conversations by their parent - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. + `DataStore + `__. .. code-block:: python @@ -1538,7 +1548,8 @@ def sample_list_conversations(): request (Union[google.cloud.discoveryengine_v1alpha.types.ListConversationsRequest, dict]): The request object. Request for ListConversations method. parent (str): - Required. The data store resource name. Format: + Required. The data store resource name. + Format: ``projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field @@ -1665,7 +1676,8 @@ def sample_answer_query(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.AnswerQueryRequest, dict]): The request object. Request message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.AnswerQuery] + `ConversationalSearchService.AnswerQuery + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1678,8 +1690,9 @@ def sample_answer_query(): Returns: google.cloud.discoveryengine_v1alpha.types.AnswerQueryResponse: Response message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.AnswerQuery] - method. + `ConversationalSearchService.AnswerQuery + `__ + method. """ # Create or coerce a protobuf request object. @@ -1757,8 +1770,8 @@ def sample_get_answer(): request (Union[google.cloud.discoveryengine_v1alpha.types.GetAnswerRequest, dict]): The request object. Request for GetAnswer method. name (str): - Required. The resource name of the Answer to get. - Format: + Required. The resource name of the + Answer to get. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`` This corresponds to the ``name`` field @@ -1836,8 +1849,10 @@ def create_session( ) -> gcd_session.Session: r"""Creates a Session. - If the [Session][google.cloud.discoveryengine.v1alpha.Session] - to create already exists, an ALREADY_EXISTS error is returned. + If the `Session + `__ to + create already exists, an ALREADY_EXISTS error is + returned. .. code-block:: python @@ -1869,8 +1884,8 @@ def sample_create_session(): request (Union[google.cloud.discoveryengine_v1alpha.types.CreateSessionRequest, dict]): The request object. Request for CreateSession method. parent (str): - Required. Full resource name of parent data store. - Format: + Required. Full resource name of parent + data store. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field @@ -1954,8 +1969,9 @@ def delete_session( ) -> None: r"""Deletes a Session. - If the [Session][google.cloud.discoveryengine.v1alpha.Session] - to delete does not exist, a NOT_FOUND error is returned. + If the `Session + `__ to + delete does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -1984,8 +2000,8 @@ def sample_delete_session(): request (Union[google.cloud.discoveryengine_v1alpha.types.DeleteSessionRequest, dict]): The request object. Request for DeleteSession method. name (str): - Required. The resource name of the Session to delete. - Format: + Required. The resource name of the + Session to delete. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` This corresponds to the ``name`` field @@ -2056,9 +2072,10 @@ def update_session( ) -> gcd_session.Session: r"""Updates a Session. - [Session][google.cloud.discoveryengine.v1alpha.Session] action - type cannot be changed. If the - [Session][google.cloud.discoveryengine.v1alpha.Session] to + `Session + `__ action + type cannot be changed. If the `Session + `__ to update does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -2096,12 +2113,16 @@ def sample_update_session(): should not be set. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [Session][google.cloud.discoveryengine.v1alpha.Session] - to update. The following are NOT supported: + `Session + `__ + to update. The following are NOT + supported: - - [Session.name][google.cloud.discoveryengine.v1alpha.Session.name] + * `Session.name + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported + fields are updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -2211,8 +2232,8 @@ def sample_get_session(): request (Union[google.cloud.discoveryengine_v1alpha.types.GetSessionRequest, dict]): The request object. Request for GetSession method. name (str): - Required. The resource name of the Session to get. - Format: + Required. The resource name of the + Session to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` This corresponds to the ``name`` field @@ -2288,7 +2309,8 @@ def list_sessions( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListSessionsPager: r"""Lists all Sessions by their parent - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. + `DataStore + `__. .. code-block:: python @@ -2321,7 +2343,8 @@ def sample_list_sessions(): request (Union[google.cloud.discoveryengine_v1alpha.types.ListSessionsRequest, dict]): The request object. Request for ListSessions method. parent (str): - Required. The data store resource name. Format: + Required. The data store resource name. + Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/conversational_search_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/conversational_search_service/transports/grpc.py index dfef0082e569..78ecdffdbcb6 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/conversational_search_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/conversational_search_service/transports/grpc.py @@ -369,9 +369,10 @@ def create_conversation( Creates a Conversation. - If the - [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] - to create already exists, an ALREADY_EXISTS error is returned. + If the `Conversation + `__ + to create already exists, an ALREADY_EXISTS error is + returned. Returns: Callable[[~.CreateConversationRequest], @@ -401,8 +402,8 @@ def delete_conversation( Deletes a Conversation. - If the - [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] + If the `Conversation + `__ to delete does not exist, a NOT_FOUND error is returned. Returns: @@ -434,9 +435,11 @@ def update_conversation( Updates a Conversation. - [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] + `Conversation + `__ action type cannot be changed. If the - [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] + `Conversation + `__ to update does not exist, a NOT_FOUND error is returned. Returns: @@ -496,7 +499,8 @@ def list_conversations( r"""Return a callable for the list conversations method over gRPC. Lists all Conversations by their parent - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. + `DataStore + `__. Returns: Callable[[~.ListConversationsRequest], @@ -581,8 +585,10 @@ def create_session( Creates a Session. - If the [Session][google.cloud.discoveryengine.v1alpha.Session] - to create already exists, an ALREADY_EXISTS error is returned. + If the `Session + `__ to + create already exists, an ALREADY_EXISTS error is + returned. Returns: Callable[[~.CreateSessionRequest], @@ -612,8 +618,9 @@ def delete_session( Deletes a Session. - If the [Session][google.cloud.discoveryengine.v1alpha.Session] - to delete does not exist, a NOT_FOUND error is returned. + If the `Session + `__ to + delete does not exist, a NOT_FOUND error is returned. Returns: Callable[[~.DeleteSessionRequest], @@ -643,9 +650,10 @@ def update_session( Updates a Session. - [Session][google.cloud.discoveryengine.v1alpha.Session] action - type cannot be changed. If the - [Session][google.cloud.discoveryengine.v1alpha.Session] to + `Session + `__ action + type cannot be changed. If the `Session + `__ to update does not exist, a NOT_FOUND error is returned. Returns: @@ -702,7 +710,8 @@ def list_sessions( r"""Return a callable for the list sessions method over gRPC. Lists all Sessions by their parent - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. + `DataStore + `__. Returns: Callable[[~.ListSessionsRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/conversational_search_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/conversational_search_service/transports/grpc_asyncio.py index d7ce30c63f09..bd8c728684db 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/conversational_search_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/conversational_search_service/transports/grpc_asyncio.py @@ -379,9 +379,10 @@ def create_conversation( Creates a Conversation. - If the - [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] - to create already exists, an ALREADY_EXISTS error is returned. + If the `Conversation + `__ + to create already exists, an ALREADY_EXISTS error is + returned. Returns: Callable[[~.CreateConversationRequest], @@ -412,8 +413,8 @@ def delete_conversation( Deletes a Conversation. - If the - [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] + If the `Conversation + `__ to delete does not exist, a NOT_FOUND error is returned. Returns: @@ -445,9 +446,11 @@ def update_conversation( Updates a Conversation. - [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] + `Conversation + `__ action type cannot be changed. If the - [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] + `Conversation + `__ to update does not exist, a NOT_FOUND error is returned. Returns: @@ -507,7 +510,8 @@ def list_conversations( r"""Return a callable for the list conversations method over gRPC. Lists all Conversations by their parent - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. + `DataStore + `__. Returns: Callable[[~.ListConversationsRequest], @@ -595,8 +599,10 @@ def create_session( Creates a Session. - If the [Session][google.cloud.discoveryengine.v1alpha.Session] - to create already exists, an ALREADY_EXISTS error is returned. + If the `Session + `__ to + create already exists, an ALREADY_EXISTS error is + returned. Returns: Callable[[~.CreateSessionRequest], @@ -626,8 +632,9 @@ def delete_session( Deletes a Session. - If the [Session][google.cloud.discoveryengine.v1alpha.Session] - to delete does not exist, a NOT_FOUND error is returned. + If the `Session + `__ to + delete does not exist, a NOT_FOUND error is returned. Returns: Callable[[~.DeleteSessionRequest], @@ -658,9 +665,10 @@ def update_session( Updates a Session. - [Session][google.cloud.discoveryengine.v1alpha.Session] action - type cannot be changed. If the - [Session][google.cloud.discoveryengine.v1alpha.Session] to + `Session + `__ action + type cannot be changed. If the `Session + `__ to update does not exist, a NOT_FOUND error is returned. Returns: @@ -719,7 +727,8 @@ def list_sessions( r"""Return a callable for the list sessions method over gRPC. Lists all Sessions by their parent - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. + `DataStore + `__. Returns: Callable[[~.ListSessionsRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/conversational_search_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/conversational_search_service/transports/rest.py index 95bdbd1bbd07..6ebe8a665dfb 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/conversational_search_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/conversational_search_service/transports/rest.py @@ -959,7 +959,8 @@ def __call__( Args: request (~.conversational_search_service.AnswerQueryRequest): The request object. Request message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.AnswerQuery] + `ConversationalSearchService.AnswerQuery + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -972,7 +973,8 @@ def __call__( Returns: ~.conversational_search_service.AnswerQueryResponse: Response message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.AnswerQuery] + `ConversationalSearchService.AnswerQuery + `__ method. """ @@ -1121,7 +1123,8 @@ def __call__( Args: request (~.conversational_search_service.ConverseConversationRequest): The request object. Request message for - [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.ConverseConversation] + `ConversationalSearchService.ConverseConversation + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1134,7 +1137,8 @@ def __call__( Returns: ~.conversational_search_service.ConverseConversationResponse: Response message for - [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.ConverseConversation] + `ConversationalSearchService.ConverseConversation + `__ method. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/data_store_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/data_store_service/async_client.py index f7fe424c9fb2..f154c2fafd34 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/data_store_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/data_store_service/async_client.py @@ -79,7 +79,7 @@ class DataStoreServiceAsyncClient: """Service for managing - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] + `DataStore `__ configuration. """ @@ -331,14 +331,15 @@ async def create_data_store( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Creates a - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. - + r"""Creates a `DataStore + `__. DataStore is for storing - [Documents][google.cloud.discoveryengine.v1alpha.Document]. To - serve these documents for Search, or Recommendation use case, an - [Engine][google.cloud.discoveryengine.v1alpha.Engine] needs to - be created separately. + `Documents + `__. To + serve these documents for Search, or Recommendation use + case, an `Engine + `__ needs + to be created separately. .. code-block:: python @@ -378,18 +379,20 @@ async def sample_create_data_store(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.CreateDataStoreRequest, dict]]): The request object. Request for - [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.CreateDataStore] + `DataStoreService.CreateDataStore + `__ method. parent (:class:`str`): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. data_store (:class:`google.cloud.discoveryengine_v1alpha.types.DataStore`): - Required. The - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] + Required. The `DataStore + `__ to create. This corresponds to the ``data_store`` field @@ -397,15 +400,19 @@ async def sample_create_data_store(): should not be set. data_store_id (:class:`str`): Required. The ID to use for the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], - which will become the final component of the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]'s + `DataStore + `__, + which will become the final component of + the + `DataStore + `__'s resource name. - This field must conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. - Otherwise, an INVALID_ARGUMENT error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 + characters. Otherwise, an + INVALID_ARGUMENT error is returned. This corresponds to the ``data_store_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -420,12 +427,13 @@ async def sample_create_data_store(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1alpha.types.DataStore` - DataStore captures global settings and configs at the - DataStore level. + DataStore captures global settings and + configs at the DataStore level. """ # Create or coerce a protobuf request object. @@ -498,8 +506,8 @@ async def get_data_store( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> data_store.DataStore: - r"""Gets a - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. + r"""Gets a `DataStore + `__. .. code-block:: python @@ -530,22 +538,27 @@ async def sample_get_data_store(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.GetDataStoreRequest, dict]]): The request object. Request message for - [DataStoreService.GetDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.GetDataStore] + `DataStoreService.GetDataStore + `__ method. name (:class:`str`): Required. Full resource name of - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], + `DataStore + `__, such as ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. - If the caller does not have permission to access the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `DataStore + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. If the requested - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] - does not exist, a NOT_FOUND error is returned. + `DataStore + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -622,8 +635,8 @@ async def list_data_stores( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListDataStoresAsyncPager: - r"""Lists all the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s + r"""Lists all the `DataStore + `__s associated with the project. .. code-block:: python @@ -656,17 +669,20 @@ async def sample_list_data_stores(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.ListDataStoresRequest, dict]]): The request object. Request message for - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores] + `DataStoreService.ListDataStores + `__ method. parent (:class:`str`): - Required. The parent branch resource name, such as + Required. The parent branch resource + name, such as ``projects/{project}/locations/{location}/collections/{collection_id}``. - If the caller does not have permission to list - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s - under this location, regardless of whether or not this - data store exists, a PERMISSION_DENIED error is - returned. + If the caller does not have permission + to list `DataStore + `__s + under this location, regardless of + whether or not this data store exists, a + PERMISSION_DENIED error is returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -682,11 +698,13 @@ async def sample_list_data_stores(): Returns: google.cloud.discoveryengine_v1alpha.services.data_store_service.pagers.ListDataStoresAsyncPager: Response message for - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores] - method. + `DataStoreService.ListDataStores + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -760,8 +778,8 @@ async def delete_data_store( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Deletes a - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. + r"""Deletes a `DataStore + `__. .. code-block:: python @@ -796,22 +814,26 @@ async def sample_delete_data_store(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.DeleteDataStoreRequest, dict]]): The request object. Request message for - [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.DeleteDataStore] + `DataStoreService.DeleteDataStore + `__ method. name (:class:`str`): Required. Full resource name of - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], + `DataStore + `__, such as ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. - If the caller does not have permission to delete the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to delete the `DataStore + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] - to delete does not exist, a NOT_FOUND error is returned. + If the `DataStore + `__ + to delete does not exist, a NOT_FOUND + error is returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -826,18 +848,21 @@ async def sample_delete_data_store(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. @@ -909,8 +934,8 @@ async def update_data_store( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_data_store.DataStore: - r"""Updates a - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] + r"""Updates a `DataStore + `__ .. code-block:: python @@ -944,32 +969,37 @@ async def sample_update_data_store(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.UpdateDataStoreRequest, dict]]): The request object. Request message for - [DataStoreService.UpdateDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateDataStore] + `DataStoreService.UpdateDataStore + `__ method. data_store (:class:`google.cloud.discoveryengine_v1alpha.types.DataStore`): - Required. The - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] + Required. The `DataStore + `__ to update. - If the caller does not have permission to update the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to update the `DataStore + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] - to update does not exist, a NOT_FOUND error is returned. + If the `DataStore + `__ + to update does not exist, a NOT_FOUND + error is returned. This corresponds to the ``data_store`` field on the ``request`` instance; if ``request`` is provided, this should not be set. update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): Indicates which fields in the provided - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] + `DataStore + `__ to update. - If an unsupported or unknown field is provided, an - INVALID_ARGUMENT error is returned. + If an unsupported or unknown field is + provided, an INVALID_ARGUMENT error is + returned. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -1053,7 +1083,8 @@ async def get_document_processing_config( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> document_processing_config.DocumentProcessingConfig: r"""Gets a - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig]. + `DocumentProcessingConfig + `__. .. code-block:: python @@ -1084,11 +1115,12 @@ async def sample_get_document_processing_config(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.GetDocumentProcessingConfigRequest, dict]]): The request object. Request for - [DataStoreService.GetDocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DataStoreService.GetDocumentProcessingConfig] + `DataStoreService.GetDocumentProcessingConfig + `__ method. name (:class:`str`): - Required. Full DocumentProcessingConfig resource name. - Format: + Required. Full DocumentProcessingConfig + resource name. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig`` This corresponds to the ``name`` field @@ -1105,13 +1137,15 @@ async def sample_get_document_processing_config(): Returns: google.cloud.discoveryengine_v1alpha.types.DocumentProcessingConfig: A singleton resource of - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. - It's empty when - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] - is created, which defaults to digital parser. The - first call to - [DataStoreService.UpdateDocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateDocumentProcessingConfig] - method will initialize the config. + `DataStore + `__. + It's empty when `DataStore + `__ + is created, which defaults to digital + parser. The first call to + `DataStoreService.UpdateDocumentProcessingConfig + `__ + method will initialize the config. """ # Create or coerce a protobuf request object. @@ -1180,14 +1214,18 @@ async def update_document_processing_config( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_document_processing_config.DocumentProcessingConfig: r"""Updates the - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig]. - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig] + `DocumentProcessingConfig + `__. + `DocumentProcessingConfig + `__ is a singleon resource of - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. - It's empty when - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] is + `DataStore + `__. + It's empty when `DataStore + `__ is created. The first call to this method will set up - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig]. + `DocumentProcessingConfig + `__. .. code-block:: python @@ -1217,32 +1255,42 @@ async def sample_update_document_processing_config(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.UpdateDocumentProcessingConfigRequest, dict]]): The request object. Request for - [DataStoreService.UpdateDocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateDocumentProcessingConfig] + `DataStoreService.UpdateDocumentProcessingConfig + `__ method. document_processing_config (:class:`google.cloud.discoveryengine_v1alpha.types.DocumentProcessingConfig`): Required. The - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig] + `DocumentProcessingConfig + `__ to update. - If the caller does not have permission to update the - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig], - then a PERMISSION_DENIED error is returned. + If the caller does not have permission + to update the `DocumentProcessingConfig + `__, + then a PERMISSION_DENIED error is + returned. If the - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig] - to update does not exist, a NOT_FOUND error is returned. + `DocumentProcessingConfig + `__ + to update does not exist, a NOT_FOUND + error is returned. This corresponds to the ``document_processing_config`` field on the ``request`` instance; if ``request`` is provided, this should not be set. update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): Indicates which fields in the provided - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig] - to update. The following are the only supported fields: + `DocumentProcessingConfig + `__ + to update. The following are the only + supported fields: - - [DocumentProcessingConfig.ocr_config][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ocr_config] + * `DocumentProcessingConfig.ocr_config + `__ - If not set, all supported fields are updated. + If not set, all supported fields are + updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -1258,13 +1306,15 @@ async def sample_update_document_processing_config(): Returns: google.cloud.discoveryengine_v1alpha.types.DocumentProcessingConfig: A singleton resource of - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. - It's empty when - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] - is created, which defaults to digital parser. The - first call to - [DataStoreService.UpdateDocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateDocumentProcessingConfig] - method will initialize the config. + `DataStore + `__. + It's empty when `DataStore + `__ + is created, which defaults to digital + parser. The first call to + `DataStoreService.UpdateDocumentProcessingConfig + `__ + method will initialize the config. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/data_store_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/data_store_service/client.py index 5745c9ac53d2..e17d53624af2 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/data_store_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/data_store_service/client.py @@ -125,7 +125,7 @@ def get_transport_class( class DataStoreServiceClient(metaclass=DataStoreServiceClientMeta): """Service for managing - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] + `DataStore `__ configuration. """ @@ -815,14 +815,15 @@ def create_data_store( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Creates a - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. - + r"""Creates a `DataStore + `__. DataStore is for storing - [Documents][google.cloud.discoveryengine.v1alpha.Document]. To - serve these documents for Search, or Recommendation use case, an - [Engine][google.cloud.discoveryengine.v1alpha.Engine] needs to - be created separately. + `Documents + `__. To + serve these documents for Search, or Recommendation use + case, an `Engine + `__ needs + to be created separately. .. code-block:: python @@ -862,18 +863,20 @@ def sample_create_data_store(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.CreateDataStoreRequest, dict]): The request object. Request for - [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.CreateDataStore] + `DataStoreService.CreateDataStore + `__ method. parent (str): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. data_store (google.cloud.discoveryengine_v1alpha.types.DataStore): - Required. The - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] + Required. The `DataStore + `__ to create. This corresponds to the ``data_store`` field @@ -881,15 +884,19 @@ def sample_create_data_store(): should not be set. data_store_id (str): Required. The ID to use for the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], - which will become the final component of the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]'s + `DataStore + `__, + which will become the final component of + the + `DataStore + `__'s resource name. - This field must conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. - Otherwise, an INVALID_ARGUMENT error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 + characters. Otherwise, an + INVALID_ARGUMENT error is returned. This corresponds to the ``data_store_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -904,12 +911,13 @@ def sample_create_data_store(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1alpha.types.DataStore` - DataStore captures global settings and configs at the - DataStore level. + DataStore captures global settings and + configs at the DataStore level. """ # Create or coerce a protobuf request object. @@ -979,8 +987,8 @@ def get_data_store( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> data_store.DataStore: - r"""Gets a - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. + r"""Gets a `DataStore + `__. .. code-block:: python @@ -1011,22 +1019,27 @@ def sample_get_data_store(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.GetDataStoreRequest, dict]): The request object. Request message for - [DataStoreService.GetDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.GetDataStore] + `DataStoreService.GetDataStore + `__ method. name (str): Required. Full resource name of - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], + `DataStore + `__, such as ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. - If the caller does not have permission to access the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `DataStore + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. If the requested - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] - does not exist, a NOT_FOUND error is returned. + `DataStore + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -1100,8 +1113,8 @@ def list_data_stores( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListDataStoresPager: - r"""Lists all the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s + r"""Lists all the `DataStore + `__s associated with the project. .. code-block:: python @@ -1134,17 +1147,20 @@ def sample_list_data_stores(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.ListDataStoresRequest, dict]): The request object. Request message for - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores] + `DataStoreService.ListDataStores + `__ method. parent (str): - Required. The parent branch resource name, such as + Required. The parent branch resource + name, such as ``projects/{project}/locations/{location}/collections/{collection_id}``. - If the caller does not have permission to list - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s - under this location, regardless of whether or not this - data store exists, a PERMISSION_DENIED error is - returned. + If the caller does not have permission + to list `DataStore + `__s + under this location, regardless of + whether or not this data store exists, a + PERMISSION_DENIED error is returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -1160,11 +1176,13 @@ def sample_list_data_stores(): Returns: google.cloud.discoveryengine_v1alpha.services.data_store_service.pagers.ListDataStoresPager: Response message for - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores] - method. + `DataStoreService.ListDataStores + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -1235,8 +1253,8 @@ def delete_data_store( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Deletes a - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. + r"""Deletes a `DataStore + `__. .. code-block:: python @@ -1271,22 +1289,26 @@ def sample_delete_data_store(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.DeleteDataStoreRequest, dict]): The request object. Request message for - [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.DeleteDataStore] + `DataStoreService.DeleteDataStore + `__ method. name (str): Required. Full resource name of - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], + `DataStore + `__, such as ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. - If the caller does not have permission to delete the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to delete the `DataStore + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] - to delete does not exist, a NOT_FOUND error is returned. + If the `DataStore + `__ + to delete does not exist, a NOT_FOUND + error is returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -1301,18 +1323,21 @@ def sample_delete_data_store(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. @@ -1381,8 +1406,8 @@ def update_data_store( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_data_store.DataStore: - r"""Updates a - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] + r"""Updates a `DataStore + `__ .. code-block:: python @@ -1416,32 +1441,37 @@ def sample_update_data_store(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.UpdateDataStoreRequest, dict]): The request object. Request message for - [DataStoreService.UpdateDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateDataStore] + `DataStoreService.UpdateDataStore + `__ method. data_store (google.cloud.discoveryengine_v1alpha.types.DataStore): - Required. The - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] + Required. The `DataStore + `__ to update. - If the caller does not have permission to update the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to update the `DataStore + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] - to update does not exist, a NOT_FOUND error is returned. + If the `DataStore + `__ + to update does not exist, a NOT_FOUND + error is returned. This corresponds to the ``data_store`` field on the ``request`` instance; if ``request`` is provided, this should not be set. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] + `DataStore + `__ to update. - If an unsupported or unknown field is provided, an - INVALID_ARGUMENT error is returned. + If an unsupported or unknown field is + provided, an INVALID_ARGUMENT error is + returned. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -1522,7 +1552,8 @@ def get_document_processing_config( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> document_processing_config.DocumentProcessingConfig: r"""Gets a - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig]. + `DocumentProcessingConfig + `__. .. code-block:: python @@ -1553,11 +1584,12 @@ def sample_get_document_processing_config(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.GetDocumentProcessingConfigRequest, dict]): The request object. Request for - [DataStoreService.GetDocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DataStoreService.GetDocumentProcessingConfig] + `DataStoreService.GetDocumentProcessingConfig + `__ method. name (str): - Required. Full DocumentProcessingConfig resource name. - Format: + Required. Full DocumentProcessingConfig + resource name. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig`` This corresponds to the ``name`` field @@ -1574,13 +1606,15 @@ def sample_get_document_processing_config(): Returns: google.cloud.discoveryengine_v1alpha.types.DocumentProcessingConfig: A singleton resource of - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. - It's empty when - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] - is created, which defaults to digital parser. The - first call to - [DataStoreService.UpdateDocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateDocumentProcessingConfig] - method will initialize the config. + `DataStore + `__. + It's empty when `DataStore + `__ + is created, which defaults to digital + parser. The first call to + `DataStoreService.UpdateDocumentProcessingConfig + `__ + method will initialize the config. """ # Create or coerce a protobuf request object. @@ -1648,14 +1682,18 @@ def update_document_processing_config( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_document_processing_config.DocumentProcessingConfig: r"""Updates the - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig]. - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig] + `DocumentProcessingConfig + `__. + `DocumentProcessingConfig + `__ is a singleon resource of - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. - It's empty when - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] is + `DataStore + `__. + It's empty when `DataStore + `__ is created. The first call to this method will set up - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig]. + `DocumentProcessingConfig + `__. .. code-block:: python @@ -1685,32 +1723,42 @@ def sample_update_document_processing_config(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.UpdateDocumentProcessingConfigRequest, dict]): The request object. Request for - [DataStoreService.UpdateDocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateDocumentProcessingConfig] + `DataStoreService.UpdateDocumentProcessingConfig + `__ method. document_processing_config (google.cloud.discoveryengine_v1alpha.types.DocumentProcessingConfig): Required. The - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig] + `DocumentProcessingConfig + `__ to update. - If the caller does not have permission to update the - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig], - then a PERMISSION_DENIED error is returned. + If the caller does not have permission + to update the `DocumentProcessingConfig + `__, + then a PERMISSION_DENIED error is + returned. If the - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig] - to update does not exist, a NOT_FOUND error is returned. + `DocumentProcessingConfig + `__ + to update does not exist, a NOT_FOUND + error is returned. This corresponds to the ``document_processing_config`` field on the ``request`` instance; if ``request`` is provided, this should not be set. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig] - to update. The following are the only supported fields: + `DocumentProcessingConfig + `__ + to update. The following are the only + supported fields: - - [DocumentProcessingConfig.ocr_config][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ocr_config] + * `DocumentProcessingConfig.ocr_config + `__ - If not set, all supported fields are updated. + If not set, all supported fields are + updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -1726,13 +1774,15 @@ def sample_update_document_processing_config(): Returns: google.cloud.discoveryengine_v1alpha.types.DocumentProcessingConfig: A singleton resource of - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. - It's empty when - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] - is created, which defaults to digital parser. The - first call to - [DataStoreService.UpdateDocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateDocumentProcessingConfig] - method will initialize the config. + `DataStore + `__. + It's empty when `DataStore + `__ + is created, which defaults to digital + parser. The first call to + `DataStoreService.UpdateDocumentProcessingConfig + `__ + method will initialize the config. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/data_store_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/data_store_service/transports/grpc.py index 6b4a0fe42fa0..03746e258e9c 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/data_store_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/data_store_service/transports/grpc.py @@ -119,7 +119,7 @@ class DataStoreServiceGrpcTransport(DataStoreServiceTransport): """gRPC backend transport for DataStoreService. Service for managing - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] + `DataStore `__ configuration. This class defines the same methods as the primary client, so the @@ -356,14 +356,15 @@ def create_data_store( ]: r"""Return a callable for the create data store method over gRPC. - Creates a - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. - + Creates a `DataStore + `__. DataStore is for storing - [Documents][google.cloud.discoveryengine.v1alpha.Document]. To - serve these documents for Search, or Recommendation use case, an - [Engine][google.cloud.discoveryengine.v1alpha.Engine] needs to - be created separately. + `Documents + `__. To + serve these documents for Search, or Recommendation use + case, an `Engine + `__ needs + to be created separately. Returns: Callable[[~.CreateDataStoreRequest], @@ -389,8 +390,8 @@ def get_data_store( ) -> Callable[[data_store_service.GetDataStoreRequest], data_store.DataStore]: r"""Return a callable for the get data store method over gRPC. - Gets a - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. + Gets a `DataStore + `__. Returns: Callable[[~.GetDataStoreRequest], @@ -419,8 +420,8 @@ def list_data_stores( ]: r"""Return a callable for the list data stores method over gRPC. - Lists all the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s + Lists all the `DataStore + `__s associated with the project. Returns: @@ -449,8 +450,8 @@ def delete_data_store( ]: r"""Return a callable for the delete data store method over gRPC. - Deletes a - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. + Deletes a `DataStore + `__. Returns: Callable[[~.DeleteDataStoreRequest], @@ -478,8 +479,8 @@ def update_data_store( ]: r"""Return a callable for the update data store method over gRPC. - Updates a - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] + Updates a `DataStore + `__ Returns: Callable[[~.UpdateDataStoreRequest], @@ -509,7 +510,8 @@ def get_document_processing_config( r"""Return a callable for the get document processing config method over gRPC. Gets a - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig]. + `DocumentProcessingConfig + `__. Returns: Callable[[~.GetDocumentProcessingConfigRequest], @@ -542,14 +544,18 @@ def update_document_processing_config( config method over gRPC. Updates the - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig]. - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig] + `DocumentProcessingConfig + `__. + `DocumentProcessingConfig + `__ is a singleon resource of - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. - It's empty when - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] is + `DataStore + `__. + It's empty when `DataStore + `__ is created. The first call to this method will set up - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig]. + `DocumentProcessingConfig + `__. Returns: Callable[[~.UpdateDocumentProcessingConfigRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/data_store_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/data_store_service/transports/grpc_asyncio.py index be0a75a2844a..f705aa6f6cec 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/data_store_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/data_store_service/transports/grpc_asyncio.py @@ -125,7 +125,7 @@ class DataStoreServiceGrpcAsyncIOTransport(DataStoreServiceTransport): """gRPC AsyncIO backend transport for DataStoreService. Service for managing - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] + `DataStore `__ configuration. This class defines the same methods as the primary client, so the @@ -364,14 +364,15 @@ def create_data_store( ]: r"""Return a callable for the create data store method over gRPC. - Creates a - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. - + Creates a `DataStore + `__. DataStore is for storing - [Documents][google.cloud.discoveryengine.v1alpha.Document]. To - serve these documents for Search, or Recommendation use case, an - [Engine][google.cloud.discoveryengine.v1alpha.Engine] needs to - be created separately. + `Documents + `__. To + serve these documents for Search, or Recommendation use + case, an `Engine + `__ needs + to be created separately. Returns: Callable[[~.CreateDataStoreRequest], @@ -399,8 +400,8 @@ def get_data_store( ]: r"""Return a callable for the get data store method over gRPC. - Gets a - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. + Gets a `DataStore + `__. Returns: Callable[[~.GetDataStoreRequest], @@ -429,8 +430,8 @@ def list_data_stores( ]: r"""Return a callable for the list data stores method over gRPC. - Lists all the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s + Lists all the `DataStore + `__s associated with the project. Returns: @@ -459,8 +460,8 @@ def delete_data_store( ]: r"""Return a callable for the delete data store method over gRPC. - Deletes a - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. + Deletes a `DataStore + `__. Returns: Callable[[~.DeleteDataStoreRequest], @@ -488,8 +489,8 @@ def update_data_store( ]: r"""Return a callable for the update data store method over gRPC. - Updates a - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] + Updates a `DataStore + `__ Returns: Callable[[~.UpdateDataStoreRequest], @@ -519,7 +520,8 @@ def get_document_processing_config( r"""Return a callable for the get document processing config method over gRPC. Gets a - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig]. + `DocumentProcessingConfig + `__. Returns: Callable[[~.GetDocumentProcessingConfigRequest], @@ -552,14 +554,18 @@ def update_document_processing_config( config method over gRPC. Updates the - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig]. - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig] + `DocumentProcessingConfig + `__. + `DocumentProcessingConfig + `__ is a singleon resource of - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. - It's empty when - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] is + `DataStore + `__. + It's empty when `DataStore + `__ is created. The first call to this method will set up - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig]. + `DocumentProcessingConfig + `__. Returns: Callable[[~.UpdateDocumentProcessingConfigRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/data_store_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/data_store_service/transports/rest.py index 3c5e0577ef4b..5d6b742ef407 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/data_store_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/data_store_service/transports/rest.py @@ -578,7 +578,7 @@ class DataStoreServiceRestTransport(_BaseDataStoreServiceRestTransport): """REST backend synchronous transport for DataStoreService. Service for managing - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] + `DataStore `__ configuration. This class defines the same methods as the primary client, so the @@ -872,7 +872,8 @@ def __call__( Args: request (~.data_store_service.CreateDataStoreRequest): The request object. Request for - [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.CreateDataStore] + `DataStoreService.CreateDataStore + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1027,7 +1028,8 @@ def __call__( Args: request (~.data_store_service.DeleteDataStoreRequest): The request object. Request message for - [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.DeleteDataStore] + `DataStoreService.DeleteDataStore + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1176,7 +1178,8 @@ def __call__( Args: request (~.data_store_service.GetDataStoreRequest): The request object. Request message for - [DataStoreService.GetDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.GetDataStore] + `DataStoreService.GetDataStore + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1326,7 +1329,8 @@ def __call__( Args: request (~.data_store_service.GetDocumentProcessingConfigRequest): The request object. Request for - [DataStoreService.GetDocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DataStoreService.GetDocumentProcessingConfig] + `DataStoreService.GetDocumentProcessingConfig + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1339,12 +1343,14 @@ def __call__( Returns: ~.document_processing_config.DocumentProcessingConfig: A singleton resource of - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. - It's empty when - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] - is created, which defaults to digital parser. The first - call to - [DataStoreService.UpdateDocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateDocumentProcessingConfig] + `DataStore + `__. + It's empty when `DataStore + `__ + is created, which defaults to digital + parser. The first call to + `DataStoreService.UpdateDocumentProcessingConfig + `__ method will initialize the config. """ @@ -1489,7 +1495,8 @@ def __call__( Args: request (~.data_store_service.ListDataStoresRequest): The request object. Request message for - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores] + `DataStoreService.ListDataStores + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1502,7 +1509,8 @@ def __call__( Returns: ~.data_store_service.ListDataStoresResponse: Response message for - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores] + `DataStoreService.ListDataStores + `__ method. """ @@ -1644,7 +1652,8 @@ def __call__( Args: request (~.data_store_service.UpdateDataStoreRequest): The request object. Request message for - [DataStoreService.UpdateDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateDataStore] + `DataStoreService.UpdateDataStore + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1802,7 +1811,8 @@ def __call__( Args: request (~.data_store_service.UpdateDocumentProcessingConfigRequest): The request object. Request for - [DataStoreService.UpdateDocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateDocumentProcessingConfig] + `DataStoreService.UpdateDocumentProcessingConfig + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1815,12 +1825,14 @@ def __call__( Returns: ~.gcd_document_processing_config.DocumentProcessingConfig: A singleton resource of - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. - It's empty when - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] - is created, which defaults to digital parser. The first - call to - [DataStoreService.UpdateDocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateDocumentProcessingConfig] + `DataStore + `__. + It's empty when `DataStore + `__ + is created, which defaults to digital + parser. The first call to + `DataStoreService.UpdateDocumentProcessingConfig + `__ method will initialize the config. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/document_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/document_service/async_client.py index 967e825c1fc6..1487102b75d4 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/document_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/document_service/async_client.py @@ -77,7 +77,7 @@ class DocumentServiceAsyncClient: """Service for ingesting - [Document][google.cloud.discoveryengine.v1alpha.Document] + `Document `__ information of the customer's website. """ @@ -319,8 +319,8 @@ async def get_document( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> document.Document: - r"""Gets a - [Document][google.cloud.discoveryengine.v1alpha.Document]. + r"""Gets a `Document + `__. .. code-block:: python @@ -351,22 +351,27 @@ async def sample_get_document(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.GetDocumentRequest, dict]]): The request object. Request message for - [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument] + `DocumentService.GetDocument + `__ method. name (:class:`str`): Required. Full resource name of - [Document][google.cloud.discoveryengine.v1alpha.Document], + `Document + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}``. - If the caller does not have permission to access the - [Document][google.cloud.discoveryengine.v1alpha.Document], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + If the caller does not have permission + to access the `Document + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. - If the requested - [Document][google.cloud.discoveryengine.v1alpha.Document] - does not exist, a ``NOT_FOUND`` error is returned. + If the requested `Document + `__ + does not exist, a ``NOT_FOUND`` error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -444,8 +449,8 @@ async def list_documents( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListDocumentsAsyncPager: - r"""Gets a list of - [Document][google.cloud.discoveryengine.v1alpha.Document]s. + r"""Gets a list of `Document + `__s. .. code-block:: python @@ -477,19 +482,23 @@ async def sample_list_documents(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.ListDocumentsRequest, dict]]): The request object. Request message for - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments] + `DocumentService.ListDocuments + `__ method. parent (:class:`str`): - Required. The parent branch resource name, such as + Required. The parent branch resource + name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. - Use ``default_branch`` as the branch ID, to list - documents under the default branch. - - If the caller does not have permission to list - [Document][google.cloud.discoveryengine.v1alpha.Document]s - under this branch, regardless of whether or not this - branch exists, a ``PERMISSION_DENIED`` error is - returned. + Use ``default_branch`` as the branch ID, + to list documents under the default + branch. + + If the caller does not have permission + to list `Document + `__s + under this branch, regardless of whether + or not this branch exists, a + ``PERMISSION_DENIED`` error is returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -505,11 +514,13 @@ async def sample_list_documents(): Returns: google.cloud.discoveryengine_v1alpha.services.document_service.pagers.ListDocumentsAsyncPager: Response message for - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments] - method. + `DocumentService.ListDocuments + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -583,8 +594,8 @@ async def create_document( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_document.Document: - r"""Creates a - [Document][google.cloud.discoveryengine.v1alpha.Document]. + r"""Creates a `Document + `__. .. code-block:: python @@ -616,18 +627,20 @@ async def sample_create_document(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.CreateDocumentRequest, dict]]): The request object. Request message for - [DocumentService.CreateDocument][google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocument] + `DocumentService.CreateDocument + `__ method. parent (:class:`str`): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. document (:class:`google.cloud.discoveryengine_v1alpha.types.Document`): - Required. The - [Document][google.cloud.discoveryengine.v1alpha.Document] + Required. The `Document + `__ to create. This corresponds to the ``document`` field @@ -635,25 +648,32 @@ async def sample_create_document(): should not be set. document_id (:class:`str`): Required. The ID to use for the - [Document][google.cloud.discoveryengine.v1alpha.Document], + `Document + `__, which becomes the final component of the - [Document.name][google.cloud.discoveryengine.v1alpha.Document.name]. - - If the caller does not have permission to create the - [Document][google.cloud.discoveryengine.v1alpha.Document], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + `Document.name + `__. + + If the caller does not have permission + to create the `Document + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. This field must be unique among all - [Document][google.cloud.discoveryengine.v1alpha.Document]s - with the same - [parent][google.cloud.discoveryengine.v1alpha.CreateDocumentRequest.parent]. - Otherwise, an ``ALREADY_EXISTS`` error is returned. - - This field must conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. - Otherwise, an ``INVALID_ARGUMENT`` error is returned. + `Document + `__s + with the same `parent + `__. + Otherwise, an ``ALREADY_EXISTS`` error + is returned. + + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 + characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. This corresponds to the ``document_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -736,8 +756,8 @@ async def update_document( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_document.Document: - r"""Updates a - [Document][google.cloud.discoveryengine.v1alpha.Document]. + r"""Updates a `Document + `__. .. code-block:: python @@ -767,21 +787,26 @@ async def sample_update_document(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.UpdateDocumentRequest, dict]]): The request object. Request message for - [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1alpha.DocumentService.UpdateDocument] + `DocumentService.UpdateDocument + `__ method. document (:class:`google.cloud.discoveryengine_v1alpha.types.Document`): Required. The document to update/create. - If the caller does not have permission to update the - [Document][google.cloud.discoveryengine.v1alpha.Document], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + If the caller does not have permission + to update the `Document + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. - If the - [Document][google.cloud.discoveryengine.v1alpha.Document] + If the `Document + `__ to update does not exist and - [allow_missing][google.cloud.discoveryengine.v1alpha.UpdateDocumentRequest.allow_missing] - is not set, a ``NOT_FOUND`` error is returned. + `allow_missing + `__ + is not set, a ``NOT_FOUND`` error is + returned. This corresponds to the ``document`` field on the ``request`` instance; if ``request`` is provided, this @@ -872,8 +897,8 @@ async def delete_document( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> None: - r"""Deletes a - [Document][google.cloud.discoveryengine.v1alpha.Document]. + r"""Deletes a `Document + `__. .. code-block:: python @@ -901,24 +926,28 @@ async def sample_delete_document(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.DeleteDocumentRequest, dict]]): The request object. Request message for - [DocumentService.DeleteDocument][google.cloud.discoveryengine.v1alpha.DocumentService.DeleteDocument] + `DocumentService.DeleteDocument + `__ method. name (:class:`str`): Required. Full resource name of - [Document][google.cloud.discoveryengine.v1alpha.Document], + `Document + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}``. - If the caller does not have permission to delete the - [Document][google.cloud.discoveryengine.v1alpha.Document], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. - - If the - [Document][google.cloud.discoveryengine.v1alpha.Document] - to delete does not exist, a ``NOT_FOUND`` error is + If the caller does not have permission + to delete the `Document + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is returned. + If the `Document + `__ + to delete does not exist, a + ``NOT_FOUND`` error is returned. + This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this should not be set. @@ -985,13 +1014,15 @@ async def import_documents( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: r"""Bulk import of multiple - [Document][google.cloud.discoveryengine.v1alpha.Document]s. - Request processing may be synchronous. Non-existing items are - created. + `Document + `__s. + Request processing may be synchronous. Non-existing + items are created. Note: It is possible for a subset of the - [Document][google.cloud.discoveryengine.v1alpha.Document]s to be - successfully updated. + `Document + `__s to + be successfully updated. .. code-block:: python @@ -1036,14 +1067,17 @@ async def sample_import_documents(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.ImportDocumentsResponse` Response of the - [ImportDocumentsRequest][google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest]. - If the long running operation is done, then this - message is returned by the - google.longrunning.Operations.response field if the - operation was successful. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.ImportDocumentsResponse` + Response of the `ImportDocumentsRequest + `__. + If the long running operation is done, + then this message is returned by the + google.longrunning.Operations.response + field if the operation was successful. """ # Create or coerce a protobuf request object. @@ -1095,23 +1129,29 @@ async def purge_documents( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: r"""Permanently deletes all selected - [Document][google.cloud.discoveryengine.v1alpha.Document]s in a + `Document + `__s in a branch. This process is asynchronous. Depending on the number of - [Document][google.cloud.discoveryengine.v1alpha.Document]s to be - deleted, this operation can take hours to complete. Before the - delete operation completes, some - [Document][google.cloud.discoveryengine.v1alpha.Document]s might - still be returned by - [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument] + `Document + `__s to + be deleted, this operation can take hours to complete. + Before the delete operation completes, some `Document + `__s + might still be returned by + `DocumentService.GetDocument + `__ or - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments]. + `DocumentService.ListDocuments + `__. To get a list of the - [Document][google.cloud.discoveryengine.v1alpha.Document]s to be - deleted, set - [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.force] + `Document + `__s to + be deleted, set + `PurgeDocumentsRequest.force + `__ to false. .. code-block:: python @@ -1152,7 +1192,8 @@ async def sample_purge_documents(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.PurgeDocumentsRequest, dict]]): The request object. Request message for - [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.PurgeDocuments] + `DocumentService.PurgeDocuments + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -1164,13 +1205,19 @@ async def sample_purge_documents(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.PurgeDocumentsResponse` Response message for - [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.PurgeDocuments] - method. If the long running operation is successfully - done, then this message is returned by the - google.longrunning.Operations.response field. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.PurgeDocumentsResponse` + Response message for + `DocumentService.PurgeDocuments + `__ + method. If the long running operation is + successfully done, then this message is + returned by the + google.longrunning.Operations.response + field. """ # Create or coerce a protobuf request object. @@ -1225,7 +1272,8 @@ async def get_processed_document( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> document.ProcessedDocument: r"""Gets the parsed layout information for a - [Document][google.cloud.discoveryengine.v1alpha.Document]. + `Document + `__. .. code-block:: python @@ -1257,22 +1305,27 @@ async def sample_get_processed_document(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.GetProcessedDocumentRequest, dict]]): The request object. Request message for - [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument] + `DocumentService.GetDocument + `__ method. name (:class:`str`): Required. Full resource name of - [Document][google.cloud.discoveryengine.v1alpha.Document], + `Document + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}``. - If the caller does not have permission to access the - [Document][google.cloud.discoveryengine.v1alpha.Document], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + If the caller does not have permission + to access the `Document + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. - If the requested - [Document][google.cloud.discoveryengine.v1alpha.Document] - does not exist, a ``NOT_FOUND`` error is returned. + If the requested `Document + `__ + does not exist, a ``NOT_FOUND`` error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -1353,7 +1406,8 @@ async def batch_get_documents_metadata( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> document_service.BatchGetDocumentsMetadataResponse: r"""Gets index freshness metadata for - [Document][google.cloud.discoveryengine.v1alpha.Document]s. + `Document + `__s. Supported for website search only. .. code-block:: python @@ -1385,10 +1439,12 @@ async def sample_batch_get_documents_metadata(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.BatchGetDocumentsMetadataRequest, dict]]): The request object. Request message for - [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1alpha.DocumentService.BatchGetDocumentsMetadata] + `DocumentService.BatchGetDocumentsMetadata + `__ method. parent (:class:`str`): - Required. The parent branch resource name, such as + Required. The parent branch resource + name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. This corresponds to the ``parent`` field @@ -1405,8 +1461,9 @@ async def sample_batch_get_documents_metadata(): Returns: google.cloud.discoveryengine_v1alpha.types.BatchGetDocumentsMetadataResponse: Response message for - [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1alpha.DocumentService.BatchGetDocumentsMetadata] - method. + `DocumentService.BatchGetDocumentsMetadata + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/document_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/document_service/client.py index 6e91ecc3fe65..3750f8294f79 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/document_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/document_service/client.py @@ -123,7 +123,7 @@ def get_transport_class( class DocumentServiceClient(metaclass=DocumentServiceClientMeta): """Service for ingesting - [Document][google.cloud.discoveryengine.v1alpha.Document] + `Document `__ information of the customer's website. """ @@ -790,8 +790,8 @@ def get_document( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> document.Document: - r"""Gets a - [Document][google.cloud.discoveryengine.v1alpha.Document]. + r"""Gets a `Document + `__. .. code-block:: python @@ -822,22 +822,27 @@ def sample_get_document(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.GetDocumentRequest, dict]): The request object. Request message for - [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument] + `DocumentService.GetDocument + `__ method. name (str): Required. Full resource name of - [Document][google.cloud.discoveryengine.v1alpha.Document], + `Document + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}``. - If the caller does not have permission to access the - [Document][google.cloud.discoveryengine.v1alpha.Document], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + If the caller does not have permission + to access the `Document + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. - If the requested - [Document][google.cloud.discoveryengine.v1alpha.Document] - does not exist, a ``NOT_FOUND`` error is returned. + If the requested `Document + `__ + does not exist, a ``NOT_FOUND`` error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -912,8 +917,8 @@ def list_documents( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListDocumentsPager: - r"""Gets a list of - [Document][google.cloud.discoveryengine.v1alpha.Document]s. + r"""Gets a list of `Document + `__s. .. code-block:: python @@ -945,19 +950,23 @@ def sample_list_documents(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.ListDocumentsRequest, dict]): The request object. Request message for - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments] + `DocumentService.ListDocuments + `__ method. parent (str): - Required. The parent branch resource name, such as + Required. The parent branch resource + name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. - Use ``default_branch`` as the branch ID, to list - documents under the default branch. - - If the caller does not have permission to list - [Document][google.cloud.discoveryengine.v1alpha.Document]s - under this branch, regardless of whether or not this - branch exists, a ``PERMISSION_DENIED`` error is - returned. + Use ``default_branch`` as the branch ID, + to list documents under the default + branch. + + If the caller does not have permission + to list `Document + `__s + under this branch, regardless of whether + or not this branch exists, a + ``PERMISSION_DENIED`` error is returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -973,11 +982,13 @@ def sample_list_documents(): Returns: google.cloud.discoveryengine_v1alpha.services.document_service.pagers.ListDocumentsPager: Response message for - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments] - method. + `DocumentService.ListDocuments + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -1048,8 +1059,8 @@ def create_document( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_document.Document: - r"""Creates a - [Document][google.cloud.discoveryengine.v1alpha.Document]. + r"""Creates a `Document + `__. .. code-block:: python @@ -1081,18 +1092,20 @@ def sample_create_document(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.CreateDocumentRequest, dict]): The request object. Request message for - [DocumentService.CreateDocument][google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocument] + `DocumentService.CreateDocument + `__ method. parent (str): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. document (google.cloud.discoveryengine_v1alpha.types.Document): - Required. The - [Document][google.cloud.discoveryengine.v1alpha.Document] + Required. The `Document + `__ to create. This corresponds to the ``document`` field @@ -1100,25 +1113,32 @@ def sample_create_document(): should not be set. document_id (str): Required. The ID to use for the - [Document][google.cloud.discoveryengine.v1alpha.Document], + `Document + `__, which becomes the final component of the - [Document.name][google.cloud.discoveryengine.v1alpha.Document.name]. - - If the caller does not have permission to create the - [Document][google.cloud.discoveryengine.v1alpha.Document], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + `Document.name + `__. + + If the caller does not have permission + to create the `Document + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. This field must be unique among all - [Document][google.cloud.discoveryengine.v1alpha.Document]s - with the same - [parent][google.cloud.discoveryengine.v1alpha.CreateDocumentRequest.parent]. - Otherwise, an ``ALREADY_EXISTS`` error is returned. - - This field must conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. - Otherwise, an ``INVALID_ARGUMENT`` error is returned. + `Document + `__s + with the same `parent + `__. + Otherwise, an ``ALREADY_EXISTS`` error + is returned. + + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 + characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. This corresponds to the ``document_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -1198,8 +1218,8 @@ def update_document( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_document.Document: - r"""Updates a - [Document][google.cloud.discoveryengine.v1alpha.Document]. + r"""Updates a `Document + `__. .. code-block:: python @@ -1229,21 +1249,26 @@ def sample_update_document(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.UpdateDocumentRequest, dict]): The request object. Request message for - [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1alpha.DocumentService.UpdateDocument] + `DocumentService.UpdateDocument + `__ method. document (google.cloud.discoveryengine_v1alpha.types.Document): Required. The document to update/create. - If the caller does not have permission to update the - [Document][google.cloud.discoveryengine.v1alpha.Document], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + If the caller does not have permission + to update the `Document + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. - If the - [Document][google.cloud.discoveryengine.v1alpha.Document] + If the `Document + `__ to update does not exist and - [allow_missing][google.cloud.discoveryengine.v1alpha.UpdateDocumentRequest.allow_missing] - is not set, a ``NOT_FOUND`` error is returned. + `allow_missing + `__ + is not set, a ``NOT_FOUND`` error is + returned. This corresponds to the ``document`` field on the ``request`` instance; if ``request`` is provided, this @@ -1331,8 +1356,8 @@ def delete_document( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> None: - r"""Deletes a - [Document][google.cloud.discoveryengine.v1alpha.Document]. + r"""Deletes a `Document + `__. .. code-block:: python @@ -1360,24 +1385,28 @@ def sample_delete_document(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.DeleteDocumentRequest, dict]): The request object. Request message for - [DocumentService.DeleteDocument][google.cloud.discoveryengine.v1alpha.DocumentService.DeleteDocument] + `DocumentService.DeleteDocument + `__ method. name (str): Required. Full resource name of - [Document][google.cloud.discoveryengine.v1alpha.Document], + `Document + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}``. - If the caller does not have permission to delete the - [Document][google.cloud.discoveryengine.v1alpha.Document], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. - - If the - [Document][google.cloud.discoveryengine.v1alpha.Document] - to delete does not exist, a ``NOT_FOUND`` error is + If the caller does not have permission + to delete the `Document + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is returned. + If the `Document + `__ + to delete does not exist, a + ``NOT_FOUND`` error is returned. + This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this should not be set. @@ -1441,13 +1470,15 @@ def import_documents( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: r"""Bulk import of multiple - [Document][google.cloud.discoveryengine.v1alpha.Document]s. - Request processing may be synchronous. Non-existing items are - created. + `Document + `__s. + Request processing may be synchronous. Non-existing + items are created. Note: It is possible for a subset of the - [Document][google.cloud.discoveryengine.v1alpha.Document]s to be - successfully updated. + `Document + `__s to + be successfully updated. .. code-block:: python @@ -1492,14 +1523,17 @@ def sample_import_documents(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.ImportDocumentsResponse` Response of the - [ImportDocumentsRequest][google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest]. - If the long running operation is done, then this - message is returned by the - google.longrunning.Operations.response field if the - operation was successful. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.ImportDocumentsResponse` + Response of the `ImportDocumentsRequest + `__. + If the long running operation is done, + then this message is returned by the + google.longrunning.Operations.response + field if the operation was successful. """ # Create or coerce a protobuf request object. @@ -1549,23 +1583,29 @@ def purge_documents( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: r"""Permanently deletes all selected - [Document][google.cloud.discoveryengine.v1alpha.Document]s in a + `Document + `__s in a branch. This process is asynchronous. Depending on the number of - [Document][google.cloud.discoveryengine.v1alpha.Document]s to be - deleted, this operation can take hours to complete. Before the - delete operation completes, some - [Document][google.cloud.discoveryengine.v1alpha.Document]s might - still be returned by - [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument] + `Document + `__s to + be deleted, this operation can take hours to complete. + Before the delete operation completes, some `Document + `__s + might still be returned by + `DocumentService.GetDocument + `__ or - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments]. + `DocumentService.ListDocuments + `__. To get a list of the - [Document][google.cloud.discoveryengine.v1alpha.Document]s to be - deleted, set - [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.force] + `Document + `__s to + be deleted, set + `PurgeDocumentsRequest.force + `__ to false. .. code-block:: python @@ -1606,7 +1646,8 @@ def sample_purge_documents(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.PurgeDocumentsRequest, dict]): The request object. Request message for - [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.PurgeDocuments] + `DocumentService.PurgeDocuments + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1618,13 +1659,19 @@ def sample_purge_documents(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.PurgeDocumentsResponse` Response message for - [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.PurgeDocuments] - method. If the long running operation is successfully - done, then this message is returned by the - google.longrunning.Operations.response field. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.PurgeDocumentsResponse` + Response message for + `DocumentService.PurgeDocuments + `__ + method. If the long running operation is + successfully done, then this message is + returned by the + google.longrunning.Operations.response + field. """ # Create or coerce a protobuf request object. @@ -1677,7 +1724,8 @@ def get_processed_document( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> document.ProcessedDocument: r"""Gets the parsed layout information for a - [Document][google.cloud.discoveryengine.v1alpha.Document]. + `Document + `__. .. code-block:: python @@ -1709,22 +1757,27 @@ def sample_get_processed_document(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.GetProcessedDocumentRequest, dict]): The request object. Request message for - [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument] + `DocumentService.GetDocument + `__ method. name (str): Required. Full resource name of - [Document][google.cloud.discoveryengine.v1alpha.Document], + `Document + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}``. - If the caller does not have permission to access the - [Document][google.cloud.discoveryengine.v1alpha.Document], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + If the caller does not have permission + to access the `Document + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. - If the requested - [Document][google.cloud.discoveryengine.v1alpha.Document] - does not exist, a ``NOT_FOUND`` error is returned. + If the requested `Document + `__ + does not exist, a ``NOT_FOUND`` error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -1802,7 +1855,8 @@ def batch_get_documents_metadata( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> document_service.BatchGetDocumentsMetadataResponse: r"""Gets index freshness metadata for - [Document][google.cloud.discoveryengine.v1alpha.Document]s. + `Document + `__s. Supported for website search only. .. code-block:: python @@ -1834,10 +1888,12 @@ def sample_batch_get_documents_metadata(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.BatchGetDocumentsMetadataRequest, dict]): The request object. Request message for - [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1alpha.DocumentService.BatchGetDocumentsMetadata] + `DocumentService.BatchGetDocumentsMetadata + `__ method. parent (str): - Required. The parent branch resource name, such as + Required. The parent branch resource + name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. This corresponds to the ``parent`` field @@ -1854,8 +1910,9 @@ def sample_batch_get_documents_metadata(): Returns: google.cloud.discoveryengine_v1alpha.types.BatchGetDocumentsMetadataResponse: Response message for - [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1alpha.DocumentService.BatchGetDocumentsMetadata] - method. + `DocumentService.BatchGetDocumentsMetadata + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/document_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/document_service/transports/grpc.py index 5e7fa066e5ff..4854cd95ee52 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/document_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/document_service/transports/grpc.py @@ -120,7 +120,7 @@ class DocumentServiceGrpcTransport(DocumentServiceTransport): """gRPC backend transport for DocumentService. Service for ingesting - [Document][google.cloud.discoveryengine.v1alpha.Document] + `Document `__ information of the customer's website. This class defines the same methods as the primary client, so the @@ -355,8 +355,8 @@ def get_document( ) -> Callable[[document_service.GetDocumentRequest], document.Document]: r"""Return a callable for the get document method over gRPC. - Gets a - [Document][google.cloud.discoveryengine.v1alpha.Document]. + Gets a `Document + `__. Returns: Callable[[~.GetDocumentRequest], @@ -384,8 +384,8 @@ def list_documents( ]: r"""Return a callable for the list documents method over gRPC. - Gets a list of - [Document][google.cloud.discoveryengine.v1alpha.Document]s. + Gets a list of `Document + `__s. Returns: Callable[[~.ListDocumentsRequest], @@ -411,8 +411,8 @@ def create_document( ) -> Callable[[document_service.CreateDocumentRequest], gcd_document.Document]: r"""Return a callable for the create document method over gRPC. - Creates a - [Document][google.cloud.discoveryengine.v1alpha.Document]. + Creates a `Document + `__. Returns: Callable[[~.CreateDocumentRequest], @@ -438,8 +438,8 @@ def update_document( ) -> Callable[[document_service.UpdateDocumentRequest], gcd_document.Document]: r"""Return a callable for the update document method over gRPC. - Updates a - [Document][google.cloud.discoveryengine.v1alpha.Document]. + Updates a `Document + `__. Returns: Callable[[~.UpdateDocumentRequest], @@ -465,8 +465,8 @@ def delete_document( ) -> Callable[[document_service.DeleteDocumentRequest], empty_pb2.Empty]: r"""Return a callable for the delete document method over gRPC. - Deletes a - [Document][google.cloud.discoveryengine.v1alpha.Document]. + Deletes a `Document + `__. Returns: Callable[[~.DeleteDocumentRequest], @@ -493,13 +493,15 @@ def import_documents( r"""Return a callable for the import documents method over gRPC. Bulk import of multiple - [Document][google.cloud.discoveryengine.v1alpha.Document]s. - Request processing may be synchronous. Non-existing items are - created. + `Document + `__s. + Request processing may be synchronous. Non-existing + items are created. Note: It is possible for a subset of the - [Document][google.cloud.discoveryengine.v1alpha.Document]s to be - successfully updated. + `Document + `__s to + be successfully updated. Returns: Callable[[~.ImportDocumentsRequest], @@ -526,23 +528,29 @@ def purge_documents( r"""Return a callable for the purge documents method over gRPC. Permanently deletes all selected - [Document][google.cloud.discoveryengine.v1alpha.Document]s in a + `Document + `__s in a branch. This process is asynchronous. Depending on the number of - [Document][google.cloud.discoveryengine.v1alpha.Document]s to be - deleted, this operation can take hours to complete. Before the - delete operation completes, some - [Document][google.cloud.discoveryengine.v1alpha.Document]s might - still be returned by - [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument] + `Document + `__s to + be deleted, this operation can take hours to complete. + Before the delete operation completes, some `Document + `__s + might still be returned by + `DocumentService.GetDocument + `__ or - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments]. + `DocumentService.ListDocuments + `__. To get a list of the - [Document][google.cloud.discoveryengine.v1alpha.Document]s to be - deleted, set - [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.force] + `Document + `__s to + be deleted, set + `PurgeDocumentsRequest.force + `__ to false. Returns: @@ -572,7 +580,8 @@ def get_processed_document( r"""Return a callable for the get processed document method over gRPC. Gets the parsed layout information for a - [Document][google.cloud.discoveryengine.v1alpha.Document]. + `Document + `__. Returns: Callable[[~.GetProcessedDocumentRequest], @@ -602,7 +611,8 @@ def batch_get_documents_metadata( r"""Return a callable for the batch get documents metadata method over gRPC. Gets index freshness metadata for - [Document][google.cloud.discoveryengine.v1alpha.Document]s. + `Document + `__s. Supported for website search only. Returns: diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/document_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/document_service/transports/grpc_asyncio.py index d9ac56379040..a3be5aa8c1a3 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/document_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/document_service/transports/grpc_asyncio.py @@ -126,7 +126,7 @@ class DocumentServiceGrpcAsyncIOTransport(DocumentServiceTransport): """gRPC AsyncIO backend transport for DocumentService. Service for ingesting - [Document][google.cloud.discoveryengine.v1alpha.Document] + `Document `__ information of the customer's website. This class defines the same methods as the primary client, so the @@ -363,8 +363,8 @@ def get_document( ) -> Callable[[document_service.GetDocumentRequest], Awaitable[document.Document]]: r"""Return a callable for the get document method over gRPC. - Gets a - [Document][google.cloud.discoveryengine.v1alpha.Document]. + Gets a `Document + `__. Returns: Callable[[~.GetDocumentRequest], @@ -393,8 +393,8 @@ def list_documents( ]: r"""Return a callable for the list documents method over gRPC. - Gets a list of - [Document][google.cloud.discoveryengine.v1alpha.Document]s. + Gets a list of `Document + `__s. Returns: Callable[[~.ListDocumentsRequest], @@ -422,8 +422,8 @@ def create_document( ]: r"""Return a callable for the create document method over gRPC. - Creates a - [Document][google.cloud.discoveryengine.v1alpha.Document]. + Creates a `Document + `__. Returns: Callable[[~.CreateDocumentRequest], @@ -451,8 +451,8 @@ def update_document( ]: r"""Return a callable for the update document method over gRPC. - Updates a - [Document][google.cloud.discoveryengine.v1alpha.Document]. + Updates a `Document + `__. Returns: Callable[[~.UpdateDocumentRequest], @@ -478,8 +478,8 @@ def delete_document( ) -> Callable[[document_service.DeleteDocumentRequest], Awaitable[empty_pb2.Empty]]: r"""Return a callable for the delete document method over gRPC. - Deletes a - [Document][google.cloud.discoveryengine.v1alpha.Document]. + Deletes a `Document + `__. Returns: Callable[[~.DeleteDocumentRequest], @@ -508,13 +508,15 @@ def import_documents( r"""Return a callable for the import documents method over gRPC. Bulk import of multiple - [Document][google.cloud.discoveryengine.v1alpha.Document]s. - Request processing may be synchronous. Non-existing items are - created. + `Document + `__s. + Request processing may be synchronous. Non-existing + items are created. Note: It is possible for a subset of the - [Document][google.cloud.discoveryengine.v1alpha.Document]s to be - successfully updated. + `Document + `__s to + be successfully updated. Returns: Callable[[~.ImportDocumentsRequest], @@ -543,23 +545,29 @@ def purge_documents( r"""Return a callable for the purge documents method over gRPC. Permanently deletes all selected - [Document][google.cloud.discoveryengine.v1alpha.Document]s in a + `Document + `__s in a branch. This process is asynchronous. Depending on the number of - [Document][google.cloud.discoveryengine.v1alpha.Document]s to be - deleted, this operation can take hours to complete. Before the - delete operation completes, some - [Document][google.cloud.discoveryengine.v1alpha.Document]s might - still be returned by - [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument] + `Document + `__s to + be deleted, this operation can take hours to complete. + Before the delete operation completes, some `Document + `__s + might still be returned by + `DocumentService.GetDocument + `__ or - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments]. + `DocumentService.ListDocuments + `__. To get a list of the - [Document][google.cloud.discoveryengine.v1alpha.Document]s to be - deleted, set - [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.force] + `Document + `__s to + be deleted, set + `PurgeDocumentsRequest.force + `__ to false. Returns: @@ -590,7 +598,8 @@ def get_processed_document( r"""Return a callable for the get processed document method over gRPC. Gets the parsed layout information for a - [Document][google.cloud.discoveryengine.v1alpha.Document]. + `Document + `__. Returns: Callable[[~.GetProcessedDocumentRequest], @@ -620,7 +629,8 @@ def batch_get_documents_metadata( r"""Return a callable for the batch get documents metadata method over gRPC. Gets index freshness metadata for - [Document][google.cloud.discoveryengine.v1alpha.Document]s. + `Document + `__s. Supported for website search only. Returns: diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/document_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/document_service/transports/rest.py index c91818db2d7f..db4e6b75c112 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/document_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/document_service/transports/rest.py @@ -643,7 +643,7 @@ class DocumentServiceRestTransport(_BaseDocumentServiceRestTransport): """REST backend synchronous transport for DocumentService. Service for ingesting - [Document][google.cloud.discoveryengine.v1alpha.Document] + `Document `__ information of the customer's website. This class defines the same methods as the primary client, so the @@ -937,7 +937,8 @@ def __call__( Args: request (~.document_service.BatchGetDocumentsMetadataRequest): The request object. Request message for - [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1alpha.DocumentService.BatchGetDocumentsMetadata] + `DocumentService.BatchGetDocumentsMetadata + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -950,7 +951,8 @@ def __call__( Returns: ~.document_service.BatchGetDocumentsMetadataResponse: Response message for - [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1alpha.DocumentService.BatchGetDocumentsMetadata] + `DocumentService.BatchGetDocumentsMetadata + `__ method. """ @@ -1095,7 +1097,8 @@ def __call__( Args: request (~.document_service.CreateDocumentRequest): The request object. Request message for - [DocumentService.CreateDocument][google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocument] + `DocumentService.CreateDocument + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1249,7 +1252,8 @@ def __call__( Args: request (~.document_service.DeleteDocumentRequest): The request object. Request message for - [DocumentService.DeleteDocument][google.cloud.discoveryengine.v1alpha.DocumentService.DeleteDocument] + `DocumentService.DeleteDocument + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1357,7 +1361,8 @@ def __call__( Args: request (~.document_service.GetDocumentRequest): The request object. Request message for - [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument] + `DocumentService.GetDocument + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1507,7 +1512,8 @@ def __call__( Args: request (~.document_service.GetProcessedDocumentRequest): The request object. Request message for - [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument] + `DocumentService.GetDocument + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1811,7 +1817,8 @@ def __call__( Args: request (~.document_service.ListDocumentsRequest): The request object. Request message for - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments] + `DocumentService.ListDocuments + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1824,7 +1831,8 @@ def __call__( Returns: ~.document_service.ListDocumentsResponse: Response message for - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments] + `DocumentService.ListDocuments + `__ method. """ @@ -1963,7 +1971,8 @@ def __call__( Args: request (~.purge_config.PurgeDocumentsRequest): The request object. Request message for - [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.PurgeDocuments] + `DocumentService.PurgeDocuments + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2116,7 +2125,8 @@ def __call__( Args: request (~.document_service.UpdateDocumentRequest): The request object. Request message for - [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1alpha.DocumentService.UpdateDocument] + `DocumentService.UpdateDocument + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/engine_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/engine_service/async_client.py index 6c654fc9e890..0650c7c3a825 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/engine_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/engine_service/async_client.py @@ -73,8 +73,8 @@ class EngineServiceAsyncClient: - """Service for managing - [Engine][google.cloud.discoveryengine.v1alpha.Engine] configuration. + """Service for managing `Engine + `__ configuration. """ _client: EngineServiceClient @@ -313,7 +313,8 @@ async def create_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Creates a [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + r"""Creates a `Engine + `__. .. code-block:: python @@ -354,34 +355,40 @@ async def sample_create_engine(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.CreateEngineRequest, dict]]): The request object. Request for - [EngineService.CreateEngine][google.cloud.discoveryengine.v1alpha.EngineService.CreateEngine] + `EngineService.CreateEngine + `__ method. parent (:class:`str`): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. engine (:class:`google.cloud.discoveryengine_v1alpha.types.Engine`): - Required. The - [Engine][google.cloud.discoveryengine.v1alpha.Engine] to - create. + Required. The `Engine + `__ + to create. This corresponds to the ``engine`` field on the ``request`` instance; if ``request`` is provided, this should not be set. engine_id (:class:`str`): Required. The ID to use for the - [Engine][google.cloud.discoveryengine.v1alpha.Engine], - which will become the final component of the - [Engine][google.cloud.discoveryengine.v1alpha.Engine]'s + `Engine + `__, + which will become the final component of + the + `Engine + `__'s resource name. - This field must conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. - Otherwise, an INVALID_ARGUMENT error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 + characters. Otherwise, an + INVALID_ARGUMENT error is returned. This corresponds to the ``engine_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -396,10 +403,14 @@ async def sample_create_engine(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.Engine` Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.Engine` + Metadata that describes the training and + serving parameters of an `Engine + `__. """ # Create or coerce a protobuf request object. @@ -472,7 +483,8 @@ async def delete_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Deletes a [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + r"""Deletes a `Engine + `__. .. code-block:: python @@ -507,22 +519,26 @@ async def sample_delete_engine(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.DeleteEngineRequest, dict]]): The request object. Request message for - [EngineService.DeleteEngine][google.cloud.discoveryengine.v1alpha.EngineService.DeleteEngine] + `EngineService.DeleteEngine + `__ method. name (:class:`str`): Required. Full resource name of - [Engine][google.cloud.discoveryengine.v1alpha.Engine], + `Engine + `__, such as ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. - If the caller does not have permission to delete the - [Engine][google.cloud.discoveryengine.v1alpha.Engine], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to delete the `Engine + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the - [Engine][google.cloud.discoveryengine.v1alpha.Engine] to - delete does not exist, a NOT_FOUND error is returned. + If the `Engine + `__ + to delete does not exist, a NOT_FOUND + error is returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -537,18 +553,21 @@ async def sample_delete_engine(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. @@ -618,7 +637,8 @@ async def update_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_engine.Engine: - r"""Updates an [Engine][google.cloud.discoveryengine.v1alpha.Engine] + r"""Updates an `Engine + `__ .. code-block:: python @@ -653,32 +673,37 @@ async def sample_update_engine(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.UpdateEngineRequest, dict]]): The request object. Request message for - [EngineService.UpdateEngine][google.cloud.discoveryengine.v1alpha.EngineService.UpdateEngine] + `EngineService.UpdateEngine + `__ method. engine (:class:`google.cloud.discoveryengine_v1alpha.types.Engine`): - Required. The - [Engine][google.cloud.discoveryengine.v1alpha.Engine] to - update. + Required. The `Engine + `__ + to update. - If the caller does not have permission to update the - [Engine][google.cloud.discoveryengine.v1alpha.Engine], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to update the `Engine + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the - [Engine][google.cloud.discoveryengine.v1alpha.Engine] to - update does not exist, a NOT_FOUND error is returned. + If the `Engine + `__ + to update does not exist, a NOT_FOUND + error is returned. This corresponds to the ``engine`` field on the ``request`` instance; if ``request`` is provided, this should not be set. update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): Indicates which fields in the provided - [Engine][google.cloud.discoveryengine.v1alpha.Engine] to - update. + `Engine + `__ + to update. - If an unsupported or unknown field is provided, an - INVALID_ARGUMENT error is returned. + If an unsupported or unknown field is + provided, an INVALID_ARGUMENT error is + returned. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -693,8 +718,9 @@ async def sample_update_engine(): Returns: google.cloud.discoveryengine_v1alpha.types.Engine: - Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ # Create or coerce a protobuf request object. @@ -759,7 +785,8 @@ async def get_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> engine.Engine: - r"""Gets a [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + r"""Gets a `Engine + `__. .. code-block:: python @@ -790,11 +817,13 @@ async def sample_get_engine(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.GetEngineRequest, dict]]): The request object. Request message for - [EngineService.GetEngine][google.cloud.discoveryengine.v1alpha.EngineService.GetEngine] + `EngineService.GetEngine + `__ method. name (:class:`str`): Required. Full resource name of - [Engine][google.cloud.discoveryengine.v1alpha.Engine], + `Engine + `__, such as ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. @@ -811,8 +840,9 @@ async def sample_get_engine(): Returns: google.cloud.discoveryengine_v1alpha.types.Engine: - Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ # Create or coerce a protobuf request object. @@ -873,8 +903,8 @@ async def list_engines( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListEnginesAsyncPager: - r"""Lists all the - [Engine][google.cloud.discoveryengine.v1alpha.Engine]s + r"""Lists all the `Engine + `__s associated with the project. .. code-block:: python @@ -907,10 +937,12 @@ async def sample_list_engines(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.ListEnginesRequest, dict]]): The request object. Request message for - [EngineService.ListEngines][google.cloud.discoveryengine.v1alpha.EngineService.ListEngines] + `EngineService.ListEngines + `__ method. parent (:class:`str`): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/collections/{collection_id}``. This corresponds to the ``parent`` field @@ -927,11 +959,13 @@ async def sample_list_engines(): Returns: google.cloud.discoveryengine_v1alpha.services.engine_service.pagers.ListEnginesAsyncPager: Response message for - [EngineService.ListEngines][google.cloud.discoveryengine.v1alpha.EngineService.ListEngines] - method. + `EngineService.ListEngines + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -1003,10 +1037,11 @@ async def pause_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> engine.Engine: - r"""Pauses the training of an existing engine. Only applicable if - [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + r"""Pauses the training of an existing engine. Only + applicable if `SolutionType + `__ + is `SOLUTION_TYPE_RECOMMENDATION + `__. .. code-block:: python @@ -1039,7 +1074,9 @@ async def sample_pause_engine(): The request object. Request for pausing training of an engine. name (:class:`str`): - Required. The name of the engine to pause. Format: + Required. The name of the engine to + pause. Format: + ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`` This corresponds to the ``name`` field @@ -1055,8 +1092,9 @@ async def sample_pause_engine(): Returns: google.cloud.discoveryengine_v1alpha.types.Engine: - Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ # Create or coerce a protobuf request object. @@ -1117,10 +1155,11 @@ async def resume_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> engine.Engine: - r"""Resumes the training of an existing engine. Only applicable if - [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + r"""Resumes the training of an existing engine. Only + applicable if `SolutionType + `__ + is `SOLUTION_TYPE_RECOMMENDATION + `__. .. code-block:: python @@ -1153,7 +1192,9 @@ async def sample_resume_engine(): The request object. Request for resuming training of an engine. name (:class:`str`): - Required. The name of the engine to resume. Format: + Required. The name of the engine to + resume. Format: + ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`` This corresponds to the ``name`` field @@ -1169,8 +1210,9 @@ async def sample_resume_engine(): Returns: google.cloud.discoveryengine_v1alpha.types.Engine: - Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ # Create or coerce a protobuf request object. @@ -1232,9 +1274,10 @@ async def tune_engine( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: r"""Tunes an existing engine. Only applicable if - [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + `SolutionType + `__ + is `SOLUTION_TYPE_RECOMMENDATION + `__. .. code-block:: python @@ -1273,8 +1316,9 @@ async def sample_tune_engine(): periodically scheduled tuning to happen). name (:class:`str`): - Required. The resource name of the engine to tune. - Format: + Required. The resource name of the + engine to tune. Format: + ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`` This corresponds to the ``name`` field @@ -1290,11 +1334,13 @@ async def sample_tune_engine(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1alpha.types.TuneEngineResponse` - Response associated with a tune operation. + Response associated with a tune + operation. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/engine_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/engine_service/client.py index a01cd08a95c2..70bea66e92c4 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/engine_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/engine_service/client.py @@ -117,8 +117,8 @@ def get_transport_class( class EngineServiceClient(metaclass=EngineServiceClientMeta): - """Service for managing - [Engine][google.cloud.discoveryengine.v1alpha.Engine] configuration. + """Service for managing `Engine + `__ configuration. """ @staticmethod @@ -758,7 +758,8 @@ def create_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Creates a [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + r"""Creates a `Engine + `__. .. code-block:: python @@ -799,34 +800,40 @@ def sample_create_engine(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.CreateEngineRequest, dict]): The request object. Request for - [EngineService.CreateEngine][google.cloud.discoveryengine.v1alpha.EngineService.CreateEngine] + `EngineService.CreateEngine + `__ method. parent (str): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. engine (google.cloud.discoveryengine_v1alpha.types.Engine): - Required. The - [Engine][google.cloud.discoveryengine.v1alpha.Engine] to - create. + Required. The `Engine + `__ + to create. This corresponds to the ``engine`` field on the ``request`` instance; if ``request`` is provided, this should not be set. engine_id (str): Required. The ID to use for the - [Engine][google.cloud.discoveryengine.v1alpha.Engine], - which will become the final component of the - [Engine][google.cloud.discoveryengine.v1alpha.Engine]'s + `Engine + `__, + which will become the final component of + the + `Engine + `__'s resource name. - This field must conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. - Otherwise, an INVALID_ARGUMENT error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 + characters. Otherwise, an + INVALID_ARGUMENT error is returned. This corresponds to the ``engine_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -841,10 +848,14 @@ def sample_create_engine(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.Engine` Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.Engine` + Metadata that describes the training and + serving parameters of an `Engine + `__. """ # Create or coerce a protobuf request object. @@ -914,7 +925,8 @@ def delete_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Deletes a [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + r"""Deletes a `Engine + `__. .. code-block:: python @@ -949,22 +961,26 @@ def sample_delete_engine(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.DeleteEngineRequest, dict]): The request object. Request message for - [EngineService.DeleteEngine][google.cloud.discoveryengine.v1alpha.EngineService.DeleteEngine] + `EngineService.DeleteEngine + `__ method. name (str): Required. Full resource name of - [Engine][google.cloud.discoveryengine.v1alpha.Engine], + `Engine + `__, such as ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. - If the caller does not have permission to delete the - [Engine][google.cloud.discoveryengine.v1alpha.Engine], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to delete the `Engine + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the - [Engine][google.cloud.discoveryengine.v1alpha.Engine] to - delete does not exist, a NOT_FOUND error is returned. + If the `Engine + `__ + to delete does not exist, a NOT_FOUND + error is returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -979,18 +995,21 @@ def sample_delete_engine(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. @@ -1057,7 +1076,8 @@ def update_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_engine.Engine: - r"""Updates an [Engine][google.cloud.discoveryengine.v1alpha.Engine] + r"""Updates an `Engine + `__ .. code-block:: python @@ -1092,32 +1112,37 @@ def sample_update_engine(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.UpdateEngineRequest, dict]): The request object. Request message for - [EngineService.UpdateEngine][google.cloud.discoveryengine.v1alpha.EngineService.UpdateEngine] + `EngineService.UpdateEngine + `__ method. engine (google.cloud.discoveryengine_v1alpha.types.Engine): - Required. The - [Engine][google.cloud.discoveryengine.v1alpha.Engine] to - update. + Required. The `Engine + `__ + to update. - If the caller does not have permission to update the - [Engine][google.cloud.discoveryengine.v1alpha.Engine], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to update the `Engine + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the - [Engine][google.cloud.discoveryengine.v1alpha.Engine] to - update does not exist, a NOT_FOUND error is returned. + If the `Engine + `__ + to update does not exist, a NOT_FOUND + error is returned. This corresponds to the ``engine`` field on the ``request`` instance; if ``request`` is provided, this should not be set. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [Engine][google.cloud.discoveryengine.v1alpha.Engine] to - update. + `Engine + `__ + to update. - If an unsupported or unknown field is provided, an - INVALID_ARGUMENT error is returned. + If an unsupported or unknown field is + provided, an INVALID_ARGUMENT error is + returned. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -1132,8 +1157,9 @@ def sample_update_engine(): Returns: google.cloud.discoveryengine_v1alpha.types.Engine: - Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ # Create or coerce a protobuf request object. @@ -1195,7 +1221,8 @@ def get_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> engine.Engine: - r"""Gets a [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + r"""Gets a `Engine + `__. .. code-block:: python @@ -1226,11 +1253,13 @@ def sample_get_engine(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.GetEngineRequest, dict]): The request object. Request message for - [EngineService.GetEngine][google.cloud.discoveryengine.v1alpha.EngineService.GetEngine] + `EngineService.GetEngine + `__ method. name (str): Required. Full resource name of - [Engine][google.cloud.discoveryengine.v1alpha.Engine], + `Engine + `__, such as ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. @@ -1247,8 +1276,9 @@ def sample_get_engine(): Returns: google.cloud.discoveryengine_v1alpha.types.Engine: - Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ # Create or coerce a protobuf request object. @@ -1306,8 +1336,8 @@ def list_engines( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListEnginesPager: - r"""Lists all the - [Engine][google.cloud.discoveryengine.v1alpha.Engine]s + r"""Lists all the `Engine + `__s associated with the project. .. code-block:: python @@ -1340,10 +1370,12 @@ def sample_list_engines(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.ListEnginesRequest, dict]): The request object. Request message for - [EngineService.ListEngines][google.cloud.discoveryengine.v1alpha.EngineService.ListEngines] + `EngineService.ListEngines + `__ method. parent (str): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/collections/{collection_id}``. This corresponds to the ``parent`` field @@ -1360,11 +1392,13 @@ def sample_list_engines(): Returns: google.cloud.discoveryengine_v1alpha.services.engine_service.pagers.ListEnginesPager: Response message for - [EngineService.ListEngines][google.cloud.discoveryengine.v1alpha.EngineService.ListEngines] - method. + `EngineService.ListEngines + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -1433,10 +1467,11 @@ def pause_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> engine.Engine: - r"""Pauses the training of an existing engine. Only applicable if - [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + r"""Pauses the training of an existing engine. Only + applicable if `SolutionType + `__ + is `SOLUTION_TYPE_RECOMMENDATION + `__. .. code-block:: python @@ -1469,7 +1504,9 @@ def sample_pause_engine(): The request object. Request for pausing training of an engine. name (str): - Required. The name of the engine to pause. Format: + Required. The name of the engine to + pause. Format: + ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`` This corresponds to the ``name`` field @@ -1485,8 +1522,9 @@ def sample_pause_engine(): Returns: google.cloud.discoveryengine_v1alpha.types.Engine: - Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ # Create or coerce a protobuf request object. @@ -1544,10 +1582,11 @@ def resume_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> engine.Engine: - r"""Resumes the training of an existing engine. Only applicable if - [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + r"""Resumes the training of an existing engine. Only + applicable if `SolutionType + `__ + is `SOLUTION_TYPE_RECOMMENDATION + `__. .. code-block:: python @@ -1580,7 +1619,9 @@ def sample_resume_engine(): The request object. Request for resuming training of an engine. name (str): - Required. The name of the engine to resume. Format: + Required. The name of the engine to + resume. Format: + ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`` This corresponds to the ``name`` field @@ -1596,8 +1637,9 @@ def sample_resume_engine(): Returns: google.cloud.discoveryengine_v1alpha.types.Engine: - Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ # Create or coerce a protobuf request object. @@ -1656,9 +1698,10 @@ def tune_engine( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: r"""Tunes an existing engine. Only applicable if - [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + `SolutionType + `__ + is `SOLUTION_TYPE_RECOMMENDATION + `__. .. code-block:: python @@ -1697,8 +1740,9 @@ def sample_tune_engine(): periodically scheduled tuning to happen). name (str): - Required. The resource name of the engine to tune. - Format: + Required. The resource name of the + engine to tune. Format: + ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`` This corresponds to the ``name`` field @@ -1714,11 +1758,13 @@ def sample_tune_engine(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1alpha.types.TuneEngineResponse` - Response associated with a tune operation. + Response associated with a tune + operation. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/engine_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/engine_service/transports/grpc.py index 804660e8de71..1161ed72317a 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/engine_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/engine_service/transports/grpc.py @@ -114,8 +114,8 @@ def intercept_unary_unary(self, continuation, client_call_details, request): class EngineServiceGrpcTransport(EngineServiceTransport): """gRPC backend transport for EngineService. - Service for managing - [Engine][google.cloud.discoveryengine.v1alpha.Engine] configuration. + Service for managing `Engine + `__ configuration. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -349,7 +349,8 @@ def create_engine( ) -> Callable[[engine_service.CreateEngineRequest], operations_pb2.Operation]: r"""Return a callable for the create engine method over gRPC. - Creates a [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + Creates a `Engine + `__. Returns: Callable[[~.CreateEngineRequest], @@ -375,7 +376,8 @@ def delete_engine( ) -> Callable[[engine_service.DeleteEngineRequest], operations_pb2.Operation]: r"""Return a callable for the delete engine method over gRPC. - Deletes a [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + Deletes a `Engine + `__. Returns: Callable[[~.DeleteEngineRequest], @@ -401,7 +403,8 @@ def update_engine( ) -> Callable[[engine_service.UpdateEngineRequest], gcd_engine.Engine]: r"""Return a callable for the update engine method over gRPC. - Updates an [Engine][google.cloud.discoveryengine.v1alpha.Engine] + Updates an `Engine + `__ Returns: Callable[[~.UpdateEngineRequest], @@ -425,7 +428,8 @@ def update_engine( def get_engine(self) -> Callable[[engine_service.GetEngineRequest], engine.Engine]: r"""Return a callable for the get engine method over gRPC. - Gets a [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + Gets a `Engine + `__. Returns: Callable[[~.GetEngineRequest], @@ -453,8 +457,8 @@ def list_engines( ]: r"""Return a callable for the list engines method over gRPC. - Lists all the - [Engine][google.cloud.discoveryengine.v1alpha.Engine]s + Lists all the `Engine + `__s associated with the project. Returns: @@ -481,10 +485,11 @@ def pause_engine( ) -> Callable[[engine_service.PauseEngineRequest], engine.Engine]: r"""Return a callable for the pause engine method over gRPC. - Pauses the training of an existing engine. Only applicable if - [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + Pauses the training of an existing engine. Only + applicable if `SolutionType + `__ + is `SOLUTION_TYPE_RECOMMENDATION + `__. Returns: Callable[[~.PauseEngineRequest], @@ -510,10 +515,11 @@ def resume_engine( ) -> Callable[[engine_service.ResumeEngineRequest], engine.Engine]: r"""Return a callable for the resume engine method over gRPC. - Resumes the training of an existing engine. Only applicable if - [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + Resumes the training of an existing engine. Only + applicable if `SolutionType + `__ + is `SOLUTION_TYPE_RECOMMENDATION + `__. Returns: Callable[[~.ResumeEngineRequest], @@ -540,9 +546,10 @@ def tune_engine( r"""Return a callable for the tune engine method over gRPC. Tunes an existing engine. Only applicable if - [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + `SolutionType + `__ + is `SOLUTION_TYPE_RECOMMENDATION + `__. Returns: Callable[[~.TuneEngineRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/engine_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/engine_service/transports/grpc_asyncio.py index e31cf83803e6..4a792da829de 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/engine_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/engine_service/transports/grpc_asyncio.py @@ -120,8 +120,8 @@ async def intercept_unary_unary(self, continuation, client_call_details, request class EngineServiceGrpcAsyncIOTransport(EngineServiceTransport): """gRPC AsyncIO backend transport for EngineService. - Service for managing - [Engine][google.cloud.discoveryengine.v1alpha.Engine] configuration. + Service for managing `Engine + `__ configuration. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -359,7 +359,8 @@ def create_engine( ]: r"""Return a callable for the create engine method over gRPC. - Creates a [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + Creates a `Engine + `__. Returns: Callable[[~.CreateEngineRequest], @@ -387,7 +388,8 @@ def delete_engine( ]: r"""Return a callable for the delete engine method over gRPC. - Deletes a [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + Deletes a `Engine + `__. Returns: Callable[[~.DeleteEngineRequest], @@ -413,7 +415,8 @@ def update_engine( ) -> Callable[[engine_service.UpdateEngineRequest], Awaitable[gcd_engine.Engine]]: r"""Return a callable for the update engine method over gRPC. - Updates an [Engine][google.cloud.discoveryengine.v1alpha.Engine] + Updates an `Engine + `__ Returns: Callable[[~.UpdateEngineRequest], @@ -439,7 +442,8 @@ def get_engine( ) -> Callable[[engine_service.GetEngineRequest], Awaitable[engine.Engine]]: r"""Return a callable for the get engine method over gRPC. - Gets a [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + Gets a `Engine + `__. Returns: Callable[[~.GetEngineRequest], @@ -468,8 +472,8 @@ def list_engines( ]: r"""Return a callable for the list engines method over gRPC. - Lists all the - [Engine][google.cloud.discoveryengine.v1alpha.Engine]s + Lists all the `Engine + `__s associated with the project. Returns: @@ -496,10 +500,11 @@ def pause_engine( ) -> Callable[[engine_service.PauseEngineRequest], Awaitable[engine.Engine]]: r"""Return a callable for the pause engine method over gRPC. - Pauses the training of an existing engine. Only applicable if - [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + Pauses the training of an existing engine. Only + applicable if `SolutionType + `__ + is `SOLUTION_TYPE_RECOMMENDATION + `__. Returns: Callable[[~.PauseEngineRequest], @@ -525,10 +530,11 @@ def resume_engine( ) -> Callable[[engine_service.ResumeEngineRequest], Awaitable[engine.Engine]]: r"""Return a callable for the resume engine method over gRPC. - Resumes the training of an existing engine. Only applicable if - [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + Resumes the training of an existing engine. Only + applicable if `SolutionType + `__ + is `SOLUTION_TYPE_RECOMMENDATION + `__. Returns: Callable[[~.ResumeEngineRequest], @@ -557,9 +563,10 @@ def tune_engine( r"""Return a callable for the tune engine method over gRPC. Tunes an existing engine. Only applicable if - [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + `SolutionType + `__ + is `SOLUTION_TYPE_RECOMMENDATION + `__. Returns: Callable[[~.TuneEngineRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/engine_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/engine_service/transports/rest.py index ebf00ce3ec1e..8cadaca0a949 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/engine_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/engine_service/transports/rest.py @@ -602,8 +602,8 @@ class EngineServiceRestStub: class EngineServiceRestTransport(_BaseEngineServiceRestTransport): """REST backend synchronous transport for EngineService. - Service for managing - [Engine][google.cloud.discoveryengine.v1alpha.Engine] configuration. + Service for managing `Engine + `__ configuration. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -895,7 +895,8 @@ def __call__( Args: request (~.engine_service.CreateEngineRequest): The request object. Request for - [EngineService.CreateEngine][google.cloud.discoveryengine.v1alpha.EngineService.CreateEngine] + `EngineService.CreateEngine + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1047,7 +1048,8 @@ def __call__( Args: request (~.engine_service.DeleteEngineRequest): The request object. Request message for - [EngineService.DeleteEngine][google.cloud.discoveryengine.v1alpha.EngineService.DeleteEngine] + `EngineService.DeleteEngine + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1194,7 +1196,8 @@ def __call__( Args: request (~.engine_service.GetEngineRequest): The request object. Request message for - [EngineService.GetEngine][google.cloud.discoveryengine.v1alpha.EngineService.GetEngine] + `EngineService.GetEngine + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1206,9 +1209,9 @@ def __call__( Returns: ~.engine.Engine: - Metadata that describes the training and serving - parameters of an - [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ @@ -1347,7 +1350,8 @@ def __call__( Args: request (~.engine_service.ListEnginesRequest): The request object. Request message for - [EngineService.ListEngines][google.cloud.discoveryengine.v1alpha.EngineService.ListEngines] + `EngineService.ListEngines + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1360,7 +1364,8 @@ def __call__( Returns: ~.engine_service.ListEnginesResponse: Response message for - [EngineService.ListEngines][google.cloud.discoveryengine.v1alpha.EngineService.ListEngines] + `EngineService.ListEngines + `__ method. """ @@ -1512,9 +1517,9 @@ def __call__( Returns: ~.engine.Engine: - Metadata that describes the training and serving - parameters of an - [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ @@ -1670,9 +1675,9 @@ def __call__( Returns: ~.engine.Engine: - Metadata that describes the training and serving - parameters of an - [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ @@ -1973,7 +1978,8 @@ def __call__( Args: request (~.engine_service.UpdateEngineRequest): The request object. Request message for - [EngineService.UpdateEngine][google.cloud.discoveryengine.v1alpha.EngineService.UpdateEngine] + `EngineService.UpdateEngine + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1985,9 +1991,9 @@ def __call__( Returns: ~.gcd_engine.Engine: - Metadata that describes the training and serving - parameters of an - [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/estimate_billing_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/estimate_billing_service/async_client.py index 55863e8bcacd..a02790682e5a 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/estimate_billing_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/estimate_billing_service/async_client.py @@ -342,7 +342,8 @@ async def sample_estimate_data_size(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.EstimateDataSizeRequest, dict]]): The request object. Request message for - [EstimateBillingService.EstimateDataSize][google.cloud.discoveryengine.v1alpha.EstimateBillingService.EstimateDataSize] + `EstimateBillingService.EstimateDataSize + `__ method retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -354,13 +355,17 @@ async def sample_estimate_data_size(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.EstimateDataSizeResponse` Response of the EstimateDataSize request. If the long running - operation was successful, then this message is - returned by the - google.longrunning.Operations.response field if the - operation was successful. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.EstimateDataSizeResponse` + Response of the EstimateDataSize + request. If the long running operation + was successful, then this message is + returned by the + google.longrunning.Operations.response + field if the operation was successful. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/estimate_billing_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/estimate_billing_service/client.py index 295d28caae98..0302a8ee4c87 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/estimate_billing_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/estimate_billing_service/client.py @@ -761,7 +761,8 @@ def sample_estimate_data_size(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.EstimateDataSizeRequest, dict]): The request object. Request message for - [EstimateBillingService.EstimateDataSize][google.cloud.discoveryengine.v1alpha.EstimateBillingService.EstimateDataSize] + `EstimateBillingService.EstimateDataSize + `__ method retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -773,13 +774,17 @@ def sample_estimate_data_size(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.EstimateDataSizeResponse` Response of the EstimateDataSize request. If the long running - operation was successful, then this message is - returned by the - google.longrunning.Operations.response field if the - operation was successful. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.EstimateDataSizeResponse` + Response of the EstimateDataSize + request. If the long running operation + was successful, then this message is + returned by the + google.longrunning.Operations.response + field if the operation was successful. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/estimate_billing_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/estimate_billing_service/transports/rest.py index 399c5d25dd0d..cc5cf9161298 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/estimate_billing_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/estimate_billing_service/transports/rest.py @@ -514,7 +514,8 @@ def __call__( Args: request (~.estimate_billing_service.EstimateDataSizeRequest): The request object. Request message for - [EstimateBillingService.EstimateDataSize][google.cloud.discoveryengine.v1alpha.EstimateBillingService.EstimateDataSize] + `EstimateBillingService.EstimateDataSize + `__ method retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/evaluation_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/evaluation_service/async_client.py index 27c72b9a272a..54174e68e70c 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/evaluation_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/evaluation_service/async_client.py @@ -72,7 +72,8 @@ class EvaluationServiceAsyncClient: """Service for managing - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s, + `Evaluation + `__s, """ _client: EvaluationServiceClient @@ -331,8 +332,8 @@ async def get_evaluation( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> evaluation.Evaluation: - r"""Gets a - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]. + r"""Gets a `Evaluation + `__. .. code-block:: python @@ -363,22 +364,27 @@ async def sample_get_evaluation(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.GetEvaluationRequest, dict]]): The request object. Request message for - [EvaluationService.GetEvaluation][google.cloud.discoveryengine.v1alpha.EvaluationService.GetEvaluation] + `EvaluationService.GetEvaluation + `__ method. name (:class:`str`): Required. Full resource name of - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation], + `Evaluation + `__, such as ``projects/{project}/locations/{location}/evaluations/{evaluation}``. - If the caller does not have permission to access the - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `Evaluation + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. If the requested - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation] - does not exist, a NOT_FOUND error is returned. + `Evaluation + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -460,7 +466,8 @@ async def list_evaluations( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListEvaluationsAsyncPager: r"""Gets a list of - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s. + `Evaluation + `__s. .. code-block:: python @@ -492,17 +499,20 @@ async def sample_list_evaluations(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.ListEvaluationsRequest, dict]]): The request object. Request message for - [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluations] + `EvaluationService.ListEvaluations + `__ method. parent (:class:`str`): - Required. The parent location resource name, such as + Required. The parent location resource + name, such as ``projects/{project}/locations/{location}``. - If the caller does not have permission to list - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s - under this location, regardless of whether or not this - location exists, a ``PERMISSION_DENIED`` error is - returned. + If the caller does not have permission + to list `Evaluation + `__s + under this location, regardless of + whether or not this location exists, a + ``PERMISSION_DENIED`` error is returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -518,11 +528,13 @@ async def sample_list_evaluations(): Returns: google.cloud.discoveryengine_v1alpha.services.evaluation_service.pagers.ListEvaluationsAsyncPager: Response message for - [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluations] - method. + `EvaluationService.ListEvaluations + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -597,11 +609,10 @@ async def create_evaluation( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Creates a - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]. - - Upon creation, the evaluation will be automatically triggered - and begin execution. + r"""Creates a `Evaluation + `__. + Upon creation, the evaluation will be automatically + triggered and begin execution. .. code-block:: python @@ -641,18 +652,20 @@ async def sample_create_evaluation(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.CreateEvaluationRequest, dict]]): The request object. Request message for - [EvaluationService.CreateEvaluation][google.cloud.discoveryengine.v1alpha.EvaluationService.CreateEvaluation] + `EvaluationService.CreateEvaluation + `__ method. parent (:class:`str`): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. evaluation (:class:`google.cloud.discoveryengine_v1alpha.types.Evaluation`): - Required. The - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation] + Required. The `Evaluation + `__ to create. This corresponds to the ``evaluation`` field @@ -668,11 +681,15 @@ async def sample_create_evaluation(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.Evaluation` An evaluation is a single execution (or run) of an evaluation process. It - encapsulates the state of the evaluation and the - resulting data. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.Evaluation` + An evaluation is a single execution (or + run) of an evaluation process. It + encapsulates the state of the evaluation + and the resulting data. """ # Create or coerce a protobuf request object. @@ -746,7 +763,8 @@ async def list_evaluation_results( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListEvaluationResultsAsyncPager: r"""Gets a list of results for a given a - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]. + `Evaluation + `__. .. code-block:: python @@ -778,15 +796,18 @@ async def sample_list_evaluation_results(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.ListEvaluationResultsRequest, dict]]): The request object. Request message for - [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluationResults] + `EvaluationService.ListEvaluationResults + `__ method. evaluation (:class:`str`): - Required. The evaluation resource name, such as + Required. The evaluation resource name, + such as ``projects/{project}/locations/{location}/evaluations/{evaluation}``. - If the caller does not have permission to list - [EvaluationResult][] under this evaluation, regardless - of whether or not this evaluation set exists, a + If the caller does not have permission + to list [EvaluationResult][] under this + evaluation, regardless of whether or not + this evaluation set exists, a ``PERMISSION_DENIED`` error is returned. This corresponds to the ``evaluation`` field @@ -803,11 +824,13 @@ async def sample_list_evaluation_results(): Returns: google.cloud.discoveryengine_v1alpha.services.evaluation_service.pagers.ListEvaluationResultsAsyncPager: Response message for - [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluationResults] - method. + `EvaluationService.ListEvaluationResults + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/evaluation_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/evaluation_service/client.py index 4ba0e1bdd446..e65c38f305a0 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/evaluation_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/evaluation_service/client.py @@ -118,7 +118,8 @@ def get_transport_class( class EvaluationServiceClient(metaclass=EvaluationServiceClientMeta): """Service for managing - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s, + `Evaluation + `__s, """ @staticmethod @@ -894,8 +895,8 @@ def get_evaluation( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> evaluation.Evaluation: - r"""Gets a - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]. + r"""Gets a `Evaluation + `__. .. code-block:: python @@ -926,22 +927,27 @@ def sample_get_evaluation(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.GetEvaluationRequest, dict]): The request object. Request message for - [EvaluationService.GetEvaluation][google.cloud.discoveryengine.v1alpha.EvaluationService.GetEvaluation] + `EvaluationService.GetEvaluation + `__ method. name (str): Required. Full resource name of - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation], + `Evaluation + `__, such as ``projects/{project}/locations/{location}/evaluations/{evaluation}``. - If the caller does not have permission to access the - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `Evaluation + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. If the requested - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation] - does not exist, a NOT_FOUND error is returned. + `Evaluation + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -1020,7 +1026,8 @@ def list_evaluations( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListEvaluationsPager: r"""Gets a list of - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s. + `Evaluation + `__s. .. code-block:: python @@ -1052,17 +1059,20 @@ def sample_list_evaluations(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.ListEvaluationsRequest, dict]): The request object. Request message for - [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluations] + `EvaluationService.ListEvaluations + `__ method. parent (str): - Required. The parent location resource name, such as + Required. The parent location resource + name, such as ``projects/{project}/locations/{location}``. - If the caller does not have permission to list - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s - under this location, regardless of whether or not this - location exists, a ``PERMISSION_DENIED`` error is - returned. + If the caller does not have permission + to list `Evaluation + `__s + under this location, regardless of + whether or not this location exists, a + ``PERMISSION_DENIED`` error is returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -1078,11 +1088,13 @@ def sample_list_evaluations(): Returns: google.cloud.discoveryengine_v1alpha.services.evaluation_service.pagers.ListEvaluationsPager: Response message for - [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluations] - method. + `EvaluationService.ListEvaluations + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -1154,11 +1166,10 @@ def create_evaluation( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Creates a - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]. - - Upon creation, the evaluation will be automatically triggered - and begin execution. + r"""Creates a `Evaluation + `__. + Upon creation, the evaluation will be automatically + triggered and begin execution. .. code-block:: python @@ -1198,18 +1209,20 @@ def sample_create_evaluation(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.CreateEvaluationRequest, dict]): The request object. Request message for - [EvaluationService.CreateEvaluation][google.cloud.discoveryengine.v1alpha.EvaluationService.CreateEvaluation] + `EvaluationService.CreateEvaluation + `__ method. parent (str): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. evaluation (google.cloud.discoveryengine_v1alpha.types.Evaluation): - Required. The - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation] + Required. The `Evaluation + `__ to create. This corresponds to the ``evaluation`` field @@ -1225,11 +1238,15 @@ def sample_create_evaluation(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.Evaluation` An evaluation is a single execution (or run) of an evaluation process. It - encapsulates the state of the evaluation and the - resulting data. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.Evaluation` + An evaluation is a single execution (or + run) of an evaluation process. It + encapsulates the state of the evaluation + and the resulting data. """ # Create or coerce a protobuf request object. @@ -1300,7 +1317,8 @@ def list_evaluation_results( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListEvaluationResultsPager: r"""Gets a list of results for a given a - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]. + `Evaluation + `__. .. code-block:: python @@ -1332,15 +1350,18 @@ def sample_list_evaluation_results(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.ListEvaluationResultsRequest, dict]): The request object. Request message for - [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluationResults] + `EvaluationService.ListEvaluationResults + `__ method. evaluation (str): - Required. The evaluation resource name, such as + Required. The evaluation resource name, + such as ``projects/{project}/locations/{location}/evaluations/{evaluation}``. - If the caller does not have permission to list - [EvaluationResult][] under this evaluation, regardless - of whether or not this evaluation set exists, a + If the caller does not have permission + to list [EvaluationResult][] under this + evaluation, regardless of whether or not + this evaluation set exists, a ``PERMISSION_DENIED`` error is returned. This corresponds to the ``evaluation`` field @@ -1357,11 +1378,13 @@ def sample_list_evaluation_results(): Returns: google.cloud.discoveryengine_v1alpha.services.evaluation_service.pagers.ListEvaluationResultsPager: Response message for - [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluationResults] - method. + `EvaluationService.ListEvaluationResults + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/evaluation_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/evaluation_service/transports/grpc.py index 344488b60937..24f43ffa9dc3 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/evaluation_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/evaluation_service/transports/grpc.py @@ -113,7 +113,8 @@ class EvaluationServiceGrpcTransport(EvaluationServiceTransport): """gRPC backend transport for EvaluationService. Service for managing - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s, + `Evaluation + `__s, This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -347,8 +348,8 @@ def get_evaluation( ) -> Callable[[evaluation_service.GetEvaluationRequest], evaluation.Evaluation]: r"""Return a callable for the get evaluation method over gRPC. - Gets a - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]. + Gets a `Evaluation + `__. Returns: Callable[[~.GetEvaluationRequest], @@ -378,7 +379,8 @@ def list_evaluations( r"""Return a callable for the list evaluations method over gRPC. Gets a list of - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s. + `Evaluation + `__s. Returns: Callable[[~.ListEvaluationsRequest], @@ -406,11 +408,10 @@ def create_evaluation( ]: r"""Return a callable for the create evaluation method over gRPC. - Creates a - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]. - - Upon creation, the evaluation will be automatically triggered - and begin execution. + Creates a `Evaluation + `__. + Upon creation, the evaluation will be automatically + triggered and begin execution. Returns: Callable[[~.CreateEvaluationRequest], @@ -440,7 +441,8 @@ def list_evaluation_results( r"""Return a callable for the list evaluation results method over gRPC. Gets a list of results for a given a - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]. + `Evaluation + `__. Returns: Callable[[~.ListEvaluationResultsRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/evaluation_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/evaluation_service/transports/grpc_asyncio.py index b35d2cf49836..5ababe0da753 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/evaluation_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/evaluation_service/transports/grpc_asyncio.py @@ -119,7 +119,8 @@ class EvaluationServiceGrpcAsyncIOTransport(EvaluationServiceTransport): """gRPC AsyncIO backend transport for EvaluationService. Service for managing - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s, + `Evaluation + `__s, This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -357,8 +358,8 @@ def get_evaluation( ]: r"""Return a callable for the get evaluation method over gRPC. - Gets a - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]. + Gets a `Evaluation + `__. Returns: Callable[[~.GetEvaluationRequest], @@ -388,7 +389,8 @@ def list_evaluations( r"""Return a callable for the list evaluations method over gRPC. Gets a list of - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s. + `Evaluation + `__s. Returns: Callable[[~.ListEvaluationsRequest], @@ -417,11 +419,10 @@ def create_evaluation( ]: r"""Return a callable for the create evaluation method over gRPC. - Creates a - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]. - - Upon creation, the evaluation will be automatically triggered - and begin execution. + Creates a `Evaluation + `__. + Upon creation, the evaluation will be automatically + triggered and begin execution. Returns: Callable[[~.CreateEvaluationRequest], @@ -451,7 +452,8 @@ def list_evaluation_results( r"""Return a callable for the list evaluation results method over gRPC. Gets a list of results for a given a - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]. + `Evaluation + `__. Returns: Callable[[~.ListEvaluationResultsRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/evaluation_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/evaluation_service/transports/rest.py index ac044da80ed0..a7cfe17ab4ca 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/evaluation_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/evaluation_service/transports/rest.py @@ -398,7 +398,8 @@ class EvaluationServiceRestTransport(_BaseEvaluationServiceRestTransport): """REST backend synchronous transport for EvaluationService. Service for managing - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s, + `Evaluation + `__s, This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -691,7 +692,8 @@ def __call__( Args: request (~.evaluation_service.CreateEvaluationRequest): The request object. Request message for - [EvaluationService.CreateEvaluation][google.cloud.discoveryengine.v1alpha.EvaluationService.CreateEvaluation] + `EvaluationService.CreateEvaluation + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -846,7 +848,8 @@ def __call__( Args: request (~.evaluation_service.GetEvaluationRequest): The request object. Request message for - [EvaluationService.GetEvaluation][google.cloud.discoveryengine.v1alpha.EvaluationService.GetEvaluation] + `EvaluationService.GetEvaluation + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -997,7 +1000,8 @@ def __call__( Args: request (~.evaluation_service.ListEvaluationResultsRequest): The request object. Request message for - [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluationResults] + `EvaluationService.ListEvaluationResults + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1010,7 +1014,8 @@ def __call__( Returns: ~.evaluation_service.ListEvaluationResultsResponse: Response message for - [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluationResults] + `EvaluationService.ListEvaluationResults + `__ method. """ @@ -1155,7 +1160,8 @@ def __call__( Args: request (~.evaluation_service.ListEvaluationsRequest): The request object. Request message for - [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluations] + `EvaluationService.ListEvaluations + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1168,7 +1174,8 @@ def __call__( Returns: ~.evaluation_service.ListEvaluationsResponse: Response message for - [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluations] + `EvaluationService.ListEvaluations + `__ method. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/grounded_generation_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/grounded_generation_service/async_client.py index 0612b2bb6a49..11a7a4426e01 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/grounded_generation_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/grounded_generation_service/async_client.py @@ -349,7 +349,8 @@ async def sample_check_grounding(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.CheckGroundingRequest, dict]]): The request object. Request message for - [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1alpha.GroundedGenerationService.CheckGrounding] + `GroundedGenerationService.CheckGrounding + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -362,8 +363,9 @@ async def sample_check_grounding(): Returns: google.cloud.discoveryengine_v1alpha.types.CheckGroundingResponse: Response message for the - [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1alpha.GroundedGenerationService.CheckGrounding] - method. + `GroundedGenerationService.CheckGrounding + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/grounded_generation_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/grounded_generation_service/client.py index 95e72a67404d..5722fc37a87a 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/grounded_generation_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/grounded_generation_service/client.py @@ -765,7 +765,8 @@ def sample_check_grounding(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.CheckGroundingRequest, dict]): The request object. Request message for - [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1alpha.GroundedGenerationService.CheckGrounding] + `GroundedGenerationService.CheckGrounding + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -778,8 +779,9 @@ def sample_check_grounding(): Returns: google.cloud.discoveryengine_v1alpha.types.CheckGroundingResponse: Response message for the - [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1alpha.GroundedGenerationService.CheckGrounding] - method. + `GroundedGenerationService.CheckGrounding + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/grounded_generation_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/grounded_generation_service/transports/rest.py index a13211031044..7ed8392314cb 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/grounded_generation_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/grounded_generation_service/transports/rest.py @@ -346,7 +346,8 @@ def __call__( Args: request (~.grounded_generation_service.CheckGroundingRequest): The request object. Request message for - [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1alpha.GroundedGenerationService.CheckGrounding] + `GroundedGenerationService.CheckGrounding + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -359,7 +360,8 @@ def __call__( Returns: ~.grounded_generation_service.CheckGroundingResponse: Response message for the - [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1alpha.GroundedGenerationService.CheckGrounding] + `GroundedGenerationService.CheckGrounding + `__ method. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/project_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/project_service/async_client.py index 2a7ea2e10abc..36ec76c88094 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/project_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/project_service/async_client.py @@ -70,7 +70,7 @@ class ProjectServiceAsyncClient: """Service for operations on the - [Project][google.cloud.discoveryengine.v1alpha.Project]. + `Project `__. """ _client: ProjectServiceClient @@ -305,7 +305,8 @@ async def get_project( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> project.Project: - r"""Gets a [Project][google.cloud.discoveryengine.v1alpha.Project]. + r"""Gets a `Project + `__. Returns NOT_FOUND when the project is not yet created. .. code-block:: python @@ -337,12 +338,15 @@ async def sample_get_project(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.GetProjectRequest, dict]]): The request object. Request message for - [ProjectService.GetProject][google.cloud.discoveryengine.v1alpha.ProjectService.GetProject] + `ProjectService.GetProject + `__ method. name (:class:`str`): Required. Full resource name of a - [Project][google.cloud.discoveryengine.v1alpha.Project], - such as ``projects/{project_id_or_number}``. + `Project + `__, + such as + ``projects/{project_id_or_number}``. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -419,13 +423,14 @@ async def provision_project( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Provisions the project resource. During the process, related - systems will get prepared and initialized. + r"""Provisions the project resource. During the + process, related systems will get prepared and + initialized. Caller must read the `Terms for data - use `__, and - optionally specify in request to provide consent to that service - terms. + use `__, + and optionally specify in request to provide consent to + that service terms. .. code-block:: python @@ -462,12 +467,15 @@ async def sample_provision_project(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.ProvisionProjectRequest, dict]]): The request object. Request for - [ProjectService.ProvisionProject][google.cloud.discoveryengine.v1alpha.ProjectService.ProvisionProject] + `ProjectService.ProvisionProject + `__ method. name (:class:`str`): Required. Full resource name of a - [Project][google.cloud.discoveryengine.v1alpha.Project], - such as ``projects/{project_id_or_number}``. + `Project + `__, + such as + ``projects/{project_id_or_number}``. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -482,12 +490,13 @@ async def sample_provision_project(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1alpha.types.Project` - Metadata and configurations for a Google Cloud project - in the service. + Metadata and configurations for a Google + Cloud project in the service. """ # Create or coerce a protobuf request object. @@ -565,13 +574,13 @@ async def report_consent_change( ) -> gcd_project.Project: r"""Updates service terms for this project. - This method can be used to retroactively accept the latest - terms. + This method can be used to retroactively accept the + latest terms. Terms available for update: - - `Terms for data - use `__ + * `Terms for data use + `__ .. code-block:: python @@ -617,21 +626,27 @@ async def sample_report_consent_change(): should not be set. project (:class:`str`): Required. Full resource name of a - [Project][google.cloud.discoveryengine.v1alpha.Project], - such as ``projects/{project_id_or_number}``. + `Project + `__, + such as + ``projects/{project_id_or_number}``. This corresponds to the ``project`` field on the ``request`` instance; if ``request`` is provided, this should not be set. service_term_id (:class:`str`): - Required. The unique identifier of the terms of service - to update. Available term ids: - - - ``GA_DATA_USE_TERMS``: `Terms for data - use `__. - When using this service term id, the acceptable - [service_term_version][google.cloud.discoveryengine.v1alpha.ReportConsentChangeRequest.service_term_version] - to provide is ``2022-11-23``. + Required. The unique identifier of the + terms of service to update. Available + term ids: + + * ``GA_DATA_USE_TERMS``: `Terms for data + use + `__. + When using this service term id, the + acceptable + `service_term_version + `__ + to provide is ``2022-11-23``. This corresponds to the ``service_term_id`` field on the ``request`` instance; if ``request`` is provided, this diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/project_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/project_service/client.py index 78f02e76e4ff..ad3f2bfa059e 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/project_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/project_service/client.py @@ -116,7 +116,7 @@ def get_transport_class( class ProjectServiceClient(metaclass=ProjectServiceClientMeta): """Service for operations on the - [Project][google.cloud.discoveryengine.v1alpha.Project]. + `Project `__. """ @staticmethod @@ -721,7 +721,8 @@ def get_project( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> project.Project: - r"""Gets a [Project][google.cloud.discoveryengine.v1alpha.Project]. + r"""Gets a `Project + `__. Returns NOT_FOUND when the project is not yet created. .. code-block:: python @@ -753,12 +754,15 @@ def sample_get_project(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.GetProjectRequest, dict]): The request object. Request message for - [ProjectService.GetProject][google.cloud.discoveryengine.v1alpha.ProjectService.GetProject] + `ProjectService.GetProject + `__ method. name (str): Required. Full resource name of a - [Project][google.cloud.discoveryengine.v1alpha.Project], - such as ``projects/{project_id_or_number}``. + `Project + `__, + such as + ``projects/{project_id_or_number}``. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -832,13 +836,14 @@ def provision_project( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Provisions the project resource. During the process, related - systems will get prepared and initialized. + r"""Provisions the project resource. During the + process, related systems will get prepared and + initialized. Caller must read the `Terms for data - use `__, and - optionally specify in request to provide consent to that service - terms. + use `__, + and optionally specify in request to provide consent to + that service terms. .. code-block:: python @@ -875,12 +880,15 @@ def sample_provision_project(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.ProvisionProjectRequest, dict]): The request object. Request for - [ProjectService.ProvisionProject][google.cloud.discoveryengine.v1alpha.ProjectService.ProvisionProject] + `ProjectService.ProvisionProject + `__ method. name (str): Required. Full resource name of a - [Project][google.cloud.discoveryengine.v1alpha.Project], - such as ``projects/{project_id_or_number}``. + `Project + `__, + such as + ``projects/{project_id_or_number}``. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -895,12 +903,13 @@ def sample_provision_project(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1alpha.types.Project` - Metadata and configurations for a Google Cloud project - in the service. + Metadata and configurations for a Google + Cloud project in the service. """ # Create or coerce a protobuf request object. @@ -975,13 +984,13 @@ def report_consent_change( ) -> gcd_project.Project: r"""Updates service terms for this project. - This method can be used to retroactively accept the latest - terms. + This method can be used to retroactively accept the + latest terms. Terms available for update: - - `Terms for data - use `__ + * `Terms for data use + `__ .. code-block:: python @@ -1027,21 +1036,27 @@ def sample_report_consent_change(): should not be set. project (str): Required. Full resource name of a - [Project][google.cloud.discoveryengine.v1alpha.Project], - such as ``projects/{project_id_or_number}``. + `Project + `__, + such as + ``projects/{project_id_or_number}``. This corresponds to the ``project`` field on the ``request`` instance; if ``request`` is provided, this should not be set. service_term_id (str): - Required. The unique identifier of the terms of service - to update. Available term ids: - - - ``GA_DATA_USE_TERMS``: `Terms for data - use `__. - When using this service term id, the acceptable - [service_term_version][google.cloud.discoveryengine.v1alpha.ReportConsentChangeRequest.service_term_version] - to provide is ``2022-11-23``. + Required. The unique identifier of the + terms of service to update. Available + term ids: + + * ``GA_DATA_USE_TERMS``: `Terms for data + use + `__. + When using this service term id, the + acceptable + `service_term_version + `__ + to provide is ``2022-11-23``. This corresponds to the ``service_term_id`` field on the ``request`` instance; if ``request`` is provided, this diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/project_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/project_service/transports/grpc.py index 08f815e86000..018a65ec3424 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/project_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/project_service/transports/grpc.py @@ -115,7 +115,7 @@ class ProjectServiceGrpcTransport(ProjectServiceTransport): """gRPC backend transport for ProjectService. Service for operations on the - [Project][google.cloud.discoveryengine.v1alpha.Project]. + `Project `__. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -349,7 +349,8 @@ def get_project( ) -> Callable[[project_service.GetProjectRequest], project.Project]: r"""Return a callable for the get project method over gRPC. - Gets a [Project][google.cloud.discoveryengine.v1alpha.Project]. + Gets a `Project + `__. Returns NOT_FOUND when the project is not yet created. Returns: @@ -376,13 +377,14 @@ def provision_project( ) -> Callable[[project_service.ProvisionProjectRequest], operations_pb2.Operation]: r"""Return a callable for the provision project method over gRPC. - Provisions the project resource. During the process, related - systems will get prepared and initialized. + Provisions the project resource. During the + process, related systems will get prepared and + initialized. Caller must read the `Terms for data - use `__, and - optionally specify in request to provide consent to that service - terms. + use `__, + and optionally specify in request to provide consent to + that service terms. Returns: Callable[[~.ProvisionProjectRequest], @@ -410,13 +412,13 @@ def report_consent_change( Updates service terms for this project. - This method can be used to retroactively accept the latest - terms. + This method can be used to retroactively accept the + latest terms. Terms available for update: - - `Terms for data - use `__ + * `Terms for data use + `__ Returns: Callable[[~.ReportConsentChangeRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/project_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/project_service/transports/grpc_asyncio.py index 4589504386c2..7f3817a83600 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/project_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/project_service/transports/grpc_asyncio.py @@ -121,7 +121,7 @@ class ProjectServiceGrpcAsyncIOTransport(ProjectServiceTransport): """gRPC AsyncIO backend transport for ProjectService. Service for operations on the - [Project][google.cloud.discoveryengine.v1alpha.Project]. + `Project `__. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -357,7 +357,8 @@ def get_project( ) -> Callable[[project_service.GetProjectRequest], Awaitable[project.Project]]: r"""Return a callable for the get project method over gRPC. - Gets a [Project][google.cloud.discoveryengine.v1alpha.Project]. + Gets a `Project + `__. Returns NOT_FOUND when the project is not yet created. Returns: @@ -386,13 +387,14 @@ def provision_project( ]: r"""Return a callable for the provision project method over gRPC. - Provisions the project resource. During the process, related - systems will get prepared and initialized. + Provisions the project resource. During the + process, related systems will get prepared and + initialized. Caller must read the `Terms for data - use `__, and - optionally specify in request to provide consent to that service - terms. + use `__, + and optionally specify in request to provide consent to + that service terms. Returns: Callable[[~.ProvisionProjectRequest], @@ -422,13 +424,13 @@ def report_consent_change( Updates service terms for this project. - This method can be used to retroactively accept the latest - terms. + This method can be used to retroactively accept the + latest terms. Terms available for update: - - `Terms for data - use `__ + * `Terms for data use + `__ Returns: Callable[[~.ReportConsentChangeRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/project_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/project_service/transports/rest.py index 238189fe25fe..1eda3b3407a8 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/project_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/project_service/transports/rest.py @@ -334,7 +334,7 @@ class ProjectServiceRestTransport(_BaseProjectServiceRestTransport): """REST backend synchronous transport for ProjectService. Service for operations on the - [Project][google.cloud.discoveryengine.v1alpha.Project]. + `Project `__. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -625,7 +625,8 @@ def __call__( Args: request (~.project_service.GetProjectRequest): The request object. Request message for - [ProjectService.GetProject][google.cloud.discoveryengine.v1alpha.ProjectService.GetProject] + `ProjectService.GetProject + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -776,7 +777,8 @@ def __call__( Args: request (~.project_service.ProvisionProjectRequest): The request object. Request for - [ProjectService.ProvisionProject][google.cloud.discoveryengine.v1alpha.ProjectService.ProvisionProject] + `ProjectService.ProvisionProject + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/rank_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/rank_service/async_client.py index 477f0ce1aec9..437317bd5c0d 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/rank_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/rank_service/async_client.py @@ -327,7 +327,8 @@ async def sample_rank(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.RankRequest, dict]]): The request object. Request message for - [RankService.Rank][google.cloud.discoveryengine.v1alpha.RankService.Rank] + `RankService.Rank + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -340,8 +341,9 @@ async def sample_rank(): Returns: google.cloud.discoveryengine_v1alpha.types.RankResponse: Response message for - [RankService.Rank][google.cloud.discoveryengine.v1alpha.RankService.Rank] - method. + `RankService.Rank + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/rank_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/rank_service/client.py index 9e1b8a48fd14..8387271e8789 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/rank_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/rank_service/client.py @@ -747,7 +747,8 @@ def sample_rank(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.RankRequest, dict]): The request object. Request message for - [RankService.Rank][google.cloud.discoveryengine.v1alpha.RankService.Rank] + `RankService.Rank + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -760,8 +761,9 @@ def sample_rank(): Returns: google.cloud.discoveryengine_v1alpha.types.RankResponse: Response message for - [RankService.Rank][google.cloud.discoveryengine.v1alpha.RankService.Rank] - method. + `RankService.Rank + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/rank_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/rank_service/transports/rest.py index 5addf747c92e..2ee2f97ecd1d 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/rank_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/rank_service/transports/rest.py @@ -335,7 +335,8 @@ def __call__( Args: request (~.rank_service.RankRequest): The request object. Request message for - [RankService.Rank][google.cloud.discoveryengine.v1alpha.RankService.Rank] + `RankService.Rank + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -348,7 +349,8 @@ def __call__( Returns: ~.rank_service.RankResponse: Response message for - [RankService.Rank][google.cloud.discoveryengine.v1alpha.RankService.Rank] + `RankService.Rank + `__ method. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_service/async_client.py index ccc37228b156..119c794659aa 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_service/async_client.py @@ -73,7 +73,8 @@ class SampleQueryServiceAsyncClient: """Service for managing - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s, + `SampleQuery + `__s, """ _client: SampleQueryServiceClient @@ -320,8 +321,8 @@ async def get_sample_query( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> sample_query.SampleQuery: - r"""Gets a - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]. + r"""Gets a `SampleQuery + `__. .. code-block:: python @@ -352,22 +353,27 @@ async def sample_get_sample_query(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.GetSampleQueryRequest, dict]]): The request object. Request message for - [SampleQueryService.GetSampleQuery][google.cloud.discoveryengine.v1alpha.SampleQueryService.GetSampleQuery] + `SampleQueryService.GetSampleQuery + `__ method. name (:class:`str`): Required. Full resource name of - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], + `SampleQuery + `__, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}``. - If the caller does not have permission to access the - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `SampleQuery + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. If the requested - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] - does not exist, a NOT_FOUND error is returned. + `SampleQuery + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -447,7 +453,8 @@ async def list_sample_queries( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListSampleQueriesAsyncPager: r"""Gets a list of - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s. + `SampleQuery + `__s. .. code-block:: python @@ -479,18 +486,21 @@ async def sample_list_sample_queries(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.ListSampleQueriesRequest, dict]]): The request object. Request message for - [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueries] + `SampleQueryService.ListSampleQueries + `__ method. parent (:class:`str`): - Required. The parent sample query set resource name, - such as + Required. The parent sample query set + resource name, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}``. - If the caller does not have permission to list - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s - under this sample query set, regardless of whether or - not this sample query set exists, a - ``PERMISSION_DENIED`` error is returned. + If the caller does not have permission + to list `SampleQuery + `__s + under this sample query set, regardless + of whether or not this sample query set + exists, a ``PERMISSION_DENIED`` error is + returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -506,11 +516,13 @@ async def sample_list_sample_queries(): Returns: google.cloud.discoveryengine_v1alpha.services.sample_query_service.pagers.ListSampleQueriesAsyncPager: Response message for - [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueries] - method. + `SampleQueryService.ListSampleQueries + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -586,8 +598,8 @@ async def create_sample_query( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_sample_query.SampleQuery: - r"""Creates a - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] + r"""Creates a `SampleQuery + `__ .. code-block:: python @@ -623,10 +635,12 @@ async def sample_create_sample_query(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.CreateSampleQueryRequest, dict]]): The request object. Request message for - [SampleQueryService.CreateSampleQuery][google.cloud.discoveryengine.v1alpha.SampleQueryService.CreateSampleQuery] + `SampleQueryService.CreateSampleQuery + `__ method. parent (:class:`str`): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}``. This corresponds to the ``parent`` field @@ -634,7 +648,8 @@ async def sample_create_sample_query(): should not be set. sample_query (:class:`google.cloud.discoveryengine_v1alpha.types.SampleQuery`): Required. The - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] + `SampleQuery + `__ to create. This corresponds to the ``sample_query`` field @@ -642,25 +657,34 @@ async def sample_create_sample_query(): should not be set. sample_query_id (:class:`str`): Required. The ID to use for the - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], - which will become the final component of the - [SampleQuery.name][google.cloud.discoveryengine.v1alpha.SampleQuery.name]. - - If the caller does not have permission to create the - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + `SampleQuery + `__, + which will become the final component of + the + `SampleQuery.name + `__. + + If the caller does not have permission + to create the `SampleQuery + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. This field must be unique among all - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s + `SampleQuery + `__s with the same - [parent][google.cloud.discoveryengine.v1alpha.CreateSampleQueryRequest.parent]. - Otherwise, an ``ALREADY_EXISTS`` error is returned. + `parent + `__. + Otherwise, an ``ALREADY_EXISTS`` error + is returned. - This field must conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. - Otherwise, an ``INVALID_ARGUMENT`` error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 + characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. This corresponds to the ``sample_query_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -744,8 +768,8 @@ async def update_sample_query( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_sample_query.SampleQuery: - r"""Updates a - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]. + r"""Updates a `SampleQuery + `__. .. code-block:: python @@ -779,21 +803,24 @@ async def sample_update_sample_query(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.UpdateSampleQueryRequest, dict]]): The request object. Request message for - [SampleQueryService.UpdateSampleQuery][google.cloud.discoveryengine.v1alpha.SampleQueryService.UpdateSampleQuery] + `SampleQueryService.UpdateSampleQuery + `__ method. sample_query (:class:`google.cloud.discoveryengine_v1alpha.types.SampleQuery`): Required. The simple query to update. - If the caller does not have permission to update the - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. - - If the - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] - to update does not exist a ``NOT_FOUND`` error is + If the caller does not have permission + to update the `SampleQuery + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is returned. + If the `SampleQuery + `__ + to update does not exist a ``NOT_FOUND`` + error is returned. + This corresponds to the ``sample_query`` field on the ``request`` instance; if ``request`` is provided, this should not be set. @@ -884,8 +911,8 @@ async def delete_sample_query( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> None: - r"""Deletes a - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]. + r"""Deletes a `SampleQuery + `__. .. code-block:: python @@ -913,24 +940,28 @@ async def sample_delete_sample_query(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.DeleteSampleQueryRequest, dict]]): The request object. Request message for - [SampleQueryService.DeleteSampleQuery][google.cloud.discoveryengine.v1alpha.SampleQueryService.DeleteSampleQuery] + `SampleQueryService.DeleteSampleQuery + `__ method. name (:class:`str`): Required. Full resource name of - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], + `SampleQuery + `__, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}``. - If the caller does not have permission to delete the - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. - - If the - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] - to delete does not exist, a ``NOT_FOUND`` error is + If the caller does not have permission + to delete the `SampleQuery + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is returned. + If the `SampleQuery + `__ + to delete does not exist, a + ``NOT_FOUND`` error is returned. + This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this should not be set. @@ -997,11 +1028,13 @@ async def import_sample_queries( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: r"""Bulk import of multiple - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s. + `SampleQuery + `__s. Sample queries that already exist may be deleted. Note: It is possible for a subset of the - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s + `SampleQuery + `__s to be successfully imported. .. code-block:: python @@ -1041,7 +1074,8 @@ async def sample_import_sample_queries(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.ImportSampleQueriesRequest, dict]]): The request object. Request message for - [SampleQueryService.ImportSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ImportSampleQueries] + `SampleQueryService.ImportSampleQueries + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -1053,14 +1087,18 @@ async def sample_import_sample_queries(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.ImportSampleQueriesResponse` Response of the - [SampleQueryService.ImportSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ImportSampleQueries] - method. If the long running operation is done, this - message is returned by the - google.longrunning.Operations.response field if the - operation is successful. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.ImportSampleQueriesResponse` + Response of the + `SampleQueryService.ImportSampleQueries + `__ + method. If the long running operation is + done, this message is returned by the + google.longrunning.Operations.response + field if the operation is successful. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_service/client.py index f9ae93d09530..dc72699ad9ac 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_service/client.py @@ -119,7 +119,8 @@ def get_transport_class( class SampleQueryServiceClient(metaclass=SampleQueryServiceClientMeta): """Service for managing - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s, + `SampleQuery + `__s, """ @staticmethod @@ -762,8 +763,8 @@ def get_sample_query( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> sample_query.SampleQuery: - r"""Gets a - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]. + r"""Gets a `SampleQuery + `__. .. code-block:: python @@ -794,22 +795,27 @@ def sample_get_sample_query(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.GetSampleQueryRequest, dict]): The request object. Request message for - [SampleQueryService.GetSampleQuery][google.cloud.discoveryengine.v1alpha.SampleQueryService.GetSampleQuery] + `SampleQueryService.GetSampleQuery + `__ method. name (str): Required. Full resource name of - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], + `SampleQuery + `__, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}``. - If the caller does not have permission to access the - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `SampleQuery + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. If the requested - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] - does not exist, a NOT_FOUND error is returned. + `SampleQuery + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -886,7 +892,8 @@ def list_sample_queries( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListSampleQueriesPager: r"""Gets a list of - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s. + `SampleQuery + `__s. .. code-block:: python @@ -918,18 +925,21 @@ def sample_list_sample_queries(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.ListSampleQueriesRequest, dict]): The request object. Request message for - [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueries] + `SampleQueryService.ListSampleQueries + `__ method. parent (str): - Required. The parent sample query set resource name, - such as + Required. The parent sample query set + resource name, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}``. - If the caller does not have permission to list - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s - under this sample query set, regardless of whether or - not this sample query set exists, a - ``PERMISSION_DENIED`` error is returned. + If the caller does not have permission + to list `SampleQuery + `__s + under this sample query set, regardless + of whether or not this sample query set + exists, a ``PERMISSION_DENIED`` error is + returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -945,11 +955,13 @@ def sample_list_sample_queries(): Returns: google.cloud.discoveryengine_v1alpha.services.sample_query_service.pagers.ListSampleQueriesPager: Response message for - [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueries] - method. + `SampleQueryService.ListSampleQueries + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -1022,8 +1034,8 @@ def create_sample_query( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_sample_query.SampleQuery: - r"""Creates a - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] + r"""Creates a `SampleQuery + `__ .. code-block:: python @@ -1059,10 +1071,12 @@ def sample_create_sample_query(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.CreateSampleQueryRequest, dict]): The request object. Request message for - [SampleQueryService.CreateSampleQuery][google.cloud.discoveryengine.v1alpha.SampleQueryService.CreateSampleQuery] + `SampleQueryService.CreateSampleQuery + `__ method. parent (str): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}``. This corresponds to the ``parent`` field @@ -1070,7 +1084,8 @@ def sample_create_sample_query(): should not be set. sample_query (google.cloud.discoveryengine_v1alpha.types.SampleQuery): Required. The - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] + `SampleQuery + `__ to create. This corresponds to the ``sample_query`` field @@ -1078,25 +1093,34 @@ def sample_create_sample_query(): should not be set. sample_query_id (str): Required. The ID to use for the - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], - which will become the final component of the - [SampleQuery.name][google.cloud.discoveryengine.v1alpha.SampleQuery.name]. - - If the caller does not have permission to create the - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + `SampleQuery + `__, + which will become the final component of + the + `SampleQuery.name + `__. + + If the caller does not have permission + to create the `SampleQuery + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. This field must be unique among all - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s + `SampleQuery + `__s with the same - [parent][google.cloud.discoveryengine.v1alpha.CreateSampleQueryRequest.parent]. - Otherwise, an ``ALREADY_EXISTS`` error is returned. + `parent + `__. + Otherwise, an ``ALREADY_EXISTS`` error + is returned. - This field must conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. - Otherwise, an ``INVALID_ARGUMENT`` error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 + characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. This corresponds to the ``sample_query_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -1177,8 +1201,8 @@ def update_sample_query( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_sample_query.SampleQuery: - r"""Updates a - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]. + r"""Updates a `SampleQuery + `__. .. code-block:: python @@ -1212,21 +1236,24 @@ def sample_update_sample_query(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.UpdateSampleQueryRequest, dict]): The request object. Request message for - [SampleQueryService.UpdateSampleQuery][google.cloud.discoveryengine.v1alpha.SampleQueryService.UpdateSampleQuery] + `SampleQueryService.UpdateSampleQuery + `__ method. sample_query (google.cloud.discoveryengine_v1alpha.types.SampleQuery): Required. The simple query to update. - If the caller does not have permission to update the - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. - - If the - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] - to update does not exist a ``NOT_FOUND`` error is + If the caller does not have permission + to update the `SampleQuery + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is returned. + If the `SampleQuery + `__ + to update does not exist a ``NOT_FOUND`` + error is returned. + This corresponds to the ``sample_query`` field on the ``request`` instance; if ``request`` is provided, this should not be set. @@ -1314,8 +1341,8 @@ def delete_sample_query( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> None: - r"""Deletes a - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]. + r"""Deletes a `SampleQuery + `__. .. code-block:: python @@ -1343,24 +1370,28 @@ def sample_delete_sample_query(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.DeleteSampleQueryRequest, dict]): The request object. Request message for - [SampleQueryService.DeleteSampleQuery][google.cloud.discoveryengine.v1alpha.SampleQueryService.DeleteSampleQuery] + `SampleQueryService.DeleteSampleQuery + `__ method. name (str): Required. Full resource name of - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], + `SampleQuery + `__, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}``. - If the caller does not have permission to delete the - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. - - If the - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] - to delete does not exist, a ``NOT_FOUND`` error is + If the caller does not have permission + to delete the `SampleQuery + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is returned. + If the `SampleQuery + `__ + to delete does not exist, a + ``NOT_FOUND`` error is returned. + This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this should not be set. @@ -1424,11 +1455,13 @@ def import_sample_queries( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: r"""Bulk import of multiple - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s. + `SampleQuery + `__s. Sample queries that already exist may be deleted. Note: It is possible for a subset of the - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s + `SampleQuery + `__s to be successfully imported. .. code-block:: python @@ -1468,7 +1501,8 @@ def sample_import_sample_queries(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.ImportSampleQueriesRequest, dict]): The request object. Request message for - [SampleQueryService.ImportSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ImportSampleQueries] + `SampleQueryService.ImportSampleQueries + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1480,14 +1514,18 @@ def sample_import_sample_queries(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.ImportSampleQueriesResponse` Response of the - [SampleQueryService.ImportSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ImportSampleQueries] - method. If the long running operation is done, this - message is returned by the - google.longrunning.Operations.response field if the - operation is successful. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.ImportSampleQueriesResponse` + Response of the + `SampleQueryService.ImportSampleQueries + `__ + method. If the long running operation is + done, this message is returned by the + google.longrunning.Operations.response + field if the operation is successful. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_service/transports/grpc.py index 202aedb811be..5ee7c8aaf6c9 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_service/transports/grpc.py @@ -117,7 +117,8 @@ class SampleQueryServiceGrpcTransport(SampleQueryServiceTransport): """gRPC backend transport for SampleQueryService. Service for managing - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s, + `SampleQuery + `__s, This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -353,8 +354,8 @@ def get_sample_query( ]: r"""Return a callable for the get sample query method over gRPC. - Gets a - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]. + Gets a `SampleQuery + `__. Returns: Callable[[~.GetSampleQueryRequest], @@ -384,7 +385,8 @@ def list_sample_queries( r"""Return a callable for the list sample queries method over gRPC. Gets a list of - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s. + `SampleQuery + `__s. Returns: Callable[[~.ListSampleQueriesRequest], @@ -412,8 +414,8 @@ def create_sample_query( ]: r"""Return a callable for the create sample query method over gRPC. - Creates a - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] + Creates a `SampleQuery + `__ Returns: Callable[[~.CreateSampleQueryRequest], @@ -441,8 +443,8 @@ def update_sample_query( ]: r"""Return a callable for the update sample query method over gRPC. - Updates a - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]. + Updates a `SampleQuery + `__. Returns: Callable[[~.UpdateSampleQueryRequest], @@ -468,8 +470,8 @@ def delete_sample_query( ) -> Callable[[sample_query_service.DeleteSampleQueryRequest], empty_pb2.Empty]: r"""Return a callable for the delete sample query method over gRPC. - Deletes a - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]. + Deletes a `SampleQuery + `__. Returns: Callable[[~.DeleteSampleQueryRequest], @@ -496,11 +498,13 @@ def import_sample_queries( r"""Return a callable for the import sample queries method over gRPC. Bulk import of multiple - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s. + `SampleQuery + `__s. Sample queries that already exist may be deleted. Note: It is possible for a subset of the - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s + `SampleQuery + `__s to be successfully imported. Returns: diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_service/transports/grpc_asyncio.py index 2f3997e05593..4f450a905c12 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_service/transports/grpc_asyncio.py @@ -123,7 +123,8 @@ class SampleQueryServiceGrpcAsyncIOTransport(SampleQueryServiceTransport): """gRPC AsyncIO backend transport for SampleQueryService. Service for managing - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s, + `SampleQuery + `__s, This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -362,8 +363,8 @@ def get_sample_query( ]: r"""Return a callable for the get sample query method over gRPC. - Gets a - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]. + Gets a `SampleQuery + `__. Returns: Callable[[~.GetSampleQueryRequest], @@ -393,7 +394,8 @@ def list_sample_queries( r"""Return a callable for the list sample queries method over gRPC. Gets a list of - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s. + `SampleQuery + `__s. Returns: Callable[[~.ListSampleQueriesRequest], @@ -422,8 +424,8 @@ def create_sample_query( ]: r"""Return a callable for the create sample query method over gRPC. - Creates a - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] + Creates a `SampleQuery + `__ Returns: Callable[[~.CreateSampleQueryRequest], @@ -452,8 +454,8 @@ def update_sample_query( ]: r"""Return a callable for the update sample query method over gRPC. - Updates a - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]. + Updates a `SampleQuery + `__. Returns: Callable[[~.UpdateSampleQueryRequest], @@ -481,8 +483,8 @@ def delete_sample_query( ]: r"""Return a callable for the delete sample query method over gRPC. - Deletes a - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]. + Deletes a `SampleQuery + `__. Returns: Callable[[~.DeleteSampleQueryRequest], @@ -511,11 +513,13 @@ def import_sample_queries( r"""Return a callable for the import sample queries method over gRPC. Bulk import of multiple - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s. + `SampleQuery + `__s. Sample queries that already exist may be deleted. Note: It is possible for a subset of the - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s + `SampleQuery + `__s to be successfully imported. Returns: diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_service/transports/rest.py index 3a42f477f338..2b547a83a22f 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_service/transports/rest.py @@ -476,7 +476,8 @@ class SampleQueryServiceRestTransport(_BaseSampleQueryServiceRestTransport): """REST backend synchronous transport for SampleQueryService. Service for managing - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s, + `SampleQuery + `__s, This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -769,7 +770,8 @@ def __call__( Args: request (~.sample_query_service.CreateSampleQueryRequest): The request object. Request message for - [SampleQueryService.CreateSampleQuery][google.cloud.discoveryengine.v1alpha.SampleQueryService.CreateSampleQuery] + `SampleQueryService.CreateSampleQuery + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -925,7 +927,8 @@ def __call__( Args: request (~.sample_query_service.DeleteSampleQueryRequest): The request object. Request message for - [SampleQueryService.DeleteSampleQuery][google.cloud.discoveryengine.v1alpha.SampleQueryService.DeleteSampleQuery] + `SampleQueryService.DeleteSampleQuery + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1036,7 +1039,8 @@ def __call__( Args: request (~.sample_query_service.GetSampleQueryRequest): The request object. Request message for - [SampleQueryService.GetSampleQuery][google.cloud.discoveryengine.v1alpha.SampleQueryService.GetSampleQuery] + `SampleQueryService.GetSampleQuery + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1188,7 +1192,8 @@ def __call__( Args: request (~.import_config.ImportSampleQueriesRequest): The request object. Request message for - [SampleQueryService.ImportSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ImportSampleQueries] + `SampleQueryService.ImportSampleQueries + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1345,7 +1350,8 @@ def __call__( Args: request (~.sample_query_service.ListSampleQueriesRequest): The request object. Request message for - [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueries] + `SampleQueryService.ListSampleQueries + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1358,7 +1364,8 @@ def __call__( Returns: ~.sample_query_service.ListSampleQueriesResponse: Response message for - [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueries] + `SampleQueryService.ListSampleQueries + `__ method. """ @@ -1500,7 +1507,8 @@ def __call__( Args: request (~.sample_query_service.UpdateSampleQueryRequest): The request object. Request message for - [SampleQueryService.UpdateSampleQuery][google.cloud.discoveryengine.v1alpha.SampleQueryService.UpdateSampleQuery] + `SampleQueryService.UpdateSampleQuery + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_set_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_set_service/async_client.py index 77b87387dd9d..a94a57f170fd 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_set_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_set_service/async_client.py @@ -74,7 +74,8 @@ class SampleQuerySetServiceAsyncClient: """Service for managing - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s, + `SampleQuerySet + `__s, """ _client: SampleQuerySetServiceClient @@ -324,7 +325,8 @@ async def get_sample_query_set( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> sample_query_set.SampleQuerySet: r"""Gets a - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]. + `SampleQuerySet + `__. .. code-block:: python @@ -355,22 +357,27 @@ async def sample_get_sample_query_set(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.GetSampleQuerySetRequest, dict]]): The request object. Request message for - [SampleQuerySetService.GetSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.GetSampleQuerySet] + `SampleQuerySetService.GetSampleQuerySet + `__ method. name (:class:`str`): Required. Full resource name of - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], + `SampleQuerySet + `__, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}``. - If the caller does not have permission to access the - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `SampleQuerySet + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. If the requested - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] - does not exist, a NOT_FOUND error is returned. + `SampleQuerySet + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -452,7 +459,8 @@ async def list_sample_query_sets( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListSampleQuerySetsAsyncPager: r"""Gets a list of - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s. + `SampleQuerySet + `__s. .. code-block:: python @@ -484,17 +492,20 @@ async def sample_list_sample_query_sets(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.ListSampleQuerySetsRequest, dict]]): The request object. Request message for - [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.ListSampleQuerySets] + `SampleQuerySetService.ListSampleQuerySets + `__ method. parent (:class:`str`): - Required. The parent location resource name, such as + Required. The parent location resource + name, such as ``projects/{project}/locations/{location}``. - If the caller does not have permission to list - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s - under this location, regardless of whether or not this - location exists, a ``PERMISSION_DENIED`` error is - returned. + If the caller does not have permission + to list `SampleQuerySet + `__s + under this location, regardless of + whether or not this location exists, a + ``PERMISSION_DENIED`` error is returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -510,11 +521,13 @@ async def sample_list_sample_query_sets(): Returns: google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.pagers.ListSampleQuerySetsAsyncPager: Response message for - [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.ListSampleQuerySets] - method. + `SampleQuerySetService.ListSampleQuerySets + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -591,7 +604,8 @@ async def create_sample_query_set( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_sample_query_set.SampleQuerySet: r"""Creates a - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] + `SampleQuerySet + `__ .. code-block:: python @@ -627,10 +641,12 @@ async def sample_create_sample_query_set(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.CreateSampleQuerySetRequest, dict]]): The request object. Request message for - [SampleQuerySetService.CreateSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.CreateSampleQuerySet] + `SampleQuerySetService.CreateSampleQuerySet + `__ method. parent (:class:`str`): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}``. This corresponds to the ``parent`` field @@ -638,7 +654,8 @@ async def sample_create_sample_query_set(): should not be set. sample_query_set (:class:`google.cloud.discoveryengine_v1alpha.types.SampleQuerySet`): Required. The - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] + `SampleQuerySet + `__ to create. This corresponds to the ``sample_query_set`` field @@ -646,25 +663,33 @@ async def sample_create_sample_query_set(): should not be set. sample_query_set_id (:class:`str`): Required. The ID to use for the - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], - which will become the final component of the - [SampleQuerySet.name][google.cloud.discoveryengine.v1alpha.SampleQuerySet.name]. - - If the caller does not have permission to create the - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + `SampleQuerySet + `__, + which will become the final component of + the `SampleQuerySet.name + `__. + + If the caller does not have permission + to create the `SampleQuerySet + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. This field must be unique among all - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s + `SampleQuerySet + `__s with the same - [parent][google.cloud.discoveryengine.v1alpha.CreateSampleQuerySetRequest.parent]. - Otherwise, an ``ALREADY_EXISTS`` error is returned. + `parent + `__. + Otherwise, an ``ALREADY_EXISTS`` error + is returned. - This field must conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. - Otherwise, an ``INVALID_ARGUMENT`` error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 + characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. This corresponds to the ``sample_query_set_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -753,7 +778,8 @@ async def update_sample_query_set( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_sample_query_set.SampleQuerySet: r"""Updates a - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]. + `SampleQuerySet + `__. .. code-block:: python @@ -787,20 +813,24 @@ async def sample_update_sample_query_set(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.UpdateSampleQuerySetRequest, dict]]): The request object. Request message for - [SampleQuerySetService.UpdateSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.UpdateSampleQuerySet] + `SampleQuerySetService.UpdateSampleQuerySet + `__ method. sample_query_set (:class:`google.cloud.discoveryengine_v1alpha.types.SampleQuerySet`): - Required. The sample query set to update. - - If the caller does not have permission to update the - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + Required. The sample query set to + update. + If the caller does not have permission + to update the `SampleQuerySet + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. If the - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] - to update does not exist a ``NOT_FOUND`` error is - returned. + `SampleQuerySet + `__ + to update does not exist a ``NOT_FOUND`` + error is returned. This corresponds to the ``sample_query_set`` field on the ``request`` instance; if ``request`` is provided, this @@ -897,7 +927,8 @@ async def delete_sample_query_set( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> None: r"""Deletes a - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]. + `SampleQuerySet + `__. .. code-block:: python @@ -925,23 +956,28 @@ async def sample_delete_sample_query_set(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.DeleteSampleQuerySetRequest, dict]]): The request object. Request message for - [SampleQuerySetService.DeleteSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.DeleteSampleQuerySet] + `SampleQuerySetService.DeleteSampleQuerySet + `__ method. name (:class:`str`): Required. Full resource name of - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], + `SampleQuerySet + `__, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}``. - If the caller does not have permission to delete the - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + If the caller does not have permission + to delete the `SampleQuerySet + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. If the - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] - to delete does not exist, a ``NOT_FOUND`` error is - returned. + `SampleQuerySet + `__ + to delete does not exist, a + ``NOT_FOUND`` error is returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_set_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_set_service/client.py index d56b3518b181..e7216965bfb1 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_set_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_set_service/client.py @@ -120,7 +120,8 @@ def get_transport_class( class SampleQuerySetServiceClient(metaclass=SampleQuerySetServiceClientMeta): """Service for managing - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s, + `SampleQuerySet + `__s, """ @staticmethod @@ -759,7 +760,8 @@ def get_sample_query_set( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> sample_query_set.SampleQuerySet: r"""Gets a - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]. + `SampleQuerySet + `__. .. code-block:: python @@ -790,22 +792,27 @@ def sample_get_sample_query_set(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.GetSampleQuerySetRequest, dict]): The request object. Request message for - [SampleQuerySetService.GetSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.GetSampleQuerySet] + `SampleQuerySetService.GetSampleQuerySet + `__ method. name (str): Required. Full resource name of - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], + `SampleQuerySet + `__, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}``. - If the caller does not have permission to access the - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `SampleQuerySet + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. If the requested - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] - does not exist, a NOT_FOUND error is returned. + `SampleQuerySet + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -884,7 +891,8 @@ def list_sample_query_sets( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListSampleQuerySetsPager: r"""Gets a list of - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s. + `SampleQuerySet + `__s. .. code-block:: python @@ -916,17 +924,20 @@ def sample_list_sample_query_sets(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.ListSampleQuerySetsRequest, dict]): The request object. Request message for - [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.ListSampleQuerySets] + `SampleQuerySetService.ListSampleQuerySets + `__ method. parent (str): - Required. The parent location resource name, such as + Required. The parent location resource + name, such as ``projects/{project}/locations/{location}``. - If the caller does not have permission to list - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s - under this location, regardless of whether or not this - location exists, a ``PERMISSION_DENIED`` error is - returned. + If the caller does not have permission + to list `SampleQuerySet + `__s + under this location, regardless of + whether or not this location exists, a + ``PERMISSION_DENIED`` error is returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -942,11 +953,13 @@ def sample_list_sample_query_sets(): Returns: google.cloud.discoveryengine_v1alpha.services.sample_query_set_service.pagers.ListSampleQuerySetsPager: Response message for - [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.ListSampleQuerySets] - method. + `SampleQuerySetService.ListSampleQuerySets + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -1020,7 +1033,8 @@ def create_sample_query_set( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_sample_query_set.SampleQuerySet: r"""Creates a - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] + `SampleQuerySet + `__ .. code-block:: python @@ -1056,10 +1070,12 @@ def sample_create_sample_query_set(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.CreateSampleQuerySetRequest, dict]): The request object. Request message for - [SampleQuerySetService.CreateSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.CreateSampleQuerySet] + `SampleQuerySetService.CreateSampleQuerySet + `__ method. parent (str): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}``. This corresponds to the ``parent`` field @@ -1067,7 +1083,8 @@ def sample_create_sample_query_set(): should not be set. sample_query_set (google.cloud.discoveryengine_v1alpha.types.SampleQuerySet): Required. The - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] + `SampleQuerySet + `__ to create. This corresponds to the ``sample_query_set`` field @@ -1075,25 +1092,33 @@ def sample_create_sample_query_set(): should not be set. sample_query_set_id (str): Required. The ID to use for the - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], - which will become the final component of the - [SampleQuerySet.name][google.cloud.discoveryengine.v1alpha.SampleQuerySet.name]. - - If the caller does not have permission to create the - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + `SampleQuerySet + `__, + which will become the final component of + the `SampleQuerySet.name + `__. + + If the caller does not have permission + to create the `SampleQuerySet + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. This field must be unique among all - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s + `SampleQuerySet + `__s with the same - [parent][google.cloud.discoveryengine.v1alpha.CreateSampleQuerySetRequest.parent]. - Otherwise, an ``ALREADY_EXISTS`` error is returned. + `parent + `__. + Otherwise, an ``ALREADY_EXISTS`` error + is returned. - This field must conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. - Otherwise, an ``INVALID_ARGUMENT`` error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 + characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. This corresponds to the ``sample_query_set_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -1179,7 +1204,8 @@ def update_sample_query_set( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_sample_query_set.SampleQuerySet: r"""Updates a - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]. + `SampleQuerySet + `__. .. code-block:: python @@ -1213,20 +1239,24 @@ def sample_update_sample_query_set(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.UpdateSampleQuerySetRequest, dict]): The request object. Request message for - [SampleQuerySetService.UpdateSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.UpdateSampleQuerySet] + `SampleQuerySetService.UpdateSampleQuerySet + `__ method. sample_query_set (google.cloud.discoveryengine_v1alpha.types.SampleQuerySet): - Required. The sample query set to update. - - If the caller does not have permission to update the - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + Required. The sample query set to + update. + If the caller does not have permission + to update the `SampleQuerySet + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. If the - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] - to update does not exist a ``NOT_FOUND`` error is - returned. + `SampleQuerySet + `__ + to update does not exist a ``NOT_FOUND`` + error is returned. This corresponds to the ``sample_query_set`` field on the ``request`` instance; if ``request`` is provided, this @@ -1320,7 +1350,8 @@ def delete_sample_query_set( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> None: r"""Deletes a - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]. + `SampleQuerySet + `__. .. code-block:: python @@ -1348,23 +1379,28 @@ def sample_delete_sample_query_set(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.DeleteSampleQuerySetRequest, dict]): The request object. Request message for - [SampleQuerySetService.DeleteSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.DeleteSampleQuerySet] + `SampleQuerySetService.DeleteSampleQuerySet + `__ method. name (str): Required. Full resource name of - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], + `SampleQuerySet + `__, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}``. - If the caller does not have permission to delete the - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + If the caller does not have permission + to delete the `SampleQuerySet + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. If the - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] - to delete does not exist, a ``NOT_FOUND`` error is - returned. + `SampleQuerySet + `__ + to delete does not exist, a + ``NOT_FOUND`` error is returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_set_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_set_service/transports/grpc.py index e7e5954eaba8..b6ed415e6a2d 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_set_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_set_service/transports/grpc.py @@ -118,7 +118,8 @@ class SampleQuerySetServiceGrpcTransport(SampleQuerySetServiceTransport): """gRPC backend transport for SampleQuerySetService. Service for managing - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s, + `SampleQuerySet + `__s, This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -339,7 +340,8 @@ def get_sample_query_set( r"""Return a callable for the get sample query set method over gRPC. Gets a - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]. + `SampleQuerySet + `__. Returns: Callable[[~.GetSampleQuerySetRequest], @@ -369,7 +371,8 @@ def list_sample_query_sets( r"""Return a callable for the list sample query sets method over gRPC. Gets a list of - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s. + `SampleQuerySet + `__s. Returns: Callable[[~.ListSampleQuerySetsRequest], @@ -399,7 +402,8 @@ def create_sample_query_set( r"""Return a callable for the create sample query set method over gRPC. Creates a - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] + `SampleQuerySet + `__ Returns: Callable[[~.CreateSampleQuerySetRequest], @@ -429,7 +433,8 @@ def update_sample_query_set( r"""Return a callable for the update sample query set method over gRPC. Updates a - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]. + `SampleQuerySet + `__. Returns: Callable[[~.UpdateSampleQuerySetRequest], @@ -458,7 +463,8 @@ def delete_sample_query_set( r"""Return a callable for the delete sample query set method over gRPC. Deletes a - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]. + `SampleQuerySet + `__. Returns: Callable[[~.DeleteSampleQuerySetRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_set_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_set_service/transports/grpc_asyncio.py index 77cfd63d9821..d71afb78cf3f 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_set_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_set_service/transports/grpc_asyncio.py @@ -124,7 +124,8 @@ class SampleQuerySetServiceGrpcAsyncIOTransport(SampleQuerySetServiceTransport): """gRPC AsyncIO backend transport for SampleQuerySetService. Service for managing - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s, + `SampleQuerySet + `__s, This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -347,7 +348,8 @@ def get_sample_query_set( r"""Return a callable for the get sample query set method over gRPC. Gets a - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]. + `SampleQuerySet + `__. Returns: Callable[[~.GetSampleQuerySetRequest], @@ -377,7 +379,8 @@ def list_sample_query_sets( r"""Return a callable for the list sample query sets method over gRPC. Gets a list of - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s. + `SampleQuerySet + `__s. Returns: Callable[[~.ListSampleQuerySetsRequest], @@ -407,7 +410,8 @@ def create_sample_query_set( r"""Return a callable for the create sample query set method over gRPC. Creates a - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] + `SampleQuerySet + `__ Returns: Callable[[~.CreateSampleQuerySetRequest], @@ -437,7 +441,8 @@ def update_sample_query_set( r"""Return a callable for the update sample query set method over gRPC. Updates a - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]. + `SampleQuerySet + `__. Returns: Callable[[~.UpdateSampleQuerySetRequest], @@ -467,7 +472,8 @@ def delete_sample_query_set( r"""Return a callable for the delete sample query set method over gRPC. Deletes a - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]. + `SampleQuerySet + `__. Returns: Callable[[~.DeleteSampleQuerySetRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_set_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_set_service/transports/rest.py index 66b4dee48653..35d99a081a02 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_set_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/sample_query_set_service/transports/rest.py @@ -426,7 +426,8 @@ class SampleQuerySetServiceRestTransport(_BaseSampleQuerySetServiceRestTransport """REST backend synchronous transport for SampleQuerySetService. Service for managing - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s, + `SampleQuerySet + `__s, This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -546,7 +547,8 @@ def __call__( Args: request (~.sample_query_set_service.CreateSampleQuerySetRequest): The request object. Request message for - [SampleQuerySetService.CreateSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.CreateSampleQuerySet] + `SampleQuerySetService.CreateSampleQuerySet + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -708,7 +710,8 @@ def __call__( Args: request (~.sample_query_set_service.DeleteSampleQuerySetRequest): The request object. Request message for - [SampleQuerySetService.DeleteSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.DeleteSampleQuerySet] + `SampleQuerySetService.DeleteSampleQuerySet + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -821,7 +824,8 @@ def __call__( Args: request (~.sample_query_set_service.GetSampleQuerySetRequest): The request object. Request message for - [SampleQuerySetService.GetSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.GetSampleQuerySet] + `SampleQuerySetService.GetSampleQuerySet + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -976,7 +980,8 @@ def __call__( Args: request (~.sample_query_set_service.ListSampleQuerySetsRequest): The request object. Request message for - [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.ListSampleQuerySets] + `SampleQuerySetService.ListSampleQuerySets + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -989,7 +994,8 @@ def __call__( Returns: ~.sample_query_set_service.ListSampleQuerySetsResponse: Response message for - [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.ListSampleQuerySets] + `SampleQuerySetService.ListSampleQuerySets + `__ method. """ @@ -1135,7 +1141,8 @@ def __call__( Args: request (~.sample_query_set_service.UpdateSampleQuerySetRequest): The request object. Request message for - [SampleQuerySetService.UpdateSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.UpdateSampleQuerySet] + `SampleQuerySetService.UpdateSampleQuerySet + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/schema_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/schema_service/async_client.py index e23c5e46c72b..0c96f797e60b 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/schema_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/schema_service/async_client.py @@ -71,8 +71,8 @@ class SchemaServiceAsyncClient: - """Service for managing - [Schema][google.cloud.discoveryengine.v1alpha.Schema]s. + """Service for managing `Schema + `__s. """ _client: SchemaServiceClient @@ -309,7 +309,8 @@ async def get_schema( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> schema.Schema: - r"""Gets a [Schema][google.cloud.discoveryengine.v1alpha.Schema]. + r"""Gets a `Schema + `__. .. code-block:: python @@ -340,11 +341,12 @@ async def sample_get_schema(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.GetSchemaRequest, dict]]): The request object. Request message for - [SchemaService.GetSchema][google.cloud.discoveryengine.v1alpha.SchemaService.GetSchema] + `SchemaService.GetSchema + `__ method. name (:class:`str`): - Required. The full resource name of the schema, in the - format of + Required. The full resource name of the + schema, in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}``. This corresponds to the ``name`` field @@ -422,8 +424,8 @@ async def list_schemas( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListSchemasAsyncPager: - r"""Gets a list of - [Schema][google.cloud.discoveryengine.v1alpha.Schema]s. + r"""Gets a list of `Schema + `__s. .. code-block:: python @@ -455,11 +457,12 @@ async def sample_list_schemas(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.ListSchemasRequest, dict]]): The request object. Request message for - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1alpha.SchemaService.ListSchemas] + `SchemaService.ListSchemas + `__ method. parent (:class:`str`): - Required. The parent data store resource name, in the - format of + Required. The parent data store resource + name, in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}``. This corresponds to the ``parent`` field @@ -476,11 +479,13 @@ async def sample_list_schemas(): Returns: google.cloud.discoveryengine_v1alpha.services.schema_service.pagers.ListSchemasAsyncPager: Response message for - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1alpha.SchemaService.ListSchemas] - method. + `SchemaService.ListSchemas + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -554,7 +559,8 @@ async def create_schema( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Creates a [Schema][google.cloud.discoveryengine.v1alpha.Schema]. + r"""Creates a `Schema + `__. .. code-block:: python @@ -590,33 +596,38 @@ async def sample_create_schema(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.CreateSchemaRequest, dict]]): The request object. Request message for - [SchemaService.CreateSchema][google.cloud.discoveryengine.v1alpha.SchemaService.CreateSchema] + `SchemaService.CreateSchema + `__ method. parent (:class:`str`): - Required. The parent data store resource name, in the - format of + Required. The parent data store resource + name, in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. schema (:class:`google.cloud.discoveryengine_v1alpha.types.Schema`): - Required. The - [Schema][google.cloud.discoveryengine.v1alpha.Schema] to - create. + Required. The `Schema + `__ + to create. This corresponds to the ``schema`` field on the ``request`` instance; if ``request`` is provided, this should not be set. schema_id (:class:`str`): Required. The ID to use for the - [Schema][google.cloud.discoveryengine.v1alpha.Schema], + `Schema + `__, which becomes the final component of the - [Schema.name][google.cloud.discoveryengine.v1alpha.Schema.name]. + `Schema.name + `__. This field should conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. + `RFC-1034 + `__ + standard with a length limit of 63 + characters. This corresponds to the ``schema_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -631,12 +642,13 @@ async def sample_create_schema(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1alpha.types.Schema` - Defines the structure and layout of a type of document - data. + Defines the structure and layout of a + type of document data. """ # Create or coerce a protobuf request object. @@ -708,7 +720,8 @@ async def update_schema( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Updates a [Schema][google.cloud.discoveryengine.v1alpha.Schema]. + r"""Updates a `Schema + `__. .. code-block:: python @@ -742,7 +755,8 @@ async def sample_update_schema(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.UpdateSchemaRequest, dict]]): The request object. Request message for - [SchemaService.UpdateSchema][google.cloud.discoveryengine.v1alpha.SchemaService.UpdateSchema] + `SchemaService.UpdateSchema + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -754,12 +768,13 @@ async def sample_update_schema(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1alpha.types.Schema` - Defines the structure and layout of a type of document - data. + Defines the structure and layout of a + type of document data. """ # Create or coerce a protobuf request object. @@ -813,7 +828,8 @@ async def delete_schema( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Deletes a [Schema][google.cloud.discoveryengine.v1alpha.Schema]. + r"""Deletes a `Schema + `__. .. code-block:: python @@ -848,11 +864,12 @@ async def sample_delete_schema(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.DeleteSchemaRequest, dict]]): The request object. Request message for - [SchemaService.DeleteSchema][google.cloud.discoveryengine.v1alpha.SchemaService.DeleteSchema] + `SchemaService.DeleteSchema + `__ method. name (:class:`str`): - Required. The full resource name of the schema, in the - format of + Required. The full resource name of the + schema, in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}``. This corresponds to the ``name`` field @@ -868,18 +885,21 @@ async def sample_delete_schema(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/schema_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/schema_service/client.py index fbe2e565e9d2..fbdc958856c1 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/schema_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/schema_service/client.py @@ -115,8 +115,8 @@ def get_transport_class( class SchemaServiceClient(metaclass=SchemaServiceClientMeta): - """Service for managing - [Schema][google.cloud.discoveryengine.v1alpha.Schema]s. + """Service for managing `Schema + `__s. """ @staticmethod @@ -752,7 +752,8 @@ def get_schema( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> schema.Schema: - r"""Gets a [Schema][google.cloud.discoveryengine.v1alpha.Schema]. + r"""Gets a `Schema + `__. .. code-block:: python @@ -783,11 +784,12 @@ def sample_get_schema(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.GetSchemaRequest, dict]): The request object. Request message for - [SchemaService.GetSchema][google.cloud.discoveryengine.v1alpha.SchemaService.GetSchema] + `SchemaService.GetSchema + `__ method. name (str): - Required. The full resource name of the schema, in the - format of + Required. The full resource name of the + schema, in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}``. This corresponds to the ``name`` field @@ -862,8 +864,8 @@ def list_schemas( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListSchemasPager: - r"""Gets a list of - [Schema][google.cloud.discoveryengine.v1alpha.Schema]s. + r"""Gets a list of `Schema + `__s. .. code-block:: python @@ -895,11 +897,12 @@ def sample_list_schemas(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.ListSchemasRequest, dict]): The request object. Request message for - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1alpha.SchemaService.ListSchemas] + `SchemaService.ListSchemas + `__ method. parent (str): - Required. The parent data store resource name, in the - format of + Required. The parent data store resource + name, in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}``. This corresponds to the ``parent`` field @@ -916,11 +919,13 @@ def sample_list_schemas(): Returns: google.cloud.discoveryengine_v1alpha.services.schema_service.pagers.ListSchemasPager: Response message for - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1alpha.SchemaService.ListSchemas] - method. + `SchemaService.ListSchemas + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -991,7 +996,8 @@ def create_schema( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Creates a [Schema][google.cloud.discoveryengine.v1alpha.Schema]. + r"""Creates a `Schema + `__. .. code-block:: python @@ -1027,33 +1033,38 @@ def sample_create_schema(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.CreateSchemaRequest, dict]): The request object. Request message for - [SchemaService.CreateSchema][google.cloud.discoveryengine.v1alpha.SchemaService.CreateSchema] + `SchemaService.CreateSchema + `__ method. parent (str): - Required. The parent data store resource name, in the - format of + Required. The parent data store resource + name, in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. schema (google.cloud.discoveryengine_v1alpha.types.Schema): - Required. The - [Schema][google.cloud.discoveryengine.v1alpha.Schema] to - create. + Required. The `Schema + `__ + to create. This corresponds to the ``schema`` field on the ``request`` instance; if ``request`` is provided, this should not be set. schema_id (str): Required. The ID to use for the - [Schema][google.cloud.discoveryengine.v1alpha.Schema], + `Schema + `__, which becomes the final component of the - [Schema.name][google.cloud.discoveryengine.v1alpha.Schema.name]. + `Schema.name + `__. This field should conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. + `RFC-1034 + `__ + standard with a length limit of 63 + characters. This corresponds to the ``schema_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -1068,12 +1079,13 @@ def sample_create_schema(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1alpha.types.Schema` - Defines the structure and layout of a type of document - data. + Defines the structure and layout of a + type of document data. """ # Create or coerce a protobuf request object. @@ -1142,7 +1154,8 @@ def update_schema( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Updates a [Schema][google.cloud.discoveryengine.v1alpha.Schema]. + r"""Updates a `Schema + `__. .. code-block:: python @@ -1176,7 +1189,8 @@ def sample_update_schema(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.UpdateSchemaRequest, dict]): The request object. Request message for - [SchemaService.UpdateSchema][google.cloud.discoveryengine.v1alpha.SchemaService.UpdateSchema] + `SchemaService.UpdateSchema + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1188,12 +1202,13 @@ def sample_update_schema(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1alpha.types.Schema` - Defines the structure and layout of a type of document - data. + Defines the structure and layout of a + type of document data. """ # Create or coerce a protobuf request object. @@ -1245,7 +1260,8 @@ def delete_schema( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Deletes a [Schema][google.cloud.discoveryengine.v1alpha.Schema]. + r"""Deletes a `Schema + `__. .. code-block:: python @@ -1280,11 +1296,12 @@ def sample_delete_schema(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.DeleteSchemaRequest, dict]): The request object. Request message for - [SchemaService.DeleteSchema][google.cloud.discoveryengine.v1alpha.SchemaService.DeleteSchema] + `SchemaService.DeleteSchema + `__ method. name (str): - Required. The full resource name of the schema, in the - format of + Required. The full resource name of the + schema, in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}``. This corresponds to the ``name`` field @@ -1300,18 +1317,21 @@ def sample_delete_schema(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/schema_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/schema_service/transports/grpc.py index 4e7f33fbe9ff..779b62f38314 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/schema_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/schema_service/transports/grpc.py @@ -112,8 +112,8 @@ def intercept_unary_unary(self, continuation, client_call_details, request): class SchemaServiceGrpcTransport(SchemaServiceTransport): """gRPC backend transport for SchemaService. - Service for managing - [Schema][google.cloud.discoveryengine.v1alpha.Schema]s. + Service for managing `Schema + `__s. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -345,7 +345,8 @@ def operations_client(self) -> operations_v1.OperationsClient: def get_schema(self) -> Callable[[schema_service.GetSchemaRequest], schema.Schema]: r"""Return a callable for the get schema method over gRPC. - Gets a [Schema][google.cloud.discoveryengine.v1alpha.Schema]. + Gets a `Schema + `__. Returns: Callable[[~.GetSchemaRequest], @@ -373,8 +374,8 @@ def list_schemas( ]: r"""Return a callable for the list schemas method over gRPC. - Gets a list of - [Schema][google.cloud.discoveryengine.v1alpha.Schema]s. + Gets a list of `Schema + `__s. Returns: Callable[[~.ListSchemasRequest], @@ -400,7 +401,8 @@ def create_schema( ) -> Callable[[schema_service.CreateSchemaRequest], operations_pb2.Operation]: r"""Return a callable for the create schema method over gRPC. - Creates a [Schema][google.cloud.discoveryengine.v1alpha.Schema]. + Creates a `Schema + `__. Returns: Callable[[~.CreateSchemaRequest], @@ -426,7 +428,8 @@ def update_schema( ) -> Callable[[schema_service.UpdateSchemaRequest], operations_pb2.Operation]: r"""Return a callable for the update schema method over gRPC. - Updates a [Schema][google.cloud.discoveryengine.v1alpha.Schema]. + Updates a `Schema + `__. Returns: Callable[[~.UpdateSchemaRequest], @@ -452,7 +455,8 @@ def delete_schema( ) -> Callable[[schema_service.DeleteSchemaRequest], operations_pb2.Operation]: r"""Return a callable for the delete schema method over gRPC. - Deletes a [Schema][google.cloud.discoveryengine.v1alpha.Schema]. + Deletes a `Schema + `__. Returns: Callable[[~.DeleteSchemaRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/schema_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/schema_service/transports/grpc_asyncio.py index 2e7b5673ea53..d27afe463431 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/schema_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/schema_service/transports/grpc_asyncio.py @@ -118,8 +118,8 @@ async def intercept_unary_unary(self, continuation, client_call_details, request class SchemaServiceGrpcAsyncIOTransport(SchemaServiceTransport): """gRPC AsyncIO backend transport for SchemaService. - Service for managing - [Schema][google.cloud.discoveryengine.v1alpha.Schema]s. + Service for managing `Schema + `__s. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -355,7 +355,8 @@ def get_schema( ) -> Callable[[schema_service.GetSchemaRequest], Awaitable[schema.Schema]]: r"""Return a callable for the get schema method over gRPC. - Gets a [Schema][google.cloud.discoveryengine.v1alpha.Schema]. + Gets a `Schema + `__. Returns: Callable[[~.GetSchemaRequest], @@ -384,8 +385,8 @@ def list_schemas( ]: r"""Return a callable for the list schemas method over gRPC. - Gets a list of - [Schema][google.cloud.discoveryengine.v1alpha.Schema]s. + Gets a list of `Schema + `__s. Returns: Callable[[~.ListSchemasRequest], @@ -413,7 +414,8 @@ def create_schema( ]: r"""Return a callable for the create schema method over gRPC. - Creates a [Schema][google.cloud.discoveryengine.v1alpha.Schema]. + Creates a `Schema + `__. Returns: Callable[[~.CreateSchemaRequest], @@ -441,7 +443,8 @@ def update_schema( ]: r"""Return a callable for the update schema method over gRPC. - Updates a [Schema][google.cloud.discoveryengine.v1alpha.Schema]. + Updates a `Schema + `__. Returns: Callable[[~.UpdateSchemaRequest], @@ -469,7 +472,8 @@ def delete_schema( ]: r"""Return a callable for the delete schema method over gRPC. - Deletes a [Schema][google.cloud.discoveryengine.v1alpha.Schema]. + Deletes a `Schema + `__. Returns: Callable[[~.DeleteSchemaRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/schema_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/schema_service/transports/rest.py index 7eade9324da8..edb0a5bad3f0 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/schema_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/schema_service/transports/rest.py @@ -442,8 +442,8 @@ class SchemaServiceRestStub: class SchemaServiceRestTransport(_BaseSchemaServiceRestTransport): """REST backend synchronous transport for SchemaService. - Service for managing - [Schema][google.cloud.discoveryengine.v1alpha.Schema]s. + Service for managing `Schema + `__s. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -735,7 +735,8 @@ def __call__( Args: request (~.schema_service.CreateSchemaRequest): The request object. Request message for - [SchemaService.CreateSchema][google.cloud.discoveryengine.v1alpha.SchemaService.CreateSchema] + `SchemaService.CreateSchema + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -887,7 +888,8 @@ def __call__( Args: request (~.schema_service.DeleteSchemaRequest): The request object. Request message for - [SchemaService.DeleteSchema][google.cloud.discoveryengine.v1alpha.SchemaService.DeleteSchema] + `SchemaService.DeleteSchema + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1034,7 +1036,8 @@ def __call__( Args: request (~.schema_service.GetSchemaRequest): The request object. Request message for - [SchemaService.GetSchema][google.cloud.discoveryengine.v1alpha.SchemaService.GetSchema] + `SchemaService.GetSchema + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1186,7 +1189,8 @@ def __call__( Args: request (~.schema_service.ListSchemasRequest): The request object. Request message for - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1alpha.SchemaService.ListSchemas] + `SchemaService.ListSchemas + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1199,7 +1203,8 @@ def __call__( Returns: ~.schema_service.ListSchemasResponse: Response message for - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1alpha.SchemaService.ListSchemas] + `SchemaService.ListSchemas + `__ method. """ @@ -1340,7 +1345,8 @@ def __call__( Args: request (~.schema_service.UpdateSchemaRequest): The request object. Request message for - [SchemaService.UpdateSchema][google.cloud.discoveryengine.v1alpha.SchemaService.UpdateSchema] + `SchemaService.UpdateSchema + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/search_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/search_service/async_client.py index f18a4ef0ba91..426bf7957806 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/search_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/search_service/async_client.py @@ -342,7 +342,8 @@ async def sample_search(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.SearchRequest, dict]]): The request object. Request message for - [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search] + `SearchService.Search + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -355,11 +356,13 @@ async def sample_search(): Returns: google.cloud.discoveryengine_v1alpha.services.search_service.pagers.SearchAsyncPager: Response message for - [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search] - method. + `SearchService.Search + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/search_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/search_service/client.py index 5b2d542332b5..61d44af9e423 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/search_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/search_service/client.py @@ -877,7 +877,8 @@ def sample_search(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.SearchRequest, dict]): The request object. Request message for - [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search] + `SearchService.Search + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -890,11 +891,13 @@ def sample_search(): Returns: google.cloud.discoveryengine_v1alpha.services.search_service.pagers.SearchPager: Response message for - [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search] - method. + `SearchService.Search + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/search_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/search_service/transports/rest.py index d4feaa473f18..657d4780fa70 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/search_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/search_service/transports/rest.py @@ -335,7 +335,8 @@ def __call__( Args: request (~.search_service.SearchRequest): The request object. Request message for - [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search] + `SearchService.Search + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -348,7 +349,8 @@ def __call__( Returns: ~.search_service.SearchResponse: Response message for - [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search] + `SearchService.Search + `__ method. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/search_tuning_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/search_tuning_service/async_client.py index e689cffa1d7c..8d3cabbbdb81 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/search_tuning_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/search_tuning_service/async_client.py @@ -351,7 +351,8 @@ async def sample_train_custom_model(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.TrainCustomModelRequest, dict]]): The request object. Request message for - [SearchTuningService.TrainCustomModel][google.cloud.discoveryengine.v1alpha.SearchTuningService.TrainCustomModel] + `SearchTuningService.TrainCustomModel + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -363,12 +364,16 @@ async def sample_train_custom_model(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.TrainCustomModelResponse` Response of the - [TrainCustomModelRequest][google.cloud.discoveryengine.v1alpha.TrainCustomModelRequest]. - This message is returned by the - google.longrunning.Operations.response field. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.TrainCustomModelResponse` + Response of the `TrainCustomModelRequest + `__. + This message is returned by the + google.longrunning.Operations.response + field. """ # Create or coerce a protobuf request object. @@ -454,7 +459,8 @@ async def sample_list_custom_models(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.ListCustomModelsRequest, dict]]): The request object. Request message for - [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1alpha.SearchTuningService.ListCustomModels] + `SearchTuningService.ListCustomModels + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -467,8 +473,9 @@ async def sample_list_custom_models(): Returns: google.cloud.discoveryengine_v1alpha.types.ListCustomModelsResponse: Response message for - [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1alpha.SearchTuningService.ListCustomModels] - method. + `SearchTuningService.ListCustomModels + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/search_tuning_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/search_tuning_service/client.py index 044ba7b00135..3e2cded934f3 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/search_tuning_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/search_tuning_service/client.py @@ -791,7 +791,8 @@ def sample_train_custom_model(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.TrainCustomModelRequest, dict]): The request object. Request message for - [SearchTuningService.TrainCustomModel][google.cloud.discoveryengine.v1alpha.SearchTuningService.TrainCustomModel] + `SearchTuningService.TrainCustomModel + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -803,12 +804,16 @@ def sample_train_custom_model(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.TrainCustomModelResponse` Response of the - [TrainCustomModelRequest][google.cloud.discoveryengine.v1alpha.TrainCustomModelRequest]. - This message is returned by the - google.longrunning.Operations.response field. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.TrainCustomModelResponse` + Response of the `TrainCustomModelRequest + `__. + This message is returned by the + google.longrunning.Operations.response + field. """ # Create or coerce a protobuf request object. @@ -892,7 +897,8 @@ def sample_list_custom_models(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.ListCustomModelsRequest, dict]): The request object. Request message for - [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1alpha.SearchTuningService.ListCustomModels] + `SearchTuningService.ListCustomModels + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -905,8 +911,9 @@ def sample_list_custom_models(): Returns: google.cloud.discoveryengine_v1alpha.types.ListCustomModelsResponse: Response message for - [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1alpha.SearchTuningService.ListCustomModels] - method. + `SearchTuningService.ListCustomModels + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/search_tuning_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/search_tuning_service/transports/rest.py index c90fd763bfb7..4df2f12eda9f 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/search_tuning_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/search_tuning_service/transports/rest.py @@ -573,7 +573,8 @@ def __call__( Args: request (~.search_tuning_service.ListCustomModelsRequest): The request object. Request message for - [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1alpha.SearchTuningService.ListCustomModels] + `SearchTuningService.ListCustomModels + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -586,7 +587,8 @@ def __call__( Returns: ~.search_tuning_service.ListCustomModelsResponse: Response message for - [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1alpha.SearchTuningService.ListCustomModels] + `SearchTuningService.ListCustomModels + `__ method. """ @@ -728,7 +730,8 @@ def __call__( Args: request (~.search_tuning_service.TrainCustomModelRequest): The request object. Request message for - [SearchTuningService.TrainCustomModel][google.cloud.discoveryengine.v1alpha.SearchTuningService.TrainCustomModel] + `SearchTuningService.TrainCustomModel + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/serving_config_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/serving_config_service/async_client.py index 1447f23f774d..2bb8f80dedf9 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/serving_config_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/serving_config_service/async_client.py @@ -73,7 +73,8 @@ class ServingConfigServiceAsyncClient: """Service for operations related to - [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig]. + `ServingConfig + `__. """ _client: ServingConfigServiceClient @@ -319,7 +320,8 @@ async def update_serving_config( ) -> gcd_serving_config.ServingConfig: r"""Updates a ServingConfig. - Returns a NOT_FOUND error if the ServingConfig does not exist. + Returns a NOT_FOUND error if the ServingConfig does not + exist. .. code-block:: python @@ -365,12 +367,16 @@ async def sample_update_serving_config(): should not be set. update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): Indicates which fields in the provided - [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig] - to update. The following are NOT supported: + `ServingConfig + `__ + to update. The following are NOT + supported: - - [ServingConfig.name][google.cloud.discoveryengine.v1alpha.ServingConfig.name] + * `ServingConfig.name + `__ - If not set, all supported fields are updated. + If not set, all supported fields are + updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -492,8 +498,8 @@ async def sample_get_serving_config(): request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.GetServingConfigRequest, dict]]): The request object. Request for GetServingConfig method. name (:class:`str`): - Required. The resource name of the ServingConfig to get. - Format: + Required. The resource name of the + ServingConfig to get. Format: ``projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`` This corresponds to the ``name`` field @@ -611,8 +617,8 @@ async def sample_list_serving_configs(): The request object. Request for ListServingConfigs method. parent (:class:`str`): - Required. Full resource name of the parent resource. - Format: + Required. Full resource name of the + parent resource. Format: ``projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`` This corresponds to the ``parent`` field diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/serving_config_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/serving_config_service/client.py index ddb04006b88c..41c620321642 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/serving_config_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/serving_config_service/client.py @@ -119,7 +119,8 @@ def get_transport_class( class ServingConfigServiceClient(metaclass=ServingConfigServiceClientMeta): """Service for operations related to - [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig]. + `ServingConfig + `__. """ @staticmethod @@ -743,7 +744,8 @@ def update_serving_config( ) -> gcd_serving_config.ServingConfig: r"""Updates a ServingConfig. - Returns a NOT_FOUND error if the ServingConfig does not exist. + Returns a NOT_FOUND error if the ServingConfig does not + exist. .. code-block:: python @@ -789,12 +791,16 @@ def sample_update_serving_config(): should not be set. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig] - to update. The following are NOT supported: + `ServingConfig + `__ + to update. The following are NOT + supported: - - [ServingConfig.name][google.cloud.discoveryengine.v1alpha.ServingConfig.name] + * `ServingConfig.name + `__ - If not set, all supported fields are updated. + If not set, all supported fields are + updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -913,8 +919,8 @@ def sample_get_serving_config(): request (Union[google.cloud.discoveryengine_v1alpha.types.GetServingConfigRequest, dict]): The request object. Request for GetServingConfig method. name (str): - Required. The resource name of the ServingConfig to get. - Format: + Required. The resource name of the + ServingConfig to get. Format: ``projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`` This corresponds to the ``name`` field @@ -1029,8 +1035,8 @@ def sample_list_serving_configs(): The request object. Request for ListServingConfigs method. parent (str): - Required. Full resource name of the parent resource. - Format: + Required. Full resource name of the + parent resource. Format: ``projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`` This corresponds to the ``parent`` field diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/serving_config_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/serving_config_service/transports/grpc.py index a05f1bdc3f4f..b16b73bceb4b 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/serving_config_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/serving_config_service/transports/grpc.py @@ -117,7 +117,8 @@ class ServingConfigServiceGrpcTransport(ServingConfigServiceTransport): """gRPC backend transport for ServingConfigService. Service for operations related to - [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig]. + `ServingConfig + `__. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -339,7 +340,8 @@ def update_serving_config( Updates a ServingConfig. - Returns a NOT_FOUND error if the ServingConfig does not exist. + Returns a NOT_FOUND error if the ServingConfig does not + exist. Returns: Callable[[~.UpdateServingConfigRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/serving_config_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/serving_config_service/transports/grpc_asyncio.py index 3f137c837306..e8c26d63497b 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/serving_config_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/serving_config_service/transports/grpc_asyncio.py @@ -123,7 +123,8 @@ class ServingConfigServiceGrpcAsyncIOTransport(ServingConfigServiceTransport): """gRPC AsyncIO backend transport for ServingConfigService. Service for operations related to - [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig]. + `ServingConfig + `__. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -347,7 +348,8 @@ def update_serving_config( Updates a ServingConfig. - Returns a NOT_FOUND error if the ServingConfig does not exist. + Returns a NOT_FOUND error if the ServingConfig does not + exist. Returns: Callable[[~.UpdateServingConfigRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/serving_config_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/serving_config_service/transports/rest.py index e475ede325f4..8f1c8a45bcc1 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/serving_config_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/serving_config_service/transports/rest.py @@ -345,7 +345,8 @@ class ServingConfigServiceRestTransport(_BaseServingConfigServiceRestTransport): """REST backend synchronous transport for ServingConfigService. Service for operations related to - [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig]. + `ServingConfig + `__. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/session_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/session_service/async_client.py index 214877f6d77a..53ed7efacead 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/session_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/session_service/async_client.py @@ -317,8 +317,10 @@ async def create_session( ) -> gcd_session.Session: r"""Creates a Session. - If the [Session][google.cloud.discoveryengine.v1alpha.Session] - to create already exists, an ALREADY_EXISTS error is returned. + If the `Session + `__ to + create already exists, an ALREADY_EXISTS error is + returned. .. code-block:: python @@ -350,8 +352,8 @@ async def sample_create_session(): request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.CreateSessionRequest, dict]]): The request object. Request for CreateSession method. parent (:class:`str`): - Required. Full resource name of parent data store. - Format: + Required. Full resource name of parent + data store. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field @@ -438,8 +440,9 @@ async def delete_session( ) -> None: r"""Deletes a Session. - If the [Session][google.cloud.discoveryengine.v1alpha.Session] - to delete does not exist, a NOT_FOUND error is returned. + If the `Session + `__ to + delete does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -468,8 +471,8 @@ async def sample_delete_session(): request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.DeleteSessionRequest, dict]]): The request object. Request for DeleteSession method. name (:class:`str`): - Required. The resource name of the Session to delete. - Format: + Required. The resource name of the + Session to delete. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` This corresponds to the ``name`` field @@ -543,9 +546,10 @@ async def update_session( ) -> gcd_session.Session: r"""Updates a Session. - [Session][google.cloud.discoveryengine.v1alpha.Session] action - type cannot be changed. If the - [Session][google.cloud.discoveryengine.v1alpha.Session] to + `Session + `__ action + type cannot be changed. If the `Session + `__ to update does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -583,12 +587,16 @@ async def sample_update_session(): should not be set. update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): Indicates which fields in the provided - [Session][google.cloud.discoveryengine.v1alpha.Session] - to update. The following are NOT supported: + `Session + `__ + to update. The following are NOT + supported: - - [Session.name][google.cloud.discoveryengine.v1alpha.Session.name] + * `Session.name + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported + fields are updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -701,8 +709,8 @@ async def sample_get_session(): request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.GetSessionRequest, dict]]): The request object. Request for GetSession method. name (:class:`str`): - Required. The resource name of the Session to get. - Format: + Required. The resource name of the + Session to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` This corresponds to the ``name`` field @@ -781,7 +789,8 @@ async def list_sessions( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListSessionsAsyncPager: r"""Lists all Sessions by their parent - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. + `DataStore + `__. .. code-block:: python @@ -814,7 +823,8 @@ async def sample_list_sessions(): request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.ListSessionsRequest, dict]]): The request object. Request for ListSessions method. parent (:class:`str`): - Required. The data store resource name. Format: + Required. The data store resource name. + Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field @@ -938,12 +948,16 @@ async def sample_list_files(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.ListFilesRequest, dict]]): The request object. Request message for - [SessionService.ListFiles][google.cloud.discoveryengine.v1alpha.SessionService.ListFiles] + `SessionService.ListFiles + `__ method. parent (:class:`str`): - Required. The resource name of the Session. Format: + Required. The resource name of the + Session. Format: + ``projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`` - Name of the session resource to which the file belong. + Name of the session resource to which + the file belong. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -959,11 +973,13 @@ async def sample_list_files(): Returns: google.cloud.discoveryengine_v1alpha.services.session_service.pagers.ListFilesAsyncPager: Response message for - [SessionService.ListFiles][google.cloud.discoveryengine.v1alpha.SessionService.ListFiles] - method. + `SessionService.ListFiles + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/session_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/session_service/client.py index d2c4668b4dac..989ae3409da9 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/session_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/session_service/client.py @@ -836,8 +836,10 @@ def create_session( ) -> gcd_session.Session: r"""Creates a Session. - If the [Session][google.cloud.discoveryengine.v1alpha.Session] - to create already exists, an ALREADY_EXISTS error is returned. + If the `Session + `__ to + create already exists, an ALREADY_EXISTS error is + returned. .. code-block:: python @@ -869,8 +871,8 @@ def sample_create_session(): request (Union[google.cloud.discoveryengine_v1alpha.types.CreateSessionRequest, dict]): The request object. Request for CreateSession method. parent (str): - Required. Full resource name of parent data store. - Format: + Required. Full resource name of parent + data store. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field @@ -954,8 +956,9 @@ def delete_session( ) -> None: r"""Deletes a Session. - If the [Session][google.cloud.discoveryengine.v1alpha.Session] - to delete does not exist, a NOT_FOUND error is returned. + If the `Session + `__ to + delete does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -984,8 +987,8 @@ def sample_delete_session(): request (Union[google.cloud.discoveryengine_v1alpha.types.DeleteSessionRequest, dict]): The request object. Request for DeleteSession method. name (str): - Required. The resource name of the Session to delete. - Format: + Required. The resource name of the + Session to delete. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` This corresponds to the ``name`` field @@ -1056,9 +1059,10 @@ def update_session( ) -> gcd_session.Session: r"""Updates a Session. - [Session][google.cloud.discoveryengine.v1alpha.Session] action - type cannot be changed. If the - [Session][google.cloud.discoveryengine.v1alpha.Session] to + `Session + `__ action + type cannot be changed. If the `Session + `__ to update does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -1096,12 +1100,16 @@ def sample_update_session(): should not be set. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [Session][google.cloud.discoveryengine.v1alpha.Session] - to update. The following are NOT supported: + `Session + `__ + to update. The following are NOT + supported: - - [Session.name][google.cloud.discoveryengine.v1alpha.Session.name] + * `Session.name + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported + fields are updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -1211,8 +1219,8 @@ def sample_get_session(): request (Union[google.cloud.discoveryengine_v1alpha.types.GetSessionRequest, dict]): The request object. Request for GetSession method. name (str): - Required. The resource name of the Session to get. - Format: + Required. The resource name of the + Session to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` This corresponds to the ``name`` field @@ -1288,7 +1296,8 @@ def list_sessions( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListSessionsPager: r"""Lists all Sessions by their parent - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. + `DataStore + `__. .. code-block:: python @@ -1321,7 +1330,8 @@ def sample_list_sessions(): request (Union[google.cloud.discoveryengine_v1alpha.types.ListSessionsRequest, dict]): The request object. Request for ListSessions method. parent (str): - Required. The data store resource name. Format: + Required. The data store resource name. + Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field @@ -1442,12 +1452,16 @@ def sample_list_files(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.ListFilesRequest, dict]): The request object. Request message for - [SessionService.ListFiles][google.cloud.discoveryengine.v1alpha.SessionService.ListFiles] + `SessionService.ListFiles + `__ method. parent (str): - Required. The resource name of the Session. Format: + Required. The resource name of the + Session. Format: + ``projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`` - Name of the session resource to which the file belong. + Name of the session resource to which + the file belong. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -1463,11 +1477,13 @@ def sample_list_files(): Returns: google.cloud.discoveryengine_v1alpha.services.session_service.pagers.ListFilesPager: Response message for - [SessionService.ListFiles][google.cloud.discoveryengine.v1alpha.SessionService.ListFiles] - method. + `SessionService.ListFiles + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/session_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/session_service/transports/grpc.py index b337438a531f..e2ae2285de71 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/session_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/session_service/transports/grpc.py @@ -337,8 +337,10 @@ def create_session( Creates a Session. - If the [Session][google.cloud.discoveryengine.v1alpha.Session] - to create already exists, an ALREADY_EXISTS error is returned. + If the `Session + `__ to + create already exists, an ALREADY_EXISTS error is + returned. Returns: Callable[[~.CreateSessionRequest], @@ -368,8 +370,9 @@ def delete_session( Deletes a Session. - If the [Session][google.cloud.discoveryengine.v1alpha.Session] - to delete does not exist, a NOT_FOUND error is returned. + If the `Session + `__ to + delete does not exist, a NOT_FOUND error is returned. Returns: Callable[[~.DeleteSessionRequest], @@ -399,9 +402,10 @@ def update_session( Updates a Session. - [Session][google.cloud.discoveryengine.v1alpha.Session] action - type cannot be changed. If the - [Session][google.cloud.discoveryengine.v1alpha.Session] to + `Session + `__ action + type cannot be changed. If the `Session + `__ to update does not exist, a NOT_FOUND error is returned. Returns: @@ -458,7 +462,8 @@ def list_sessions( r"""Return a callable for the list sessions method over gRPC. Lists all Sessions by their parent - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. + `DataStore + `__. Returns: Callable[[~.ListSessionsRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/session_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/session_service/transports/grpc_asyncio.py index 2674071048ef..b9ed74914f66 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/session_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/session_service/transports/grpc_asyncio.py @@ -346,8 +346,10 @@ def create_session( Creates a Session. - If the [Session][google.cloud.discoveryengine.v1alpha.Session] - to create already exists, an ALREADY_EXISTS error is returned. + If the `Session + `__ to + create already exists, an ALREADY_EXISTS error is + returned. Returns: Callable[[~.CreateSessionRequest], @@ -377,8 +379,9 @@ def delete_session( Deletes a Session. - If the [Session][google.cloud.discoveryengine.v1alpha.Session] - to delete does not exist, a NOT_FOUND error is returned. + If the `Session + `__ to + delete does not exist, a NOT_FOUND error is returned. Returns: Callable[[~.DeleteSessionRequest], @@ -409,9 +412,10 @@ def update_session( Updates a Session. - [Session][google.cloud.discoveryengine.v1alpha.Session] action - type cannot be changed. If the - [Session][google.cloud.discoveryengine.v1alpha.Session] to + `Session + `__ action + type cannot be changed. If the `Session + `__ to update does not exist, a NOT_FOUND error is returned. Returns: @@ -470,7 +474,8 @@ def list_sessions( r"""Return a callable for the list sessions method over gRPC. Lists all Sessions by their parent - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. + `DataStore + `__. Returns: Callable[[~.ListSessionsRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/session_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/session_service/transports/rest.py index bfc68a801c15..c2fa2ce2df07 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/session_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/session_service/transports/rest.py @@ -990,7 +990,8 @@ def __call__( Args: request (~.session_service.ListFilesRequest): The request object. Request message for - [SessionService.ListFiles][google.cloud.discoveryengine.v1alpha.SessionService.ListFiles] + `SessionService.ListFiles + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1003,7 +1004,8 @@ def __call__( Returns: ~.session_service.ListFilesResponse: Response message for - [SessionService.ListFiles][google.cloud.discoveryengine.v1alpha.SessionService.ListFiles] + `SessionService.ListFiles + `__ method. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/site_search_engine_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/site_search_engine_service/async_client.py index e7afd8396e21..21364a486697 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/site_search_engine_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/site_search_engine_service/async_client.py @@ -329,7 +329,8 @@ async def get_site_search_engine( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> site_search_engine.SiteSearchEngine: r"""Gets the - [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine]. + `SiteSearchEngine + `__. .. code-block:: python @@ -360,17 +361,20 @@ async def sample_get_site_search_engine(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.GetSiteSearchEngineRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.GetSiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetSiteSearchEngine] + `SiteSearchEngineService.GetSiteSearchEngine + `__ method. name (:class:`str`): Required. Resource name of - [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. - If the caller does not have permission to access the - [SiteSearchEngine], regardless of whether or not it - exists, a PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the [SiteSearchEngine], + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -454,8 +458,8 @@ async def create_target_site( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Creates a - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]. + r"""Creates a `TargetSite + `__. .. code-block:: python @@ -494,11 +498,13 @@ async def sample_create_target_site(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.CreateTargetSiteRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.CreateTargetSite] + `SiteSearchEngineService.CreateTargetSite + `__ method. parent (:class:`str`): Required. Parent resource name of - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. @@ -506,8 +512,8 @@ async def sample_create_target_site(): on the ``request`` instance; if ``request`` is provided, this should not be set. target_site (:class:`google.cloud.discoveryengine_v1alpha.types.TargetSite`): - Required. The - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] + Required. The `TargetSite + `__ to create. This corresponds to the ``target_site`` field @@ -523,9 +529,10 @@ async def sample_create_target_site(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1alpha.types.TargetSite` A target site for the SiteSearchEngine. @@ -599,8 +606,8 @@ async def batch_create_target_sites( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Creates - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] in + r"""Creates `TargetSite + `__ in a batch. .. code-block:: python @@ -641,7 +648,8 @@ async def sample_batch_create_target_sites(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.BatchCreateTargetSitesRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchCreateTargetSites] + `SiteSearchEngineService.BatchCreateTargetSites + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -653,11 +661,15 @@ async def sample_batch_create_target_sites(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.BatchCreateTargetSitesResponse` Response message for - [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchCreateTargetSites] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.BatchCreateTargetSitesResponse` + Response message for + `SiteSearchEngineService.BatchCreateTargetSites + `__ + method. """ # Create or coerce a protobuf request object. @@ -713,8 +725,8 @@ async def get_target_site( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> site_search_engine.TargetSite: - r"""Gets a - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]. + r"""Gets a `TargetSite + `__. .. code-block:: python @@ -745,22 +757,27 @@ async def sample_get_target_site(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.GetTargetSiteRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.GetTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetTargetSite] + `SiteSearchEngineService.GetTargetSite + `__ method. name (:class:`str`): Required. Full resource name of - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}``. - If the caller does not have permission to access the - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `TargetSite + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. If the requested - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] - does not exist, a NOT_FOUND error is returned. + `TargetSite + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -839,8 +856,8 @@ async def update_target_site( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Updates a - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]. + r"""Updates a `TargetSite + `__. .. code-block:: python @@ -878,18 +895,21 @@ async def sample_update_target_site(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.UpdateTargetSiteRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.UpdateTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.UpdateTargetSite] + `SiteSearchEngineService.UpdateTargetSite + `__ method. target_site (:class:`google.cloud.discoveryengine_v1alpha.types.TargetSite`): - Required. The target site to update. If the caller does - not have permission to update the - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. - - If the - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] - to update does not exist, a NOT_FOUND error is returned. + Required. The target site to update. + If the caller does not have permission + to update the `TargetSite + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. + + If the `TargetSite + `__ + to update does not exist, a NOT_FOUND + error is returned. This corresponds to the ``target_site`` field on the ``request`` instance; if ``request`` is provided, this @@ -904,9 +924,10 @@ async def sample_update_target_site(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1alpha.types.TargetSite` A target site for the SiteSearchEngine. @@ -981,8 +1002,8 @@ async def delete_target_site( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Deletes a - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]. + r"""Deletes a `TargetSite + `__. .. code-block:: python @@ -1017,22 +1038,27 @@ async def sample_delete_target_site(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.DeleteTargetSiteRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DeleteTargetSite] + `SiteSearchEngineService.DeleteTargetSite + `__ method. name (:class:`str`): Required. Full resource name of - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}``. - If the caller does not have permission to access the - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `TargetSite + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. If the requested - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] - does not exist, a NOT_FOUND error is returned. + `TargetSite + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -1047,18 +1073,21 @@ async def sample_delete_target_site(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. @@ -1130,7 +1159,8 @@ async def list_target_sites( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListTargetSitesAsyncPager: r"""Gets a list of - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]s. + `TargetSite + `__s. .. code-block:: python @@ -1162,17 +1192,20 @@ async def sample_list_target_sites(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.ListTargetSitesRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.ListTargetSites] + `SiteSearchEngineService.ListTargetSites + `__ method. parent (:class:`str`): - Required. The parent site search engine resource name, - such as + Required. The parent site search engine + resource name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. - If the caller does not have permission to list - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]s - under this site search engine, regardless of whether or - not this branch exists, a PERMISSION_DENIED error is + If the caller does not have permission + to list `TargetSite + `__s + under this site search engine, + regardless of whether or not this branch + exists, a PERMISSION_DENIED error is returned. This corresponds to the ``parent`` field @@ -1189,11 +1222,13 @@ async def sample_list_target_sites(): Returns: google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.pagers.ListTargetSitesAsyncPager: Response message for - [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.ListTargetSites] - method. + `SiteSearchEngineService.ListTargetSites + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -1302,7 +1337,8 @@ async def sample_enable_advanced_site_search(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.EnableAdvancedSiteSearchRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.EnableAdvancedSiteSearch] + `SiteSearchEngineService.EnableAdvancedSiteSearch + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -1314,11 +1350,15 @@ async def sample_enable_advanced_site_search(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.EnableAdvancedSiteSearchResponse` Response message for - [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.EnableAdvancedSiteSearch] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.EnableAdvancedSiteSearchResponse` + Response message for + `SiteSearchEngineService.EnableAdvancedSiteSearch + `__ + method. """ # Create or coerce a protobuf request object. @@ -1413,7 +1453,8 @@ async def sample_disable_advanced_site_search(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.DisableAdvancedSiteSearchRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DisableAdvancedSiteSearch] + `SiteSearchEngineService.DisableAdvancedSiteSearch + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -1425,11 +1466,15 @@ async def sample_disable_advanced_site_search(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.DisableAdvancedSiteSearchResponse` Response message for - [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DisableAdvancedSiteSearch] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.DisableAdvancedSiteSearchResponse` + Response message for + `SiteSearchEngineService.DisableAdvancedSiteSearch + `__ + method. """ # Create or coerce a protobuf request object. @@ -1524,7 +1569,8 @@ async def sample_recrawl_uris(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.RecrawlUrisRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.RecrawlUris] + `SiteSearchEngineService.RecrawlUris + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -1536,11 +1582,15 @@ async def sample_recrawl_uris(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.RecrawlUrisResponse` Response message for - [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.RecrawlUris] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.RecrawlUrisResponse` + Response message for + `SiteSearchEngineService.RecrawlUris + `__ + method. """ # Create or coerce a protobuf request object. @@ -1632,7 +1682,8 @@ async def sample_batch_verify_target_sites(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.BatchVerifyTargetSitesRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchVerifyTargetSites] + `SiteSearchEngineService.BatchVerifyTargetSites + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -1644,11 +1695,15 @@ async def sample_batch_verify_target_sites(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.BatchVerifyTargetSitesResponse` Response message for - [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchVerifyTargetSites] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.BatchVerifyTargetSitesResponse` + Response message for + `SiteSearchEngineService.BatchVerifyTargetSites + `__ + method. """ # Create or coerce a protobuf request object. @@ -1703,9 +1758,10 @@ async def fetch_domain_verification_status( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.FetchDomainVerificationStatusAsyncPager: - r"""Returns list of target sites with its domain verification - status. This method can only be called under data store with - BASIC_SITE_SEARCH state at the moment. + r"""Returns list of target sites with its domain + verification status. This method can only be called + under data store with BASIC_SITE_SEARCH state at the + moment. .. code-block:: python @@ -1737,7 +1793,8 @@ async def sample_fetch_domain_verification_status(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.FetchDomainVerificationStatusRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.FetchDomainVerificationStatus] + `SiteSearchEngineService.FetchDomainVerificationStatus + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -1750,11 +1807,13 @@ async def sample_fetch_domain_verification_status(): Returns: google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.pagers.FetchDomainVerificationStatusAsyncPager: Response message for - [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.FetchDomainVerificationStatus] - method. + `SiteSearchEngineService.FetchDomainVerificationStatus + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -1852,7 +1911,8 @@ async def sample_set_uri_pattern_document_data(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.SetUriPatternDocumentDataRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.SetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData] + `SiteSearchEngineService.SetUriPatternDocumentData + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -1864,11 +1924,15 @@ async def sample_set_uri_pattern_document_data(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.SetUriPatternDocumentDataResponse` Response message for - [SiteSearchEngineService.SetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.SetUriPatternDocumentDataResponse` + Response message for + `SiteSearchEngineService.SetUriPatternDocumentData + `__ + method. """ # Create or coerce a protobuf request object. @@ -1959,7 +2023,8 @@ async def sample_get_uri_pattern_document_data(): Args: request (Optional[Union[google.cloud.discoveryengine_v1alpha.types.GetUriPatternDocumentDataRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.GetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetUriPatternDocumentData] + `SiteSearchEngineService.GetUriPatternDocumentData + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -1972,8 +2037,9 @@ async def sample_get_uri_pattern_document_data(): Returns: google.cloud.discoveryengine_v1alpha.types.GetUriPatternDocumentDataResponse: Response message for - [SiteSearchEngineService.GetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetUriPatternDocumentData] - method. + `SiteSearchEngineService.GetUriPatternDocumentData + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/site_search_engine_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/site_search_engine_service/client.py index 9452cdc64216..b6abc45e067e 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/site_search_engine_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/site_search_engine_service/client.py @@ -767,7 +767,8 @@ def get_site_search_engine( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> site_search_engine.SiteSearchEngine: r"""Gets the - [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine]. + `SiteSearchEngine + `__. .. code-block:: python @@ -798,17 +799,20 @@ def sample_get_site_search_engine(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.GetSiteSearchEngineRequest, dict]): The request object. Request message for - [SiteSearchEngineService.GetSiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetSiteSearchEngine] + `SiteSearchEngineService.GetSiteSearchEngine + `__ method. name (str): Required. Resource name of - [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. - If the caller does not have permission to access the - [SiteSearchEngine], regardless of whether or not it - exists, a PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the [SiteSearchEngine], + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -889,8 +893,8 @@ def create_target_site( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Creates a - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]. + r"""Creates a `TargetSite + `__. .. code-block:: python @@ -929,11 +933,13 @@ def sample_create_target_site(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.CreateTargetSiteRequest, dict]): The request object. Request message for - [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.CreateTargetSite] + `SiteSearchEngineService.CreateTargetSite + `__ method. parent (str): Required. Parent resource name of - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. @@ -941,8 +947,8 @@ def sample_create_target_site(): on the ``request`` instance; if ``request`` is provided, this should not be set. target_site (google.cloud.discoveryengine_v1alpha.types.TargetSite): - Required. The - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] + Required. The `TargetSite + `__ to create. This corresponds to the ``target_site`` field @@ -958,9 +964,10 @@ def sample_create_target_site(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1alpha.types.TargetSite` A target site for the SiteSearchEngine. @@ -1031,8 +1038,8 @@ def batch_create_target_sites( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Creates - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] in + r"""Creates `TargetSite + `__ in a batch. .. code-block:: python @@ -1073,7 +1080,8 @@ def sample_batch_create_target_sites(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.BatchCreateTargetSitesRequest, dict]): The request object. Request message for - [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchCreateTargetSites] + `SiteSearchEngineService.BatchCreateTargetSites + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1085,11 +1093,15 @@ def sample_batch_create_target_sites(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.BatchCreateTargetSitesResponse` Response message for - [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchCreateTargetSites] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.BatchCreateTargetSitesResponse` + Response message for + `SiteSearchEngineService.BatchCreateTargetSites + `__ + method. """ # Create or coerce a protobuf request object. @@ -1145,8 +1157,8 @@ def get_target_site( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> site_search_engine.TargetSite: - r"""Gets a - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]. + r"""Gets a `TargetSite + `__. .. code-block:: python @@ -1177,22 +1189,27 @@ def sample_get_target_site(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.GetTargetSiteRequest, dict]): The request object. Request message for - [SiteSearchEngineService.GetTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetTargetSite] + `SiteSearchEngineService.GetTargetSite + `__ method. name (str): Required. Full resource name of - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}``. - If the caller does not have permission to access the - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `TargetSite + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. If the requested - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] - does not exist, a NOT_FOUND error is returned. + `TargetSite + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -1268,8 +1285,8 @@ def update_target_site( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Updates a - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]. + r"""Updates a `TargetSite + `__. .. code-block:: python @@ -1307,18 +1324,21 @@ def sample_update_target_site(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.UpdateTargetSiteRequest, dict]): The request object. Request message for - [SiteSearchEngineService.UpdateTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.UpdateTargetSite] + `SiteSearchEngineService.UpdateTargetSite + `__ method. target_site (google.cloud.discoveryengine_v1alpha.types.TargetSite): - Required. The target site to update. If the caller does - not have permission to update the - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. - - If the - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] - to update does not exist, a NOT_FOUND error is returned. + Required. The target site to update. + If the caller does not have permission + to update the `TargetSite + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. + + If the `TargetSite + `__ + to update does not exist, a NOT_FOUND + error is returned. This corresponds to the ``target_site`` field on the ``request`` instance; if ``request`` is provided, this @@ -1333,9 +1353,10 @@ def sample_update_target_site(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1alpha.types.TargetSite` A target site for the SiteSearchEngine. @@ -1407,8 +1428,8 @@ def delete_target_site( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Deletes a - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]. + r"""Deletes a `TargetSite + `__. .. code-block:: python @@ -1443,22 +1464,27 @@ def sample_delete_target_site(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.DeleteTargetSiteRequest, dict]): The request object. Request message for - [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DeleteTargetSite] + `SiteSearchEngineService.DeleteTargetSite + `__ method. name (str): Required. Full resource name of - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}``. - If the caller does not have permission to access the - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `TargetSite + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. If the requested - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] - does not exist, a NOT_FOUND error is returned. + `TargetSite + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -1473,18 +1499,21 @@ def sample_delete_target_site(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. @@ -1553,7 +1582,8 @@ def list_target_sites( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListTargetSitesPager: r"""Gets a list of - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]s. + `TargetSite + `__s. .. code-block:: python @@ -1585,17 +1615,20 @@ def sample_list_target_sites(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.ListTargetSitesRequest, dict]): The request object. Request message for - [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.ListTargetSites] + `SiteSearchEngineService.ListTargetSites + `__ method. parent (str): - Required. The parent site search engine resource name, - such as + Required. The parent site search engine + resource name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. - If the caller does not have permission to list - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]s - under this site search engine, regardless of whether or - not this branch exists, a PERMISSION_DENIED error is + If the caller does not have permission + to list `TargetSite + `__s + under this site search engine, + regardless of whether or not this branch + exists, a PERMISSION_DENIED error is returned. This corresponds to the ``parent`` field @@ -1612,11 +1645,13 @@ def sample_list_target_sites(): Returns: google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.pagers.ListTargetSitesPager: Response message for - [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.ListTargetSites] - method. + `SiteSearchEngineService.ListTargetSites + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -1722,7 +1757,8 @@ def sample_enable_advanced_site_search(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.EnableAdvancedSiteSearchRequest, dict]): The request object. Request message for - [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.EnableAdvancedSiteSearch] + `SiteSearchEngineService.EnableAdvancedSiteSearch + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1734,11 +1770,15 @@ def sample_enable_advanced_site_search(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.EnableAdvancedSiteSearchResponse` Response message for - [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.EnableAdvancedSiteSearch] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.EnableAdvancedSiteSearchResponse` + Response message for + `SiteSearchEngineService.EnableAdvancedSiteSearch + `__ + method. """ # Create or coerce a protobuf request object. @@ -1833,7 +1873,8 @@ def sample_disable_advanced_site_search(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.DisableAdvancedSiteSearchRequest, dict]): The request object. Request message for - [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DisableAdvancedSiteSearch] + `SiteSearchEngineService.DisableAdvancedSiteSearch + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1845,11 +1886,15 @@ def sample_disable_advanced_site_search(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.DisableAdvancedSiteSearchResponse` Response message for - [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DisableAdvancedSiteSearch] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.DisableAdvancedSiteSearchResponse` + Response message for + `SiteSearchEngineService.DisableAdvancedSiteSearch + `__ + method. """ # Create or coerce a protobuf request object. @@ -1944,7 +1989,8 @@ def sample_recrawl_uris(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.RecrawlUrisRequest, dict]): The request object. Request message for - [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.RecrawlUris] + `SiteSearchEngineService.RecrawlUris + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1956,11 +2002,15 @@ def sample_recrawl_uris(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.RecrawlUrisResponse` Response message for - [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.RecrawlUris] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.RecrawlUrisResponse` + Response message for + `SiteSearchEngineService.RecrawlUris + `__ + method. """ # Create or coerce a protobuf request object. @@ -2050,7 +2100,8 @@ def sample_batch_verify_target_sites(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.BatchVerifyTargetSitesRequest, dict]): The request object. Request message for - [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchVerifyTargetSites] + `SiteSearchEngineService.BatchVerifyTargetSites + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2062,11 +2113,15 @@ def sample_batch_verify_target_sites(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.BatchVerifyTargetSitesResponse` Response message for - [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchVerifyTargetSites] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.BatchVerifyTargetSitesResponse` + Response message for + `SiteSearchEngineService.BatchVerifyTargetSites + `__ + method. """ # Create or coerce a protobuf request object. @@ -2121,9 +2176,10 @@ def fetch_domain_verification_status( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.FetchDomainVerificationStatusPager: - r"""Returns list of target sites with its domain verification - status. This method can only be called under data store with - BASIC_SITE_SEARCH state at the moment. + r"""Returns list of target sites with its domain + verification status. This method can only be called + under data store with BASIC_SITE_SEARCH state at the + moment. .. code-block:: python @@ -2155,7 +2211,8 @@ def sample_fetch_domain_verification_status(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.FetchDomainVerificationStatusRequest, dict]): The request object. Request message for - [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.FetchDomainVerificationStatus] + `SiteSearchEngineService.FetchDomainVerificationStatus + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2168,11 +2225,13 @@ def sample_fetch_domain_verification_status(): Returns: google.cloud.discoveryengine_v1alpha.services.site_search_engine_service.pagers.FetchDomainVerificationStatusPager: Response message for - [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.FetchDomainVerificationStatus] - method. + `SiteSearchEngineService.FetchDomainVerificationStatus + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -2270,7 +2329,8 @@ def sample_set_uri_pattern_document_data(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.SetUriPatternDocumentDataRequest, dict]): The request object. Request message for - [SiteSearchEngineService.SetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData] + `SiteSearchEngineService.SetUriPatternDocumentData + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2282,11 +2342,15 @@ def sample_set_uri_pattern_document_data(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.SetUriPatternDocumentDataResponse` Response message for - [SiteSearchEngineService.SetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.SetUriPatternDocumentDataResponse` + Response message for + `SiteSearchEngineService.SetUriPatternDocumentData + `__ + method. """ # Create or coerce a protobuf request object. @@ -2377,7 +2441,8 @@ def sample_get_uri_pattern_document_data(): Args: request (Union[google.cloud.discoveryengine_v1alpha.types.GetUriPatternDocumentDataRequest, dict]): The request object. Request message for - [SiteSearchEngineService.GetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetUriPatternDocumentData] + `SiteSearchEngineService.GetUriPatternDocumentData + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2390,8 +2455,9 @@ def sample_get_uri_pattern_document_data(): Returns: google.cloud.discoveryengine_v1alpha.types.GetUriPatternDocumentDataResponse: Response message for - [SiteSearchEngineService.GetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetUriPatternDocumentData] - method. + `SiteSearchEngineService.GetUriPatternDocumentData + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/site_search_engine_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/site_search_engine_service/transports/grpc.py index 8f382f491cae..b5e670647b97 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/site_search_engine_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/site_search_engine_service/transports/grpc.py @@ -353,7 +353,8 @@ def get_site_search_engine( r"""Return a callable for the get site search engine method over gRPC. Gets the - [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine]. + `SiteSearchEngine + `__. Returns: Callable[[~.GetSiteSearchEngineRequest], @@ -381,8 +382,8 @@ def create_target_site( ]: r"""Return a callable for the create target site method over gRPC. - Creates a - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]. + Creates a `TargetSite + `__. Returns: Callable[[~.CreateTargetSiteRequest], @@ -411,8 +412,8 @@ def batch_create_target_sites( ]: r"""Return a callable for the batch create target sites method over gRPC. - Creates - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] in + Creates `TargetSite + `__ in a batch. Returns: @@ -441,8 +442,8 @@ def get_target_site( ]: r"""Return a callable for the get target site method over gRPC. - Gets a - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]. + Gets a `TargetSite + `__. Returns: Callable[[~.GetTargetSiteRequest], @@ -470,8 +471,8 @@ def update_target_site( ]: r"""Return a callable for the update target site method over gRPC. - Updates a - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]. + Updates a `TargetSite + `__. Returns: Callable[[~.UpdateTargetSiteRequest], @@ -499,8 +500,8 @@ def delete_target_site( ]: r"""Return a callable for the delete target site method over gRPC. - Deletes a - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]. + Deletes a `TargetSite + `__. Returns: Callable[[~.DeleteTargetSiteRequest], @@ -530,7 +531,8 @@ def list_target_sites( r"""Return a callable for the list target sites method over gRPC. Gets a list of - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]s. + `TargetSite + `__s. Returns: Callable[[~.ListTargetSitesRequest], @@ -683,9 +685,10 @@ def fetch_domain_verification_status( r"""Return a callable for the fetch domain verification status method over gRPC. - Returns list of target sites with its domain verification - status. This method can only be called under data store with - BASIC_SITE_SEARCH state at the moment. + Returns list of target sites with its domain + verification status. This method can only be called + under data store with BASIC_SITE_SEARCH state at the + moment. Returns: Callable[[~.FetchDomainVerificationStatusRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/site_search_engine_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/site_search_engine_service/transports/grpc_asyncio.py index 2ed1e259fb54..663443d64a8d 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/site_search_engine_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/site_search_engine_service/transports/grpc_asyncio.py @@ -361,7 +361,8 @@ def get_site_search_engine( r"""Return a callable for the get site search engine method over gRPC. Gets the - [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine]. + `SiteSearchEngine + `__. Returns: Callable[[~.GetSiteSearchEngineRequest], @@ -390,8 +391,8 @@ def create_target_site( ]: r"""Return a callable for the create target site method over gRPC. - Creates a - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]. + Creates a `TargetSite + `__. Returns: Callable[[~.CreateTargetSiteRequest], @@ -420,8 +421,8 @@ def batch_create_target_sites( ]: r"""Return a callable for the batch create target sites method over gRPC. - Creates - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] in + Creates `TargetSite + `__ in a batch. Returns: @@ -451,8 +452,8 @@ def get_target_site( ]: r"""Return a callable for the get target site method over gRPC. - Gets a - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]. + Gets a `TargetSite + `__. Returns: Callable[[~.GetTargetSiteRequest], @@ -481,8 +482,8 @@ def update_target_site( ]: r"""Return a callable for the update target site method over gRPC. - Updates a - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]. + Updates a `TargetSite + `__. Returns: Callable[[~.UpdateTargetSiteRequest], @@ -511,8 +512,8 @@ def delete_target_site( ]: r"""Return a callable for the delete target site method over gRPC. - Deletes a - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]. + Deletes a `TargetSite + `__. Returns: Callable[[~.DeleteTargetSiteRequest], @@ -542,7 +543,8 @@ def list_target_sites( r"""Return a callable for the list target sites method over gRPC. Gets a list of - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]s. + `TargetSite + `__s. Returns: Callable[[~.ListTargetSitesRequest], @@ -696,9 +698,10 @@ def fetch_domain_verification_status( r"""Return a callable for the fetch domain verification status method over gRPC. - Returns list of target sites with its domain verification - status. This method can only be called under data store with - BASIC_SITE_SEARCH state at the moment. + Returns list of target sites with its domain + verification status. This method can only be called + under data store with BASIC_SITE_SEARCH state at the + moment. Returns: Callable[[~.FetchDomainVerificationStatusRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/site_search_engine_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/site_search_engine_service/transports/rest.py index 7fc6fb032896..386bc8783b87 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/site_search_engine_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/site_search_engine_service/transports/rest.py @@ -1269,7 +1269,8 @@ def __call__( Args: request (~.site_search_engine_service.BatchCreateTargetSitesRequest): The request object. Request message for - [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchCreateTargetSites] + `SiteSearchEngineService.BatchCreateTargetSites + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1425,7 +1426,8 @@ def __call__( Args: request (~.site_search_engine_service.BatchVerifyTargetSitesRequest): The request object. Request message for - [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchVerifyTargetSites] + `SiteSearchEngineService.BatchVerifyTargetSites + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1581,7 +1583,8 @@ def __call__( Args: request (~.site_search_engine_service.CreateTargetSiteRequest): The request object. Request message for - [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.CreateTargetSite] + `SiteSearchEngineService.CreateTargetSite + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1738,7 +1741,8 @@ def __call__( Args: request (~.site_search_engine_service.DeleteTargetSiteRequest): The request object. Request message for - [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DeleteTargetSite] + `SiteSearchEngineService.DeleteTargetSite + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1894,7 +1898,8 @@ def __call__( Args: request (~.site_search_engine_service.DisableAdvancedSiteSearchRequest): The request object. Request message for - [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DisableAdvancedSiteSearch] + `SiteSearchEngineService.DisableAdvancedSiteSearch + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2051,7 +2056,8 @@ def __call__( Args: request (~.site_search_engine_service.EnableAdvancedSiteSearchRequest): The request object. Request message for - [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.EnableAdvancedSiteSearch] + `SiteSearchEngineService.EnableAdvancedSiteSearch + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2209,7 +2215,8 @@ def __call__( Args: request (~.site_search_engine_service.FetchDomainVerificationStatusRequest): The request object. Request message for - [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.FetchDomainVerificationStatus] + `SiteSearchEngineService.FetchDomainVerificationStatus + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2222,7 +2229,8 @@ def __call__( Returns: ~.site_search_engine_service.FetchDomainVerificationStatusResponse: Response message for - [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.FetchDomainVerificationStatus] + `SiteSearchEngineService.FetchDomainVerificationStatus + `__ method. """ @@ -2370,7 +2378,8 @@ def __call__( Args: request (~.site_search_engine_service.GetSiteSearchEngineRequest): The request object. Request message for - [SiteSearchEngineService.GetSiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetSiteSearchEngine] + `SiteSearchEngineService.GetSiteSearchEngine + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2527,7 +2536,8 @@ def __call__( Args: request (~.site_search_engine_service.GetTargetSiteRequest): The request object. Request message for - [SiteSearchEngineService.GetTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetTargetSite] + `SiteSearchEngineService.GetTargetSite + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2681,7 +2691,8 @@ def __call__( Args: request (~.site_search_engine_service.GetUriPatternDocumentDataRequest): The request object. Request message for - [SiteSearchEngineService.GetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetUriPatternDocumentData] + `SiteSearchEngineService.GetUriPatternDocumentData + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2694,7 +2705,8 @@ def __call__( Returns: ~.site_search_engine_service.GetUriPatternDocumentDataResponse: Response message for - [SiteSearchEngineService.GetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetUriPatternDocumentData] + `SiteSearchEngineService.GetUriPatternDocumentData + `__ method. """ @@ -2840,7 +2852,8 @@ def __call__( Args: request (~.site_search_engine_service.ListTargetSitesRequest): The request object. Request message for - [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.ListTargetSites] + `SiteSearchEngineService.ListTargetSites + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2853,7 +2866,8 @@ def __call__( Returns: ~.site_search_engine_service.ListTargetSitesResponse: Response message for - [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.ListTargetSites] + `SiteSearchEngineService.ListTargetSites + `__ method. """ @@ -2999,7 +3013,8 @@ def __call__( Args: request (~.site_search_engine_service.RecrawlUrisRequest): The request object. Request message for - [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.RecrawlUris] + `SiteSearchEngineService.RecrawlUris + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -3156,7 +3171,8 @@ def __call__( Args: request (~.site_search_engine_service.SetUriPatternDocumentDataRequest): The request object. Request message for - [SiteSearchEngineService.SetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData] + `SiteSearchEngineService.SetUriPatternDocumentData + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -3315,7 +3331,8 @@ def __call__( Args: request (~.site_search_engine_service.UpdateTargetSiteRequest): The request object. Request message for - [SiteSearchEngineService.UpdateTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.UpdateTargetSite] + `SiteSearchEngineService.UpdateTargetSite + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/user_event_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/user_event_service/async_client.py index 1bb360f4083c..c69f3fb5cad9 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/user_event_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/user_event_service/async_client.py @@ -455,52 +455,61 @@ async def sample_collect_user_event(): Returns: google.api.httpbody_pb2.HttpBody: - Message that represents an arbitrary HTTP body. It should only be used for - payload formats that can't be represented as JSON, - such as raw binary or an HTML page. - - This message can be used both in streaming and - non-streaming API methods in the request as well as - the response. - - It can be used as a top-level request field, which is - convenient if one wants to extract parameters from - either the URL or HTTP template into the request - fields and also want access to the raw HTTP body. - - Example: - - message GetResourceRequest { - // A unique request id. string request_id = 1; - - // The raw HTTP body is bound to this field. - google.api.HttpBody http_body = 2; - - } - - service ResourceService { - rpc GetResource(GetResourceRequest) - returns (google.api.HttpBody); - - rpc UpdateResource(google.api.HttpBody) - returns (google.protobuf.Empty); - - } - - Example with streaming methods: - - service CaldavService { - rpc GetCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); - - rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); - - } - - Use of this type only changes how the request and - response bodies are handled, all other features will - continue to work unchanged. + Message that represents an arbitrary + HTTP body. It should only be used for + payload formats that can't be + represented as JSON, such as raw binary + or an HTML page. + + This message can be used both in + streaming and non-streaming API methods + in the request as well as the response. + + It can be used as a top-level request + field, which is convenient if one wants + to extract parameters from either the + URL or HTTP template into the request + fields and also want access to the raw + HTTP body. + + Example: + + message GetResourceRequest { + // A unique request id. + string request_id = 1; + + // The raw HTTP body is bound to + this field. google.api.HttpBody + http_body = 2; + + } + + service ResourceService { + rpc + GetResource(GetResourceRequest) + returns (google.api.HttpBody); + rpc + UpdateResource(google.api.HttpBody) + returns (google.protobuf.Empty); + + } + + Example with streaming methods: + + service CaldavService { + rpc GetCalendar(stream + google.api.HttpBody) returns + (stream google.api.HttpBody); rpc + UpdateCalendar(stream + google.api.HttpBody) returns + (stream google.api.HttpBody); + + } + + Use of this type only changes how the + request and response bodies are handled, + all other features will continue to work + unchanged. """ # Create or coerce a protobuf request object. @@ -594,11 +603,17 @@ async def sample_purge_user_events(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.PurgeUserEventsResponse` Response of the PurgeUserEventsRequest. If the long running operation is - successfully done, then this message is returned by - the google.longrunning.Operations.response field. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.PurgeUserEventsResponse` + Response of the PurgeUserEventsRequest. + If the long running operation is + successfully done, then this message is + returned by the + google.longrunning.Operations.response + field. """ # Create or coerce a protobuf request object. @@ -707,13 +722,17 @@ async def sample_import_user_events(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.ImportUserEventsResponse` Response of the ImportUserEventsRequest. If the long running - operation was successful, then this message is - returned by the - google.longrunning.Operations.response field if the - operation was successful. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.ImportUserEventsResponse` + Response of the ImportUserEventsRequest. + If the long running operation was + successful, then this message is + returned by the + google.longrunning.Operations.response + field if the operation was successful. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/user_event_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/user_event_service/client.py index edd1c68b80a8..38c409c69d8e 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/user_event_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/user_event_service/client.py @@ -923,52 +923,61 @@ def sample_collect_user_event(): Returns: google.api.httpbody_pb2.HttpBody: - Message that represents an arbitrary HTTP body. It should only be used for - payload formats that can't be represented as JSON, - such as raw binary or an HTML page. + Message that represents an arbitrary + HTTP body. It should only be used for + payload formats that can't be + represented as JSON, such as raw binary + or an HTML page. - This message can be used both in streaming and - non-streaming API methods in the request as well as - the response. + This message can be used both in + streaming and non-streaming API methods + in the request as well as the response. - It can be used as a top-level request field, which is - convenient if one wants to extract parameters from - either the URL or HTTP template into the request - fields and also want access to the raw HTTP body. + It can be used as a top-level request + field, which is convenient if one wants + to extract parameters from either the + URL or HTTP template into the request + fields and also want access to the raw + HTTP body. - Example: + Example: - message GetResourceRequest { - // A unique request id. string request_id = 1; + message GetResourceRequest { + // A unique request id. + string request_id = 1; - // The raw HTTP body is bound to this field. - google.api.HttpBody http_body = 2; + // The raw HTTP body is bound to + this field. google.api.HttpBody + http_body = 2; - } - - service ResourceService { - rpc GetResource(GetResourceRequest) - returns (google.api.HttpBody); - - rpc UpdateResource(google.api.HttpBody) - returns (google.protobuf.Empty); + } - } + service ResourceService { + rpc + GetResource(GetResourceRequest) + returns (google.api.HttpBody); + rpc + UpdateResource(google.api.HttpBody) + returns (google.protobuf.Empty); - Example with streaming methods: + } - service CaldavService { - rpc GetCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); + Example with streaming methods: - rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); + service CaldavService { + rpc GetCalendar(stream + google.api.HttpBody) returns + (stream google.api.HttpBody); rpc + UpdateCalendar(stream + google.api.HttpBody) returns + (stream google.api.HttpBody); - } + } - Use of this type only changes how the request and - response bodies are handled, all other features will - continue to work unchanged. + Use of this type only changes how the + request and response bodies are handled, + all other features will continue to work + unchanged. """ # Create or coerce a protobuf request object. @@ -1060,11 +1069,17 @@ def sample_purge_user_events(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.PurgeUserEventsResponse` Response of the PurgeUserEventsRequest. If the long running operation is - successfully done, then this message is returned by - the google.longrunning.Operations.response field. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.PurgeUserEventsResponse` + Response of the PurgeUserEventsRequest. + If the long running operation is + successfully done, then this message is + returned by the + google.longrunning.Operations.response + field. """ # Create or coerce a protobuf request object. @@ -1171,13 +1186,17 @@ def sample_import_user_events(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1alpha.types.ImportUserEventsResponse` Response of the ImportUserEventsRequest. If the long running - operation was successful, then this message is - returned by the - google.longrunning.Operations.response field if the - operation was successful. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1alpha.types.ImportUserEventsResponse` + Response of the ImportUserEventsRequest. + If the long running operation was + successful, then this message is + returned by the + google.longrunning.Operations.response + field if the operation was successful. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/user_event_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/user_event_service/transports/rest.py index f23996dff3db..0f48799fe771 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/user_event_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/services/user_event_service/transports/rest.py @@ -700,55 +700,61 @@ def __call__( Returns: ~.httpbody_pb2.HttpBody: - Message that represents an arbitrary HTTP body. It - should only be used for payload formats that can't be - represented as JSON, such as raw binary or an HTML page. - - This message can be used both in streaming and - non-streaming API methods in the request as well as the - response. - - It can be used as a top-level request field, which is - convenient if one wants to extract parameters from - either the URL or HTTP template into the request fields - and also want access to the raw HTTP body. + Message that represents an arbitrary + HTTP body. It should only be used for + payload formats that can't be + represented as JSON, such as raw binary + or an HTML page. + + This message can be used both in + streaming and non-streaming API methods + in the request as well as the response. + + It can be used as a top-level request + field, which is convenient if one wants + to extract parameters from either the + URL or HTTP template into the request + fields and also want access to the raw + HTTP body. Example: - :: - message GetResourceRequest { // A unique request id. string request_id = 1; - // The raw HTTP body is bound to this field. - google.api.HttpBody http_body = 2; + // The raw HTTP body is bound to + this field. google.api.HttpBody + http_body = 2; } service ResourceService { - rpc GetResource(GetResourceRequest) + rpc + GetResource(GetResourceRequest) returns (google.api.HttpBody); - rpc UpdateResource(google.api.HttpBody) - returns (google.protobuf.Empty); + rpc + UpdateResource(google.api.HttpBody) + returns (google.protobuf.Empty); } Example with streaming methods: - :: - service CaldavService { - rpc GetCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); - rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); + rpc GetCalendar(stream + google.api.HttpBody) returns + (stream google.api.HttpBody); rpc + UpdateCalendar(stream + google.api.HttpBody) returns + (stream google.api.HttpBody); } - Use of this type only changes how the request and - response bodies are handled, all other features will - continue to work unchanged. + Use of this type only changes how the + request and response bodies are handled, + all other features will continue to work + unchanged. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/acl_config.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/acl_config.py index fb53291781fc..36485abaa7c3 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/acl_config.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/acl_config.py @@ -34,12 +34,13 @@ class AclConfig(proto.Message): Attributes: name (str): - Immutable. The full resource name of the acl configuration. - Format: + Immutable. The full resource name of the acl + configuration. Format: + ``projects/{project}/locations/{location}/aclConfig``. - This field must be a UTF-8 encoded string with a length - limit of 1024 characters. + This field must be a UTF-8 encoded string with a + length limit of 1024 characters. idp_config (google.cloud.discoveryengine_v1alpha.types.IdpConfig): Identity provider config. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/acl_config_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/acl_config_service.py index d3e01127238c..edfd970d39cd 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/acl_config_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/acl_config_service.py @@ -36,13 +36,15 @@ class GetAclConfigRequest(proto.Message): Attributes: name (str): Required. Resource name of - [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig], + `AclConfig + `__, such as ``projects/*/locations/*/aclConfig``. - If the caller does not have permission to access the - [AclConfig][google.cloud.discoveryengine.v1alpha.AclConfig], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. + If the caller does not have permission to access + the `AclConfig + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. """ name: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/answer.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/answer.py index ae0b7fa763b2..cd29127b3837 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/answer.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/answer.py @@ -478,11 +478,11 @@ class SearchResult(proto.Message): title (str): Title. snippet_info (MutableSequence[google.cloud.discoveryengine_v1alpha.types.Answer.Step.Action.Observation.SearchResult.SnippetInfo]): - If citation_type is DOCUMENT_LEVEL_CITATION, populate - document level snippets. + If citation_type is DOCUMENT_LEVEL_CITATION, + populate document level snippets. chunk_info (MutableSequence[google.cloud.discoveryengine_v1alpha.types.Answer.Step.Action.Observation.SearchResult.ChunkInfo]): - If citation_type is CHUNK_LEVEL_CITATION and chunk mode is - on, populate chunk info. + If citation_type is CHUNK_LEVEL_CITATION and + chunk mode is on, populate chunk info. struct_data (google.protobuf.struct_pb2.Struct): Data representation. The structured JSON data for the document. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/chunk.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/chunk.py index b51af63286be..8cdacc7e8de1 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/chunk.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/chunk.py @@ -37,20 +37,24 @@ class Chunk(proto.Message): Attributes: name (str): - The full resource name of the chunk. Format: + The full resource name of the chunk. + Format: + ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}``. - This field must be a UTF-8 encoded string with a length - limit of 1024 characters. + This field must be a UTF-8 encoded string with a + length limit of 1024 characters. id (str): Unique chunk ID of the current chunk. content (str): Content is a string from a document (parsed content). relevance_score (float): - Output only. Represents the relevance score based on - similarity. Higher score indicates higher chunk relevance. - The score is in range [-1.0, 1.0]. Only populated on + Output only. Represents the relevance score + based on similarity. Higher score indicates + higher chunk relevance. The score is in range + [-1.0, 1.0]. + Only populated on [SearchService.SearchResponse][]. This field is a member of `oneof`_ ``_relevance_score``. @@ -58,8 +62,9 @@ class Chunk(proto.Message): Metadata of the document from the current chunk. derived_struct_data (google.protobuf.struct_pb2.Struct): - Output only. This field is OUTPUT_ONLY. It contains derived - data that are not in the original input document. + Output only. This field is OUTPUT_ONLY. + It contains derived data that are not in the + original input document. page_span (google.cloud.discoveryengine_v1alpha.types.Chunk.PageSpan): Page span of the chunk. chunk_metadata (google.cloud.discoveryengine_v1alpha.types.Chunk.ChunkMetadata): @@ -76,10 +81,11 @@ class DocumentMetadata(proto.Message): title (str): Title of the document. struct_data (google.protobuf.struct_pb2.Struct): - Data representation. The structured JSON data for the - document. It should conform to the registered - [Schema][google.cloud.discoveryengine.v1alpha.Schema] or an - ``INVALID_ARGUMENT`` error is thrown. + Data representation. + The structured JSON data for the document. It + should conform to the registered `Schema + `__ + or an ``INVALID_ARGUMENT`` error is thrown. """ uri: str = proto.Field( @@ -117,23 +123,28 @@ class PageSpan(proto.Message): class ChunkMetadata(proto.Message): r"""Metadata of the current chunk. This field is only populated on - [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search] + `SearchService.Search + `__ API. Attributes: previous_chunks (MutableSequence[google.cloud.discoveryengine_v1alpha.types.Chunk]): - The previous chunks of the current chunk. The number is - controlled by - [SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks]. + The previous chunks of the current chunk. The + number is controlled by + `SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks + `__. This field is only populated on - [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search] + `SearchService.Search + `__ API. next_chunks (MutableSequence[google.cloud.discoveryengine_v1alpha.types.Chunk]): - The next chunks of the current chunk. The number is - controlled by - [SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks]. + The next chunks of the current chunk. The number + is controlled by + `SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks + `__. This field is only populated on - [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search] + `SearchService.Search + `__ API. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/chunk_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/chunk_service.py index f2945939355f..8db00fcb35e2 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/chunk_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/chunk_service.py @@ -33,23 +33,28 @@ class GetChunkRequest(proto.Message): r"""Request message for - [ChunkService.GetChunk][google.cloud.discoveryengine.v1alpha.ChunkService.GetChunk] + `ChunkService.GetChunk + `__ method. Attributes: name (str): Required. Full resource name of - [Chunk][google.cloud.discoveryengine.v1alpha.Chunk], such as + `Chunk + `__, + such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}``. - If the caller does not have permission to access the - [Chunk][google.cloud.discoveryengine.v1alpha.Chunk], + If the caller does not have permission to access + the `Chunk + `__, regardless of whether or not it exists, a ``PERMISSION_DENIED`` error is returned. - If the requested - [Chunk][google.cloud.discoveryengine.v1alpha.Chunk] does not - exist, a ``NOT_FOUND`` error is returned. + If the requested `Chunk + `__ + does not exist, a ``NOT_FOUND`` error is + returned. """ name: str = proto.Field( @@ -60,37 +65,47 @@ class GetChunkRequest(proto.Message): class ListChunksRequest(proto.Message): r"""Request message for - [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks] + `ChunkService.ListChunks + `__ method. Attributes: parent (str): - Required. The parent document resource name, such as + Required. The parent document resource name, + such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}``. If the caller does not have permission to list - [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s under - this document, regardless of whether or not this document - exists, a ``PERMISSION_DENIED`` error is returned. + `Chunk + `__s + under this document, regardless of whether or + not this document exists, a + ``PERMISSION_DENIED`` error is returned. page_size (int): - Maximum number of - [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s to - return. If unspecified, defaults to 100. The maximum allowed - value is 1000. Values above 1000 will be coerced to 1000. - - If this field is negative, an ``INVALID_ARGUMENT`` error is - returned. + Maximum number of `Chunk + `__s + to return. If unspecified, defaults to 100. The + maximum allowed value is 1000. Values above 1000 + will be coerced to 1000. + + If this field is negative, an + ``INVALID_ARGUMENT`` error is returned. page_token (str): A page token - [ListChunksResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListChunksResponse.next_page_token], + `ListChunksResponse.next_page_token + `__, received from a previous - [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks] - call. Provide this to retrieve the subsequent page. - - When paginating, all other parameters provided to - [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks] - must match the call that provided the page token. Otherwise, - an ``INVALID_ARGUMENT`` error is returned. + `ChunkService.ListChunks + `__ + call. Provide this to retrieve the subsequent + page. + + When paginating, all other parameters provided + to `ChunkService.ListChunks + `__ + must match the call that provided the page + token. Otherwise, an ``INVALID_ARGUMENT`` error + is returned. """ parent: str = proto.Field( @@ -109,17 +124,20 @@ class ListChunksRequest(proto.Message): class ListChunksResponse(proto.Message): r"""Response message for - [ChunkService.ListChunks][google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks] + `ChunkService.ListChunks + `__ method. Attributes: chunks (MutableSequence[google.cloud.discoveryengine_v1alpha.types.Chunk]): - The [Chunk][google.cloud.discoveryengine.v1alpha.Chunk]s. + The `Chunk + `__s. next_page_token (str): A token that can be sent as - [ListChunksRequest.page_token][google.cloud.discoveryengine.v1alpha.ListChunksRequest.page_token] - to retrieve the next page. If this field is omitted, there - are no subsequent pages. + `ListChunksRequest.page_token + `__ + to retrieve the next page. If this field is + omitted, there are no subsequent pages. """ @property diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/common.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/common.py index 9419297699e0..b4864d800923 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/common.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/common.py @@ -43,7 +43,7 @@ class IndustryVertical(proto.Enum): r"""The industry vertical associated with the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. + `DataStore `__. Values: INDUSTRY_VERTICAL_UNSPECIFIED (0): @@ -76,10 +76,10 @@ class SolutionType(proto.Enum): Used for use cases related to the Generative AI agent. SOLUTION_TYPE_GENERATIVE_CHAT (4): - Used for use cases related to the Generative Chat agent. - It's used for Generative chat engine only, the associated - data stores must enrolled with ``SOLUTION_TYPE_CHAT`` - solution. + Used for use cases related to the Generative + Chat agent. It's used for Generative chat engine + only, the associated data stores must enrolled + with ``SOLUTION_TYPE_CHAT`` solution. """ SOLUTION_TYPE_UNSPECIFIED = 0 SOLUTION_TYPE_RECOMMENDATION = 1 @@ -89,19 +89,22 @@ class SolutionType(proto.Enum): class SearchUseCase(proto.Enum): - r"""Defines a further subdivision of ``SolutionType``. Specifically - applies to - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH]. + r"""Defines a further subdivision of ``SolutionType``. + Specifically applies to + `SOLUTION_TYPE_SEARCH + `__. Values: SEARCH_USE_CASE_UNSPECIFIED (0): Value used when unset. Will not occur in CSS. SEARCH_USE_CASE_SEARCH (1): - Search use case. Expects the traffic has a non-empty - [query][google.cloud.discoveryengine.v1alpha.SearchRequest.query]. + Search use case. Expects the traffic has a + non-empty `query + `__. SEARCH_USE_CASE_BROWSE (2): - Browse use case. Expects the traffic has an empty - [query][google.cloud.discoveryengine.v1alpha.SearchRequest.query]. + Browse use case. Expects the traffic has an + empty `query + `__. """ SEARCH_USE_CASE_UNSPECIFIED = 0 SEARCH_USE_CASE_SEARCH = 1 @@ -214,32 +217,39 @@ class Interval(proto.Message): class CustomAttribute(proto.Message): r"""A custom attribute that is not explicitly modeled in a resource, - e.g. [UserEvent][google.cloud.discoveryengine.v1alpha.UserEvent]. + e.g. `UserEvent + `__. Attributes: text (MutableSequence[str]): - The textual values of this custom attribute. For example, - ``["yellow", "green"]`` when the key is "color". + The textual values of this custom attribute. For + example, ``["yellow", "green"]`` when the key is + "color". Empty string is not allowed. Otherwise, an ``INVALID_ARGUMENT`` error is returned. Exactly one of - [CustomAttribute.text][google.cloud.discoveryengine.v1alpha.CustomAttribute.text] + `CustomAttribute.text + `__ or - [CustomAttribute.numbers][google.cloud.discoveryengine.v1alpha.CustomAttribute.numbers] - should be set. Otherwise, an ``INVALID_ARGUMENT`` error is - returned. + `CustomAttribute.numbers + `__ + should be set. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. numbers (MutableSequence[float]): - The numerical values of this custom attribute. For example, - ``[2.3, 15.4]`` when the key is "lengths_cm". + The numerical values of this custom attribute. + For example, ``[2.3, 15.4]`` when the key is + "lengths_cm". Exactly one of - [CustomAttribute.text][google.cloud.discoveryengine.v1alpha.CustomAttribute.text] + `CustomAttribute.text + `__ or - [CustomAttribute.numbers][google.cloud.discoveryengine.v1alpha.CustomAttribute.numbers] - should be set. Otherwise, an ``INVALID_ARGUMENT`` error is - returned. + `CustomAttribute.numbers + `__ + should be set. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. """ text: MutableSequence[str] = proto.RepeatedField( @@ -257,31 +267,35 @@ class UserInfo(proto.Message): Attributes: user_id (str): - Highly recommended for logged-in users. Unique identifier - for logged-in user, such as a user name. Don't set for - anonymous users. + Highly recommended for logged-in users. Unique + identifier for logged-in user, such as a user + name. Don't set for anonymous users. Always use a hashed value for this ID. - Don't set the field to the same fixed ID for different - users. This mixes the event history of those users together, - which results in degraded model quality. + Don't set the field to the same fixed ID for + different users. This mixes the event history of + those users together, which results in degraded + model quality. - The field must be a UTF-8 encoded string with a length limit - of 128 characters. Otherwise, an ``INVALID_ARGUMENT`` error - is returned. + The field must be a UTF-8 encoded string with a + length limit of 128 characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. user_agent (str): User agent as included in the HTTP header. - The field must be a UTF-8 encoded string with a length limit - of 1,000 characters. Otherwise, an ``INVALID_ARGUMENT`` - error is returned. + The field must be a UTF-8 encoded string with a + length limit of 1,000 characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. - This should not be set when using the client side event - reporting with GTM or JavaScript tag in - [UserEventService.CollectUserEvent][google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent] + This should not be set when using the client + side event reporting with GTM or JavaScript tag + in + `UserEventService.CollectUserEvent + `__ or if - [UserEvent.direct_user_request][google.cloud.discoveryengine.v1alpha.UserEvent.direct_user_request] + `UserEvent.direct_user_request + `__ is set. """ @@ -336,9 +350,10 @@ class GuidedSearchSpec(proto.Message): Whether or not to enable and include related questions in search response. max_related_questions (int): - Max number of related questions to be returned. The valid - range is [1, 5]. If enable_related_questions is true, the - default value is 3. + Max number of related questions to be returned. + The valid range is [1, 5]. If + enable_related_questions is true, the default + value is 3. """ enable_refinement_attributes: bool = proto.Field( @@ -400,7 +415,8 @@ class ExternalIdpConfig(proto.Message): Attributes: workforce_pool_name (str): - Workforce pool name. Example: + Workforce pool name. + Example: "locations/global/workforcePools/pool_id". """ @@ -433,18 +449,21 @@ class Principal(proto.Message): Attributes: user_id (str): - User identifier. For Google Workspace user account, user_id - should be the google workspace user email. For non-google - identity provider user account, user_id is the mapped user - identifier configured during the workforcepool config. + User identifier. + For Google Workspace user account, user_id + should be the google workspace user email. + For non-google identity provider user account, + user_id is the mapped user identifier configured + during the workforcepool config. This field is a member of `oneof`_ ``principal``. group_id (str): - Group identifier. For Google Workspace user account, - group_id should be the google workspace group email. For - non-google identity provider user account, group_id is the - mapped group identifier configured during the workforcepool - config. + Group identifier. + For Google Workspace user account, group_id + should be the google workspace group email. + For non-google identity provider user account, + group_id is the mapped group identifier + configured during the workforcepool config. This field is a member of `oneof`_ ``principal``. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/completion.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/completion.py index db1f8d363f04..2db59e2bc98c 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/completion.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/completion.py @@ -49,10 +49,11 @@ class MatchOperator(proto.Enum): MATCH_OPERATOR_UNSPECIFIED (0): Default value. Should not be used EXACT_MATCH (1): - If the suggestion is an exact match to the block_phrase, - then block it. + If the suggestion is an exact match to the + block_phrase, then block it. CONTAINS (2): - If the suggestion contains the block_phrase, then block it. + If the suggestion contains the block_phrase, + then block it. """ MATCH_OPERATOR_UNSPECIFIED = 0 EXACT_MATCH = 1 diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/completion_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/completion_service.py index 25ce134fadff..3cb8ae3490a1 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/completion_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/completion_service.py @@ -30,58 +30,65 @@ class CompleteQueryRequest(proto.Message): r"""Request message for - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery] + `CompletionService.CompleteQuery + `__ method. Attributes: data_store (str): - Required. The parent data store resource name for which the - completion is performed, such as + Required. The parent data store resource name + for which the completion is performed, such as ``projects/*/locations/global/collections/default_collection/dataStores/default_data_store``. query (str): Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. query_model (str): - Specifies the autocomplete data model. This overrides any - model specified in the Configuration > Autocomplete section - of the Cloud console. Currently supported values: - - - ``document`` - Using suggestions generated from - user-imported documents. - - ``search-history`` - Using suggestions generated from the - past history of - [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search] - API calls. Do not use it when there is no traffic for - Search API. - - ``user-event`` - Using suggestions generated from - user-imported search events. - - ``document-completable`` - Using suggestions taken - directly from user-imported document fields marked as - completable. + Specifies the autocomplete data model. This + overrides any model specified in the + Configuration > Autocomplete section of the + Cloud console. Currently supported values: + + * ``document`` - Using suggestions generated + from user-imported documents. * + ``search-history`` - Using suggestions generated + from the past history of `SearchService.Search + `__ + API calls. Do not use it when there is no + traffic for Search API. + + * ``user-event`` - Using suggestions generated + from user-imported search events. + + * ``document-completable`` - Using suggestions + taken directly from user-imported document + fields marked as completable. Default values: - - ``document`` is the default model for regular dataStores. - - ``search-history`` is the default model for site search - dataStores. + * ``document`` is the default model for regular + dataStores. * ``search-history`` is the default + model for site search dataStores. user_pseudo_id (str): - A unique identifier for tracking visitors. For example, this - could be implemented with an HTTP cookie, which should be - able to uniquely identify a visitor on a single device. This - unique identifier should not change if the visitor logs in - or out of the website. + A unique identifier for tracking visitors. For + example, this could be implemented with an HTTP + cookie, which should be able to uniquely + identify a visitor on a single device. This + unique identifier should not change if the + visitor logs in or out of the website. This field should NOT have a fixed value such as ``unknown_visitor``. This should be the same identifier as - [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1alpha.UserEvent.user_pseudo_id] + `UserEvent.user_pseudo_id + `__ and - [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1alpha.SearchRequest.user_pseudo_id]. + `SearchRequest.user_pseudo_id + `__. - The field must be a UTF-8 encoded string with a length limit - of 128 characters. Otherwise, an ``INVALID_ARGUMENT`` error - is returned. + The field must be a UTF-8 encoded string with a + length limit of 128 characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. include_tail_suggestions (bool): Indicates if tail suggestions should be returned if there are no suggestions that match @@ -115,7 +122,8 @@ class CompleteQueryRequest(proto.Message): class CompleteQueryResponse(proto.Message): r"""Response message for - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery] + `CompletionService.CompleteQuery + `__ method. Attributes: @@ -124,11 +132,12 @@ class CompleteQueryResponse(proto.Message): result list is ordered and the first result is a top suggestion. tail_match_triggered (bool): - True if the returned suggestions are all tail suggestions. - - For tail matching to be triggered, include_tail_suggestions - in the request must be true and there must be no suggestions - that match the full query. + True if the returned suggestions are all tail + suggestions. + For tail matching to be triggered, + include_tail_suggestions in the request must be + true and there must be no suggestions that match + the full query. """ class QuerySuggestion(proto.Message): diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/control.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/control.py index 00d7e933146b..2d83fe102ad4 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/control.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/control.py @@ -54,9 +54,10 @@ class QueryTerm(proto.Message): value (str): The specific query value to match against - Must be lowercase, must be UTF-8. Can have at most 3 space - separated terms if full_match is true. Cannot be an empty - string. Maximum length of 5000 characters. + Must be lowercase, must be UTF-8. + Can have at most 3 space separated terms if + full_match is true. Cannot be an empty string. + Maximum length of 5000 characters. full_match (bool): Whether the search query needs to exactly match the query term. @@ -110,10 +111,11 @@ class TimeRange(proto.Message): class Control(proto.Message): - r"""Defines a conditioned behavior to employ during serving. Must be - attached to a - [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig] - to be considered at serving time. Permitted actions dependent on + r"""Defines a conditioned behavior to employ during serving. + Must be attached to a + `ServingConfig + `__ to be + considered at serving time. Permitted actions dependent on ``SolutionType``. This message has `oneof`_ fields (mutually exclusive fields). @@ -153,21 +155,25 @@ class Control(proto.Message): error is thrown. associated_serving_config_ids (MutableSequence[str]): Output only. List of all - [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig] - IDs this control is attached to. May take up to 10 minutes - to update after changes. + `ServingConfig + `__ + IDs this control is attached to. May take up to + 10 minutes to update after changes. solution_type (google.cloud.discoveryengine_v1alpha.types.SolutionType): Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. use_cases (MutableSequence[google.cloud.discoveryengine_v1alpha.types.SearchUseCase]): - Specifies the use case for the control. Affects what - condition fields can be set. Only applies to - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH]. - Currently only allow one use case per control. Must be set - when solution_type is - [SolutionType.SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH]. + Specifies the use case for the control. + Affects what condition fields can be set. + Only applies to + `SOLUTION_TYPE_SEARCH + `__. + Currently only allow one use case per control. + Must be set when solution_type is + `SolutionType.SOLUTION_TYPE_SEARCH + `__. conditions (MutableSequence[google.cloud.discoveryengine_v1alpha.types.Condition]): Determines when the associated action will trigger. @@ -182,8 +188,9 @@ class BoostAction(proto.Message): Attributes: boost (float): - Required. Strength of the boost, which should be in [-1, 1]. - Negative boost means demotion. Default is 0.0 (No-op). + Required. Strength of the boost, which should be + in [-1, 1]. Negative boost means demotion. + Default is 0.0 (No-op). filter (str): Required. Specifies which products to apply the boost to. @@ -194,8 +201,9 @@ class BoostAction(proto.Message): Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. data_store (str): - Required. Specifies which data store's documents can be - boosted by this control. Full data store name e.g. + Required. Specifies which data store's documents + can be boosted by this control. Full data store + name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store """ @@ -227,8 +235,9 @@ class FilterAction(proto.Message): Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. data_store (str): - Required. Specifies which data store's documents can be - filtered by this control. Full data store name e.g. + Required. Specifies which data store's documents + can be filtered by this control. Full data store + name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/control_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/control_service.py index bf70951accd8..e4bcbc6c3550 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/control_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/control_service.py @@ -40,18 +40,20 @@ class CreateControlRequest(proto.Message): Attributes: parent (str): - Required. Full resource name of parent data store. Format: + Required. Full resource name of parent data + store. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`` or ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}``. control (google.cloud.discoveryengine_v1alpha.types.Control): Required. The Control to create. control_id (str): - Required. The ID to use for the Control, which will become - the final component of the Control's resource name. + Required. The ID to use for the Control, which + will become the final component of the Control's + resource name. - This value must be within 1-63 characters. Valid characters - are /[a-z][0-9]-\_/. + This value must be within 1-63 characters. + Valid characters are /`a-z <0-9>`__-_/. """ parent: str = proto.Field( @@ -77,13 +79,17 @@ class UpdateControlRequest(proto.Message): Required. The Control to update. update_mask (google.protobuf.field_mask_pb2.FieldMask): Optional. Indicates which fields in the provided - [Control][google.cloud.discoveryengine.v1alpha.Control] to - update. The following are NOT supported: + `Control + `__ + to update. The following are NOT supported: - - [Control.name][google.cloud.discoveryengine.v1alpha.Control.name] - - [Control.solution_type][google.cloud.discoveryengine.v1alpha.Control.solution_type] + * `Control.name + `__ + * `Control.solution_type + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported fields are + updated. """ control: gcd_control.Control = proto.Field( @@ -103,8 +109,8 @@ class DeleteControlRequest(proto.Message): Attributes: name (str): - Required. The resource name of the Control to delete. - Format: + Required. The resource name of the Control to + delete. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`` """ @@ -119,7 +125,8 @@ class GetControlRequest(proto.Message): Attributes: name (str): - Required. The resource name of the Control to get. Format: + Required. The resource name of the Control to + get. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`` """ @@ -144,15 +151,15 @@ class ListControlsRequest(proto.Message): allowed value is 1000. page_token (str): Optional. A page token, received from a previous - ``ListControls`` call. Provide this to retrieve the - subsequent page. + ``ListControls`` call. Provide this to retrieve + the subsequent page. filter (str): - Optional. A filter to apply on the list results. Supported - features: - - - List all the products under the parent branch if - [filter][google.cloud.discoveryengine.v1alpha.ListControlsRequest.filter] - is unset. Currently this field is unsupported. + Optional. A filter to apply on the list results. + Supported features: + * List all the products under the parent branch + if `filter + `__ + is unset. Currently this field is unsupported. """ parent: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/conversation.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/conversation.py index 363e242f7a1c..d797f3a25d0d 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/conversation.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/conversation.py @@ -107,7 +107,8 @@ class Reply(proto.Message): Attributes: reply (str): - DEPRECATED: use ``summary`` instead. Text reply. + DEPRECATED: use ``summary`` instead. + Text reply. references (MutableSequence[google.cloud.discoveryengine_v1alpha.types.Reply.Reference]): References in the reply. summary (google.cloud.discoveryengine_v1alpha.types.SearchResponse.Summary): diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/conversational_search_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/conversational_search_service.py index 03248e2fd0d7..d8b3f8da9257 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/conversational_search_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/conversational_search_service.py @@ -52,24 +52,28 @@ class ConverseConversationRequest(proto.Message): r"""Request message for - [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.ConverseConversation] + `ConversationalSearchService.ConverseConversation + `__ method. Attributes: name (str): - Required. The resource name of the Conversation to get. - Format: + Required. The resource name of the Conversation + to get. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}``. Use ``projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-`` - to activate auto session mode, which automatically creates a - new conversation inside a ConverseConversation session. + to activate auto session mode, which + automatically creates a new conversation inside + a ConverseConversation session. query (google.cloud.discoveryengine_v1alpha.types.TextInput): Required. Current user input. serving_config (str): - The resource name of the Serving Config to use. Format: + The resource name of the Serving Config to use. + Format: ``projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`` - If this is not set, the default serving config will be used. + If this is not set, the default serving config + will be used. conversation (google.cloud.discoveryengine_v1alpha.types.Conversation): The conversation to be used by auto session only. The name field will be ignored as we @@ -78,55 +82,66 @@ class ConverseConversationRequest(proto.Message): safe_search (bool): Whether to turn on safe search. user_labels (MutableMapping[str, str]): - The user labels applied to a resource must meet the - following requirements: - - - Each resource can have multiple labels, up to a maximum of - 64. - - Each label must be a key-value pair. - - Keys have a minimum length of 1 character and a maximum - length of 63 characters and cannot be empty. Values can be - empty and have a maximum length of 63 characters. - - Keys and values can contain only lowercase letters, - numeric characters, underscores, and dashes. All - characters must use UTF-8 encoding, and international - characters are allowed. - - The key portion of a label must be unique. However, you - can use the same key with multiple resources. - - Keys must start with a lowercase letter or international - character. + The user labels applied to a resource must meet + the following requirements: + * Each resource can have multiple labels, up to + a maximum of 64. + + * Each label must be a key-value pair. + * Keys have a minimum length of 1 character and + a maximum length of 63 characters and cannot + be empty. Values can be empty and have a maximum + length of 63 characters. + + * Keys and values can contain only lowercase + letters, numeric characters, underscores, and + dashes. All characters must use UTF-8 encoding, + and international characters are allowed. + + * The key portion of a label must be unique. + However, you can use the same key with + multiple resources. + + * Keys must start with a lowercase letter or + international character. See `Google Cloud - Document `__ + Document + `__ for more details. summary_spec (google.cloud.discoveryengine_v1alpha.types.SearchRequest.ContentSearchSpec.SummarySpec): A specification for configuring the summary returned in the response. filter (str): - The filter syntax consists of an expression language for - constructing a predicate from one or more fields of the - documents being filtered. Filter expression is - case-sensitive. This will be used to filter search results - which may affect the summary response. - - If this field is unrecognizable, an ``INVALID_ARGUMENT`` is - returned. - - Filtering in Vertex AI Search is done by mapping the LHS - filter key to a key property defined in the Vertex AI Search - backend -- this mapping is defined by the customer in their - schema. For example a media customer might have a field - 'name' in their schema. In this case the filter would look - like this: filter --> name:'ANY("king kong")' - - For more information about filtering including syntax and - filter operators, see - `Filter `__ + The filter syntax consists of an expression + language for constructing a predicate from one + or more fields of the documents being filtered. + Filter expression is case-sensitive. This will + be used to filter search results which may + affect the summary response. + + If this field is unrecognizable, an + ``INVALID_ARGUMENT`` is returned. + + Filtering in Vertex AI Search is done by mapping + the LHS filter key to a key property defined in + the Vertex AI Search backend -- this mapping is + defined by the customer in their schema. For + example a media customer might have a field + 'name' in their schema. In this case the filter + would look like this: filter --> name:'ANY("king + kong")' + + For more information about filtering including + syntax and filter operators, see + `Filter + `__ boost_spec (google.cloud.discoveryengine_v1alpha.types.SearchRequest.BoostSpec): - Boost specification to boost certain documents in search - results which may affect the converse response. For more - information on boosting, see - `Boosting `__ + Boost specification to boost certain documents + in search results which may affect the converse + response. For more information on boosting, see + `Boosting + `__ """ name: str = proto.Field( @@ -176,7 +191,8 @@ class ConverseConversationRequest(proto.Message): class ConverseConversationResponse(proto.Message): r"""Response message for - [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.ConverseConversation] + `ConversationalSearchService.ConverseConversation + `__ method. Attributes: @@ -218,7 +234,8 @@ class CreateConversationRequest(proto.Message): Attributes: parent (str): - Required. Full resource name of parent data store. Format: + Required. Full resource name of parent data + store. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`` conversation (google.cloud.discoveryengine_v1alpha.types.Conversation): Required. The conversation to create. @@ -243,12 +260,15 @@ class UpdateConversationRequest(proto.Message): Required. The Conversation to update. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] + `Conversation + `__ to update. The following are NOT supported: - - [Conversation.name][google.cloud.discoveryengine.v1alpha.Conversation.name] + * `Conversation.name + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported fields are + updated. """ conversation: gcd_conversation.Conversation = proto.Field( @@ -268,8 +288,8 @@ class DeleteConversationRequest(proto.Message): Attributes: name (str): - Required. The resource name of the Conversation to delete. - Format: + Required. The resource name of the Conversation + to delete. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`` """ @@ -284,8 +304,8 @@ class GetConversationRequest(proto.Message): Attributes: name (str): - Required. The resource name of the Conversation to get. - Format: + Required. The resource name of the Conversation + to get. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`` """ @@ -307,23 +327,30 @@ class ListConversationsRequest(proto.Message): unspecified, defaults to 50. Max allowed value is 1000. page_token (str): - A page token, received from a previous ``ListConversations`` - call. Provide this to retrieve the subsequent page. + A page token, received from a previous + ``ListConversations`` call. Provide this to + retrieve the subsequent page. filter (str): - A filter to apply on the list results. The supported - features are: user_pseudo_id, state. + A filter to apply on the list results. The + supported features are: user_pseudo_id, state. + + Example: - Example: "user_pseudo_id = some_id". + "user_pseudo_id = some_id". order_by (str): - A comma-separated list of fields to order by, sorted in - ascending order. Use "desc" after a field name for - descending. Supported fields: + A comma-separated list of fields to order by, + sorted in ascending order. Use "desc" after a + field name for descending. Supported fields: + + * ``update_time`` + * ``create_time`` - - ``update_time`` - - ``create_time`` - - ``conversation_name`` + * ``conversation_name`` - Example: "update_time desc" "create_time". + Example: + + "update_time desc" + "create_time". """ parent: str = proto.Field( @@ -376,29 +403,31 @@ def raw_page(self): class AnswerQueryRequest(proto.Message): r"""Request message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.AnswerQuery] + `ConversationalSearchService.AnswerQuery + `__ method. Attributes: serving_config (str): - Required. The resource name of the Search serving config, - such as + Required. The resource name of the Search + serving config, such as ``projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config``, or ``projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config``. - This field is used to identify the serving configuration - name, set of models used to make the search. + This field is used to identify the serving + configuration name, set of models used to make + the search. query (google.cloud.discoveryengine_v1alpha.types.Query): Required. Current user query. session (str): The session resource name. Not required. - When session field is not set, the API is in sessionless - mode. + When session field is not set, the API is in + sessionless mode. - We support auto session mode: users can use the wildcard - symbol ``-`` as session ID. A new ID will be automatically - generated and assigned. + We support auto session mode: users can use the + wildcard symbol ``-`` as session ID. A new ID + will be automatically generated and assigned. safety_spec (google.cloud.discoveryengine_v1alpha.types.AnswerQueryRequest.SafetySpec): Model specification. related_questions_spec (google.cloud.discoveryengine_v1alpha.types.AnswerQueryRequest.RelatedQuestionsSpec): @@ -413,47 +442,56 @@ class AnswerQueryRequest(proto.Message): Asynchronous mode control. If enabled, the response will be returned with - answer/session resource name without final answer. The API - users need to do the polling to get the latest status of - answer/session by calling - [ConversationalSearchService.GetAnswer][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.GetAnswer] + answer/session resource name without final + answer. The API users need to do the polling to + get the latest status of answer/session by + calling `ConversationalSearchService.GetAnswer + `__ or - [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.GetSession] + `ConversationalSearchService.GetSession + `__ method. user_pseudo_id (str): - A unique identifier for tracking visitors. For example, this - could be implemented with an HTTP cookie, which should be - able to uniquely identify a visitor on a single device. This - unique identifier should not change if the visitor logs in - or out of the website. + A unique identifier for tracking visitors. For + example, this could be implemented with an HTTP + cookie, which should be able to uniquely + identify a visitor on a single device. This + unique identifier should not change if the + visitor logs in or out of the website. This field should NOT have a fixed value such as ``unknown_visitor``. - The field must be a UTF-8 encoded string with a length limit - of 128 characters. Otherwise, an ``INVALID_ARGUMENT`` error - is returned. + The field must be a UTF-8 encoded string with a + length limit of 128 characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. user_labels (MutableMapping[str, str]): - The user labels applied to a resource must meet the - following requirements: - - - Each resource can have multiple labels, up to a maximum of - 64. - - Each label must be a key-value pair. - - Keys have a minimum length of 1 character and a maximum - length of 63 characters and cannot be empty. Values can be - empty and have a maximum length of 63 characters. - - Keys and values can contain only lowercase letters, - numeric characters, underscores, and dashes. All - characters must use UTF-8 encoding, and international - characters are allowed. - - The key portion of a label must be unique. However, you - can use the same key with multiple resources. - - Keys must start with a lowercase letter or international - character. + The user labels applied to a resource must meet + the following requirements: + * Each resource can have multiple labels, up to + a maximum of 64. + + * Each label must be a key-value pair. + * Keys have a minimum length of 1 character and + a maximum length of 63 characters and cannot + be empty. Values can be empty and have a maximum + length of 63 characters. + + * Keys and values can contain only lowercase + letters, numeric characters, underscores, and + dashes. All characters must use UTF-8 encoding, + and international characters are allowed. + + * The key portion of a label must be unique. + However, you can use the same key with + multiple resources. + + * Keys must start with a lowercase letter or + international character. See `Google Cloud - Document `__ + Document + `__ for more details. """ @@ -495,42 +533,47 @@ class AnswerGenerationSpec(proto.Message): prompt_spec (google.cloud.discoveryengine_v1alpha.types.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec): Answer generation prompt specification. include_citations (bool): - Specifies whether to include citation metadata in the - answer. The default value is ``false``. + Specifies whether to include citation metadata + in the answer. The default value is ``false``. answer_language_code (str): - Language code for Answer. Use language tags defined by - `BCP47 `__. + Language code for Answer. Use language tags + defined by `BCP47 + `__. Note: This is an experimental feature. ignore_adversarial_query (bool): - Specifies whether to filter out adversarial queries. The - default value is ``false``. - - Google employs search-query classification to detect - adversarial queries. No answer is returned if the search - query is classified as an adversarial query. For example, a - user might ask a question regarding negative comments about - the company or submit a query designed to generate unsafe, - policy-violating output. If this field is set to ``true``, - we skip generating answers for adversarial queries and - return fallback messages instead. + Specifies whether to filter out adversarial + queries. The default value is ``false``. + + Google employs search-query classification to + detect adversarial queries. No answer is + returned if the search query is classified as an + adversarial query. For example, a user might ask + a question regarding negative comments about the + company or submit a query designed to generate + unsafe, policy-violating output. If this field + is set to ``true``, we skip generating answers + for adversarial queries and return fallback + messages instead. ignore_non_answer_seeking_query (bool): - Specifies whether to filter out queries that are not - answer-seeking. The default value is ``false``. - - Google employs search-query classification to detect - answer-seeking queries. No answer is returned if the search - query is classified as a non-answer seeking query. If this - field is set to ``true``, we skip generating answers for - non-answer seeking queries and return fallback messages - instead. + Specifies whether to filter out queries that are + not answer-seeking. The default value is + ``false``. + + Google employs search-query classification to + detect answer-seeking queries. No answer is + returned if the search query is classified as a + non-answer seeking query. If this field is set + to ``true``, we skip generating answers for + non-answer seeking queries and return fallback + messages instead. ignore_low_relevant_content (bool): - Specifies whether to filter out queries that have low - relevance. - - If this field is set to ``false``, all search results are - used regardless of relevance to generate answers. If set to - ``true`` or unset, the behavior will be determined - automatically by the service. + Specifies whether to filter out queries that + have low relevance. + If this field is set to ``false``, all search + results are used regardless of relevance to + generate answers. If set to ``true`` or unset, + the behavior will be determined automatically by + the service. This field is a member of `oneof`_ ``_ignore_low_relevant_content``. """ @@ -624,45 +667,53 @@ class SearchParams(proto.Message): Number of search results to return. The default value is 10. filter (str): - The filter syntax consists of an expression language for - constructing a predicate from one or more fields of the - documents being filtered. Filter expression is - case-sensitive. This will be used to filter search results - which may affect the Answer response. - - If this field is unrecognizable, an ``INVALID_ARGUMENT`` is - returned. - - Filtering in Vertex AI Search is done by mapping the LHS - filter key to a key property defined in the Vertex AI Search - backend -- this mapping is defined by the customer in their - schema. For example a media customers might have a field - 'name' in their schema. In this case the filter would look - like this: filter --> name:'ANY("king kong")' - - For more information about filtering including syntax and - filter operators, see - `Filter `__ + The filter syntax consists of an expression + language for constructing a predicate from one + or more fields of the documents being filtered. + Filter expression is case-sensitive. This will + be used to filter search results which may + affect the Answer response. + + If this field is unrecognizable, an + ``INVALID_ARGUMENT`` is returned. + + Filtering in Vertex AI Search is done by mapping + the LHS filter key to a key property defined in + the Vertex AI Search backend -- this mapping is + defined by the customer in their schema. For + example a media customers might have a field + 'name' in their schema. In this case the filter + would look like this: filter --> name:'ANY("king + kong")' + + For more information about filtering including + syntax and filter operators, see + `Filter + `__ boost_spec (google.cloud.discoveryengine_v1alpha.types.SearchRequest.BoostSpec): - Boost specification to boost certain documents in search - results which may affect the answer query response. For more - information on boosting, see - `Boosting `__ + Boost specification to boost certain documents + in search results which may affect the answer + query response. For more information on + boosting, see `Boosting + `__ order_by (str): - The order in which documents are returned. Documents can be - ordered by a field in an - [Document][google.cloud.discoveryengine.v1alpha.Document] - object. Leave it unset if ordered by relevance. ``order_by`` - expression is case-sensitive. For more information on - ordering, see - `Ordering `__ - - If this field is unrecognizable, an ``INVALID_ARGUMENT`` is - returned. + The order in which documents are returned. + Documents can be ordered by a field in an + `Document + `__ + object. Leave it unset if ordered by relevance. + ``order_by`` expression is case-sensitive. For + more information on ordering, see `Ordering + `__ + + If this field is unrecognizable, an + ``INVALID_ARGUMENT`` is returned. search_result_mode (google.cloud.discoveryengine_v1alpha.types.SearchRequest.ContentSearchSpec.SearchResultMode): - Specifies the search result mode. If unspecified, the search - result mode defaults to ``DOCUMENTS``. See `parse and chunk - documents `__ + Specifies the search result mode. If + unspecified, the search result mode defaults to + ``DOCUMENTS``. See `parse and chunk + documents + `__ custom_fine_tuning_spec (google.cloud.discoveryengine_v1alpha.types.CustomFineTuningSpec): Custom fine tuning configs. data_store_specs (MutableSequence[google.cloud.discoveryengine_v1alpha.types.SearchRequest.DataStoreSpec]): @@ -777,7 +828,8 @@ class DocumentContext(proto.Message): class ExtractiveSegment(proto.Message): r"""Extractive segment. - `Guide `__ + `Guide + `__ Attributes: page_identifier (str): @@ -797,7 +849,8 @@ class ExtractiveSegment(proto.Message): class ExtractiveAnswer(proto.Message): r"""Extractive answer. - `Guide `__ + `Guide + `__ Attributes: page_identifier (str): @@ -1036,22 +1089,28 @@ class QueryRephraserSpec(proto.Message): class AnswerQueryResponse(proto.Message): r"""Response message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.AnswerQuery] + `ConversationalSearchService.AnswerQuery + `__ method. Attributes: answer (google.cloud.discoveryengine_v1alpha.types.Answer): - Answer resource object. If - [AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps][google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps] + Answer resource object. + If + `AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps + `__ is greater than 1, use - [Answer.name][google.cloud.discoveryengine.v1alpha.Answer.name] + `Answer.name + `__ to fetch answer information using - [ConversationalSearchService.GetAnswer][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.GetAnswer] + `ConversationalSearchService.GetAnswer + `__ API. session (google.cloud.discoveryengine_v1alpha.types.Session): - Session resource object. It will be only available when - session field is set and valid in the - [AnswerQueryRequest][google.cloud.discoveryengine.v1alpha.AnswerQueryRequest] + Session resource object. + It will be only available when session field is + set and valid in the `AnswerQueryRequest + `__ request. answer_query_token (str): A global unique ID used for logging. @@ -1078,7 +1137,8 @@ class GetAnswerRequest(proto.Message): Attributes: name (str): - Required. The resource name of the Answer to get. Format: + Required. The resource name of the Answer to + get. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`` """ @@ -1093,7 +1153,8 @@ class CreateSessionRequest(proto.Message): Attributes: parent (str): - Required. Full resource name of parent data store. Format: + Required. Full resource name of parent data + store. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` session (google.cloud.discoveryengine_v1alpha.types.Session): Required. The session to create. @@ -1118,12 +1179,15 @@ class UpdateSessionRequest(proto.Message): Required. The Session to update. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [Session][google.cloud.discoveryengine.v1alpha.Session] to - update. The following are NOT supported: + `Session + `__ + to update. The following are NOT supported: - - [Session.name][google.cloud.discoveryengine.v1alpha.Session.name] + * `Session.name + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported fields are + updated. """ session: gcd_session.Session = proto.Field( @@ -1143,8 +1207,8 @@ class DeleteSessionRequest(proto.Message): Attributes: name (str): - Required. The resource name of the Session to delete. - Format: + Required. The resource name of the Session to + delete. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` """ @@ -1159,7 +1223,8 @@ class GetSessionRequest(proto.Message): Attributes: name (str): - Required. The resource name of the Session to get. Format: + Required. The resource name of the Session to + get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` include_answer_details (bool): Optional. If set to true, the full session @@ -1188,40 +1253,51 @@ class ListSessionsRequest(proto.Message): unspecified, defaults to 50. Max allowed value is 1000. page_token (str): - A page token, received from a previous ``ListSessions`` - call. Provide this to retrieve the subsequent page. + A page token, received from a previous + ``ListSessions`` call. Provide this to retrieve + the subsequent page. filter (str): - A comma-separated list of fields to filter by, in EBNF - grammar. The supported fields are: - - - ``user_pseudo_id`` - - ``state`` - - ``display_name`` - - ``starred`` - - ``is_pinned`` - - ``labels`` - - ``create_time`` - - ``update_time`` - - Examples: "user_pseudo_id = some_id" "display_name = - "some_name"" "starred = true" "is_pinned=true AND (NOT - labels:hidden)" "create_time > "1970-01-01T12:00:00Z"". + A comma-separated list of fields to filter by, + in EBNF grammar. The supported fields are: + + * ``user_pseudo_id`` + * ``state`` + + * ``display_name`` + * ``starred`` + + * ``is_pinned`` + * ``labels`` + + * ``create_time`` + * ``update_time`` + + Examples: + + "user_pseudo_id = some_id" + "display_name = \"some_name\"" + "starred = true" + "is_pinned=true AND (NOT labels:hidden)" + "create_time > \"1970-01-01T12:00:00Z\"". order_by (str): - A comma-separated list of fields to order by, sorted in - ascending order. Use "desc" after a field name for - descending. Supported fields: + A comma-separated list of fields to order by, + sorted in ascending order. Use "desc" after a + field name for descending. Supported fields: + + * ``update_time`` + * ``create_time`` - - ``update_time`` - - ``create_time`` - - ``session_name`` - - ``is_pinned`` + * ``session_name`` + * ``is_pinned`` Example: - - "update_time desc" - - "create_time" - - "is_pinned desc,update_time desc": list sessions by - is_pinned first, then by update_time. + * "update_time desc" + * "create_time" + + * "is_pinned desc,update_time desc": list + sessions by is_pinned first, then by + update_time. """ parent: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/custom_tuning_model.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/custom_tuning_model.py index dd6c72e94ddf..53fa1b008b57 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/custom_tuning_model.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/custom_tuning_model.py @@ -33,19 +33,20 @@ class CustomTuningModel(proto.Message): Attributes: name (str): - Required. The fully qualified resource name of the model. - + Required. The fully qualified resource name of + the model. Format: + ``projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`` - model must be an alpha-numerical string with limit of 40 - characters. + model must be an alpha-numerical string with + limit of 40 characters. display_name (str): The display name of the model. model_version (int): The version of the model. model_state (google.cloud.discoveryengine_v1alpha.types.CustomTuningModel.ModelState): - The state that the model is in (e.g.\ ``TRAINING`` or - ``TRAINING_FAILED``). + The state that the model is in (e.g.``TRAINING`` + or ``TRAINING_FAILED``). create_time (google.protobuf.timestamp_pb2.Timestamp): Timestamp the Model was created at. training_start_time (google.protobuf.timestamp_pb2.Timestamp): diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/data_store.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/data_store.py index 39a172f176e2..34f21d6e15ec 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/data_store.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/data_store.py @@ -42,40 +42,45 @@ class DataStore(proto.Message): Attributes: name (str): - Immutable. The full resource name of the data store. Format: + Immutable. The full resource name of the data + store. Format: + ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. - This field must be a UTF-8 encoded string with a length - limit of 1024 characters. + This field must be a UTF-8 encoded string with a + length limit of 1024 characters. display_name (str): Required. The data store display name. - This field must be a UTF-8 encoded string with a length - limit of 128 characters. Otherwise, an INVALID_ARGUMENT - error is returned. + This field must be a UTF-8 encoded string with a + length limit of 128 characters. Otherwise, an + INVALID_ARGUMENT error is returned. industry_vertical (google.cloud.discoveryengine_v1alpha.types.IndustryVertical): Immutable. The industry vertical that the data store registers. solution_types (MutableSequence[google.cloud.discoveryengine_v1alpha.types.SolutionType]): - The solutions that the data store enrolls. Available - solutions for each - [industry_vertical][google.cloud.discoveryengine.v1alpha.DataStore.industry_vertical]: + The solutions that the data store enrolls. + Available solutions for each `industry_vertical + `__: - - ``MEDIA``: ``SOLUTION_TYPE_RECOMMENDATION`` and - ``SOLUTION_TYPE_SEARCH``. - - ``SITE_SEARCH``: ``SOLUTION_TYPE_SEARCH`` is automatically - enrolled. Other solutions cannot be enrolled. + * ``MEDIA``: ``SOLUTION_TYPE_RECOMMENDATION`` + and ``SOLUTION_TYPE_SEARCH``. * ``SITE_SEARCH``: + ``SOLUTION_TYPE_SEARCH`` is automatically + enrolled. Other solutions cannot be enrolled. default_schema_id (str): Output only. The id of the default - [Schema][google.cloud.discoveryengine.v1alpha.Schema] + `Schema + `__ asscociated to this data store. content_config (google.cloud.discoveryengine_v1alpha.types.DataStore.ContentConfig): - Immutable. The content config of the data store. If this - field is unset, the server behavior defaults to - [ContentConfig.NO_CONTENT][google.cloud.discoveryengine.v1alpha.DataStore.ContentConfig.NO_CONTENT]. + Immutable. The content config of the data store. + If this field is unset, the server behavior + defaults to `ContentConfig.NO_CONTENT + `__. create_time (google.protobuf.timestamp_pb2.Timestamp): Output only. Timestamp the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] + `DataStore + `__ was created at. language_info (google.cloud.discoveryengine_v1alpha.types.LanguageInfo): Language info for DataStore. @@ -84,49 +89,62 @@ class DataStore(proto.Message): provider config. acl_enabled (bool): Immutable. Whether data in the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] - has ACL information. If set to ``true``, the source data - must have ACL. ACL will be ingested when data is ingested by - [DocumentService.ImportDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments] + `DataStore + `__ + has ACL information. If set to ``true``, the + source data must have ACL. ACL will be ingested + when data is ingested by + `DocumentService.ImportDocuments + `__ methods. When ACL is enabled for the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], - [Document][google.cloud.discoveryengine.v1alpha.Document] + `DataStore + `__, + `Document + `__ can't be accessed by calling - [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument] + `DocumentService.GetDocument + `__ or - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments]. + `DocumentService.ListDocuments + `__. - Currently ACL is only supported in ``GENERIC`` industry - vertical with non-``PUBLIC_WEBSITE`` content config. + Currently ACL is only supported in ``GENERIC`` + industry vertical with non-``PUBLIC_WEBSITE`` + content config. workspace_config (google.cloud.discoveryengine_v1alpha.types.WorkspaceConfig): - Config to store data store type configuration for workspace - data. This must be set when - [DataStore.content_config][google.cloud.discoveryengine.v1alpha.DataStore.content_config] + Config to store data store type configuration + for workspace data. This must be set when + `DataStore.content_config + `__ is set as - [DataStore.ContentConfig.GOOGLE_WORKSPACE][google.cloud.discoveryengine.v1alpha.DataStore.ContentConfig.GOOGLE_WORKSPACE]. + `DataStore.ContentConfig.GOOGLE_WORKSPACE + `__. document_processing_config (google.cloud.discoveryengine_v1alpha.types.DocumentProcessingConfig): Configuration for Document understanding and enrichment. starting_schema (google.cloud.discoveryengine_v1alpha.types.Schema): The start schema to use for this - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] - when provisioning it. If unset, a default vertical - specialized schema will be used. + `DataStore + `__ + when provisioning it. If unset, a default + vertical specialized schema will be used. - This field is only used by [CreateDataStore][] API, and will - be ignored if used in other APIs. This field will be omitted - from all API responses including [CreateDataStore][] API. To - retrieve a schema of a - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], - use - [SchemaService.GetSchema][google.cloud.discoveryengine.v1alpha.SchemaService.GetSchema] + This field is only used by [CreateDataStore][] + API, and will be ignored if used in other APIs. + This field will be omitted from all API + responses including [CreateDataStore][] API. To + retrieve a schema of a `DataStore + `__, + use `SchemaService.GetSchema + `__ API instead. - The provided schema will be validated against certain rules - on schema. Learn more from `this - doc `__. + The provided schema will be validated against + certain rules on schema. Learn more from `this + doc + `__. """ class ContentConfig(proto.Enum): @@ -137,17 +155,20 @@ class ContentConfig(proto.Enum): Default value. NO_CONTENT (1): Only contains documents without any - [Document.content][google.cloud.discoveryengine.v1alpha.Document.content]. + `Document.content + `__. CONTENT_REQUIRED (2): Only contains documents with - [Document.content][google.cloud.discoveryengine.v1alpha.Document.content]. + `Document.content + `__. PUBLIC_WEBSITE (3): The data store is used for public website search. GOOGLE_WORKSPACE (4): - The data store is used for workspace search. Details of - workspace data store are specified in the - [WorkspaceConfig][google.cloud.discoveryengine.v1alpha.WorkspaceConfig]. + The data store is used for workspace search. + Details of workspace data store are specified in + the `WorkspaceConfig + `__. """ CONTENT_CONFIG_UNSPECIFIED = 0 NO_CONTENT = 1 @@ -225,17 +246,20 @@ class LanguageInfo(proto.Message): language_code (str): The language code for the DataStore. normalized_language_code (str): - Output only. This is the normalized form of language_code. - E.g.: language_code of ``en-GB``, ``en_GB``, ``en-UK`` or - ``en-gb`` will have normalized_language_code of ``en-GB``. + Output only. This is the normalized form of + language_code. E.g.: language_code of ``en-GB``, + ``en_GB``, ``en-UK`` or ``en-gb`` will have + normalized_language_code of ``en-GB``. language (str): - Output only. Language part of normalized_language_code. - E.g.: ``en-US`` -> ``en``, ``zh-Hans-HK`` -> ``zh``, ``en`` - -> ``en``. + Output only. Language part of + normalized_language_code. E.g.: ``en-US`` -> + ``en``, ``zh-Hans-HK`` -> ``zh``, ``en`` -> + ``en``. region (str): - Output only. Region part of normalized_language_code, if - present. E.g.: ``en-US`` -> ``US``, ``zh-Hans-HK`` -> - ``HK``, ``en`` -> \`\`. + Output only. Region part of + normalized_language_code, if present. E.g.: + ``en-US`` -> ``US``, ``zh-Hans-HK`` -> ``HK``, + ``en`` -> ``. """ language_code: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/data_store_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/data_store_service.py index 2547cd08e41d..ea6d22760b2a 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/data_store_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/data_store_service.py @@ -45,7 +45,8 @@ class CreateDataStoreRequest(proto.Message): r"""Request for - [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.CreateDataStore] + `DataStoreService.CreateDataStore + `__ method. Attributes: @@ -53,33 +54,40 @@ class CreateDataStoreRequest(proto.Message): Required. The parent resource name, such as ``projects/{project}/locations/{location}/collections/{collection}``. data_store (google.cloud.discoveryengine_v1alpha.types.DataStore): - Required. The - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] + Required. The `DataStore + `__ to create. data_store_id (str): Required. The ID to use for the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], + `DataStore + `__, which will become the final component of the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]'s + `DataStore + `__'s resource name. - This field must conform to - `RFC-1034 `__ standard - with a length limit of 63 characters. Otherwise, an - INVALID_ARGUMENT error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 characters. + Otherwise, an INVALID_ARGUMENT error is + returned. create_advanced_site_search (bool): - A boolean flag indicating whether user want to directly - create an advanced data store for site search. If the data - store is not configured as site search (GENERIC vertical and - PUBLIC_WEBSITE content_config), this flag will be ignored. + A boolean flag indicating whether user want to + directly create an advanced data store for site + search. If the data store is not configured as + site + search (GENERIC vertical and PUBLIC_WEBSITE + content_config), this flag will be ignored. skip_default_schema_creation (bool): - A boolean flag indicating whether to skip the default schema - creation for the data store. Only enable this flag if you - are certain that the default schema is incompatible with - your use case. + A boolean flag indicating whether to skip the + default schema creation for the data store. Only + enable this flag if you are certain that the + default schema is incompatible with your use + case. - If set to true, you must manually create a schema for the - data store before any documents can be ingested. + If set to true, you must manually create a + schema for the data store before any documents + can be ingested. This flag cannot be specified if ``data_store.starting_schema`` is specified. @@ -110,23 +118,27 @@ class CreateDataStoreRequest(proto.Message): class GetDataStoreRequest(proto.Message): r"""Request message for - [DataStoreService.GetDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.GetDataStore] + `DataStoreService.GetDataStore + `__ method. Attributes: name (str): Required. Full resource name of - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], + `DataStore + `__, such as ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. - If the caller does not have permission to access the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. + If the caller does not have permission to access + the `DataStore + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. If the requested - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] + `DataStore + `__ does not exist, a NOT_FOUND error is returned. """ @@ -138,7 +150,8 @@ class GetDataStoreRequest(proto.Message): class CreateDataStoreMetadata(proto.Message): r"""Metadata related to the progress of the - [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.CreateDataStore] + `DataStoreService.CreateDataStore + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -164,39 +177,52 @@ class CreateDataStoreMetadata(proto.Message): class ListDataStoresRequest(proto.Message): r"""Request message for - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores] + `DataStoreService.ListDataStores + `__ method. Attributes: parent (str): - Required. The parent branch resource name, such as + Required. The parent branch resource name, such + as ``projects/{project}/locations/{location}/collections/{collection_id}``. If the caller does not have permission to list - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s - under this location, regardless of whether or not this data - store exists, a PERMISSION_DENIED error is returned. + `DataStore + `__s + under this location, regardless of whether or + not this data store exists, a PERMISSION_DENIED + error is returned. page_size (int): Maximum number of - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s - to return. If unspecified, defaults to 10. The maximum - allowed value is 50. Values above 50 will be coerced to 50. - - If this field is negative, an INVALID_ARGUMENT is returned. + `DataStore + `__s + to return. If unspecified, defaults to 10. The + maximum allowed value is 50. Values above 50 + will be coerced to 50. + + If this field is negative, an INVALID_ARGUMENT + is returned. page_token (str): A page token - [ListDataStoresResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListDataStoresResponse.next_page_token], + `ListDataStoresResponse.next_page_token + `__, received from a previous - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores] - call. Provide this to retrieve the subsequent page. - - When paginating, all other parameters provided to - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores] - must match the call that provided the page token. Otherwise, - an INVALID_ARGUMENT error is returned. + `DataStoreService.ListDataStores + `__ + call. Provide this to retrieve the subsequent + page. + + When paginating, all other parameters provided + to `DataStoreService.ListDataStores + `__ + must match the call that provided the page + token. Otherwise, an INVALID_ARGUMENT error is + returned. filter (str): - Filter by solution type . For example: - ``filter = 'solution_type:SOLUTION_TYPE_SEARCH'`` + Filter by solution type . + For example: ``filter = + 'solution_type:SOLUTION_TYPE_SEARCH'`` """ parent: str = proto.Field( @@ -219,18 +245,21 @@ class ListDataStoresRequest(proto.Message): class ListDataStoresResponse(proto.Message): r"""Response message for - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores] + `DataStoreService.ListDataStores + `__ method. Attributes: data_stores (MutableSequence[google.cloud.discoveryengine_v1alpha.types.DataStore]): All the customer's - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s. + `DataStore + `__s. next_page_token (str): A token that can be sent as - [ListDataStoresRequest.page_token][google.cloud.discoveryengine.v1alpha.ListDataStoresRequest.page_token] - to retrieve the next page. If this field is omitted, there - are no subsequent pages. + `ListDataStoresRequest.page_token + `__ + to retrieve the next page. If this field is + omitted, there are no subsequent pages. """ @property @@ -250,24 +279,28 @@ def raw_page(self): class DeleteDataStoreRequest(proto.Message): r"""Request message for - [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.DeleteDataStore] + `DataStoreService.DeleteDataStore + `__ method. Attributes: name (str): Required. Full resource name of - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], + `DataStore + `__, such as ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. - If the caller does not have permission to delete the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. + If the caller does not have permission to delete + the `DataStore + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. - If the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] - to delete does not exist, a NOT_FOUND error is returned. + If the `DataStore + `__ + to delete does not exist, a NOT_FOUND error is + returned. """ name: str = proto.Field( @@ -278,30 +311,34 @@ class DeleteDataStoreRequest(proto.Message): class UpdateDataStoreRequest(proto.Message): r"""Request message for - [DataStoreService.UpdateDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateDataStore] + `DataStoreService.UpdateDataStore + `__ method. Attributes: data_store (google.cloud.discoveryengine_v1alpha.types.DataStore): - Required. The - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] + Required. The `DataStore + `__ to update. - If the caller does not have permission to update the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. + If the caller does not have permission to update + the `DataStore + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. - If the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] - to update does not exist, a NOT_FOUND error is returned. + If the `DataStore + `__ + to update does not exist, a NOT_FOUND error is + returned. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] + `DataStore + `__ to update. - If an unsupported or unknown field is provided, an - INVALID_ARGUMENT error is returned. + If an unsupported or unknown field is provided, + an INVALID_ARGUMENT error is returned. """ data_store: gcd_data_store.DataStore = proto.Field( @@ -318,7 +355,8 @@ class UpdateDataStoreRequest(proto.Message): class DeleteDataStoreMetadata(proto.Message): r"""Metadata related to the progress of the - [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1alpha.DataStoreService.DeleteDataStore] + `DataStoreService.DeleteDataStore + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -344,13 +382,14 @@ class DeleteDataStoreMetadata(proto.Message): class GetDocumentProcessingConfigRequest(proto.Message): r"""Request for - [DataStoreService.GetDocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DataStoreService.GetDocumentProcessingConfig] + `DataStoreService.GetDocumentProcessingConfig + `__ method. Attributes: name (str): - Required. Full DocumentProcessingConfig resource name. - Format: + Required. Full DocumentProcessingConfig resource + name. Format: ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig`` """ @@ -362,28 +401,36 @@ class GetDocumentProcessingConfigRequest(proto.Message): class UpdateDocumentProcessingConfigRequest(proto.Message): r"""Request for - [DataStoreService.UpdateDocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateDocumentProcessingConfig] + `DataStoreService.UpdateDocumentProcessingConfig + `__ method. Attributes: document_processing_config (google.cloud.discoveryengine_v1alpha.types.DocumentProcessingConfig): Required. The - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig] + `DocumentProcessingConfig + `__ to update. - If the caller does not have permission to update the - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig], + If the caller does not have permission to update + the `DocumentProcessingConfig + `__, then a PERMISSION_DENIED error is returned. If the - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig] - to update does not exist, a NOT_FOUND error is returned. + `DocumentProcessingConfig + `__ + to update does not exist, a NOT_FOUND error is + returned. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [DocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig] - to update. The following are the only supported fields: + `DocumentProcessingConfig + `__ + to update. The following are the only supported + fields: - - [DocumentProcessingConfig.ocr_config][google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ocr_config] + * `DocumentProcessingConfig.ocr_config + `__ If not set, all supported fields are updated. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/document.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/document.py index 8c516cd2895f..c3f4cc8ccccc 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/document.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/document.py @@ -46,65 +46,71 @@ class Document(proto.Message): Attributes: struct_data (google.protobuf.struct_pb2.Struct): - The structured JSON data for the document. It should conform - to the registered - [Schema][google.cloud.discoveryengine.v1alpha.Schema] or an - ``INVALID_ARGUMENT`` error is thrown. + The structured JSON data for the document. It + should conform to the registered `Schema + `__ + or an ``INVALID_ARGUMENT`` error is thrown. This field is a member of `oneof`_ ``data``. json_data (str): - The JSON string representation of the document. It should - conform to the registered - [Schema][google.cloud.discoveryengine.v1alpha.Schema] or an - ``INVALID_ARGUMENT`` error is thrown. + The JSON string representation of the document. + It should conform to the registered `Schema + `__ + or an ``INVALID_ARGUMENT`` error is thrown. This field is a member of `oneof`_ ``data``. name (str): - Immutable. The full resource name of the document. Format: + Immutable. The full resource name of the + document. Format: + ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}``. - This field must be a UTF-8 encoded string with a length - limit of 1024 characters. + This field must be a UTF-8 encoded string with a + length limit of 1024 characters. id (str): Immutable. The identifier of the document. - Id should conform to - `RFC-1034 `__ standard - with a length limit of 63 characters. + Id should conform to `RFC-1034 + `__ + standard with a length limit of 63 characters. schema_id (str): The identifier of the schema located in the same data store. content (google.cloud.discoveryengine_v1alpha.types.Document.Content): - The unstructured data linked to this document. Content must - be set if this document is under a ``CONTENT_REQUIRED`` data - store. + The unstructured data linked to this document. + Content must be set if this document is under a + ``CONTENT_REQUIRED`` data store. parent_document_id (str): - The identifier of the parent document. Currently supports at - most two level document hierarchy. + The identifier of the parent document. Currently + supports at most two level document hierarchy. - Id should conform to - `RFC-1034 `__ standard - with a length limit of 63 characters. + Id should conform to `RFC-1034 + `__ + standard with a length limit of 63 characters. derived_struct_data (google.protobuf.struct_pb2.Struct): - Output only. This field is OUTPUT_ONLY. It contains derived - data that are not in the original input document. + Output only. This field is OUTPUT_ONLY. + It contains derived data that are not in the + original input document. acl_info (google.cloud.discoveryengine_v1alpha.types.Document.AclInfo): Access control information for the document. index_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. The last time the document was indexed. If this - field is set, the document could be returned in search - results. + Output only. The last time the document was + indexed. If this field is set, the document + could be returned in search results. - This field is OUTPUT_ONLY. If this field is not populated, - it means the document has never been indexed. + This field is OUTPUT_ONLY. If this field is not + populated, it means the document has never been + indexed. index_status (google.cloud.discoveryengine_v1alpha.types.Document.IndexStatus): Output only. The index status of the document. - - If document is indexed successfully, the index_time field - is populated. - - Otherwise, if document is not indexed due to errors, the - error_samples field is populated. - - Otherwise, index_status is unset. + * If document is indexed successfully, the + index_time field is populated. + + * Otherwise, if document is not indexed due to + errors, the error_samples field is populated. + + * Otherwise, index_status is unset. """ class Content(proto.Message): @@ -119,35 +125,40 @@ class Content(proto.Message): Attributes: raw_bytes (bytes): - The content represented as a stream of bytes. The maximum - length is 1,000,000 bytes (1 MB / ~0.95 MiB). - - Note: As with all ``bytes`` fields, this field is - represented as pure binary in Protocol Buffers and - base64-encoded string in JSON. For example, - ``abc123!?$*&()'-=@~`` should be represented as - ``YWJjMTIzIT8kKiYoKSctPUB+`` in JSON. See + The content represented as a stream of bytes. + The maximum length is 1,000,000 bytes (1 MB / + ~0.95 MiB). + + Note: As with all ``bytes`` fields, this field + is represented as pure binary in Protocol + Buffers and base64-encoded string in JSON. For + example, ``abc123!?$*&()'-=@~`` should be + represented as ``YWJjMTIzIT8kKiYoKSctPUB+`` in + JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. This field is a member of `oneof`_ ``content``. uri (str): - The URI of the content. Only Cloud Storage URIs (e.g. - ``gs://bucket-name/path/to/file``) are supported. The - maximum file size is 2.5 MB for text-based formats, 200 MB - for other formats. + The URI of the content. Only Cloud Storage URIs + (e.g. ``gs://bucket-name/path/to/file``) are + supported. The maximum file size is 2.5 MB for + text-based formats, 200 MB for other formats. This field is a member of `oneof`_ ``content``. mime_type (str): The MIME type of the content. Supported types: - - ``application/pdf`` (PDF, only native PDFs are supported - for now) - - ``text/html`` (HTML) - - ``application/vnd.openxmlformats-officedocument.wordprocessingml.document`` - (DOCX) - - ``application/vnd.openxmlformats-officedocument.presentationml.presentation`` - (PPTX) - - ``text/plain`` (TXT) + * ``application/pdf`` (PDF, only native PDFs are + supported for now) + + * ``text/html`` (HTML) + * + ``application/vnd.openxmlformats-officedocument.wordprocessingml.document`` + (DOCX) + + * + ``application/vnd.openxmlformats-officedocument.presentationml.presentation`` + (PPTX) * ``text/plain`` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. @@ -184,16 +195,59 @@ class AccessRestriction(proto.Message): Document Hierarchy - Space_S --> Page_P. - Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 - - Space_S ACL Restriction - { "acl_info": { "readers": [ { - "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] - } ] } } - - Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": - [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": - "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { - "user_id": "user_1" } ], } ] } } + Readers: + + Space_S: group_1, user_1 + Page_P: group_2, group_3, user_2 + + Space_S ACL Restriction - + { + "acl_info": { + "readers": [ + { + "principals": [ + { + "group_id": "group_1" + }, + { + "user_id": "user_1" + } + ] + } + ] + } + } + + Page_P ACL Restriction. + { + "acl_info": { + "readers": [ + { + "principals": [ + { + "group_id": "group_2" + }, + { + "group_id": "group_3" + }, + { + "user_id": "user_2" + } + ], + }, + { + "principals": [ + { + "group_id": "group_1" + }, + { + "user_id": "user_1" + } + ], + } + ] + } + } Attributes: principals (MutableSequence[google.cloud.discoveryengine_v1alpha.types.Principal]): @@ -313,8 +367,8 @@ class ProcessedDocument(proto.Message): This field is a member of `oneof`_ ``processed_data_format``. document (str): - Required. Full resource name of the referenced document, in - the format + Required. Full resource name of the referenced + document, in the format ``projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*``. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/document_processing_config.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/document_processing_config.py index 54ec21fe6151..a44b4416daf3 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/document_processing_config.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/document_processing_config.py @@ -29,17 +29,19 @@ class DocumentProcessingConfig(proto.Message): r"""A singleton resource of - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]. It's - empty when - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] is - created, which defaults to digital parser. The first call to - [DataStoreService.UpdateDocumentProcessingConfig][google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateDocumentProcessingConfig] + `DataStore `__. + It's empty when `DataStore + `__ is created, + which defaults to digital parser. The first call to + `DataStoreService.UpdateDocumentProcessingConfig + `__ method will initialize the config. Attributes: name (str): - The full resource name of the Document Processing Config. - Format: + The full resource name of the Document + Processing Config. Format: + ``projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig``. chunking_config (google.cloud.discoveryengine_v1alpha.types.DocumentProcessingConfig.ChunkingConfig): Whether chunking mode is enabled. @@ -50,20 +52,29 @@ class DocumentProcessingConfig(proto.Message): parsing config will be applied to all file types for Document parsing. parsing_config_overrides (MutableMapping[str, google.cloud.discoveryengine_v1alpha.types.DocumentProcessingConfig.ParsingConfig]): - Map from file type to override the default parsing - configuration based on the file type. Supported keys: - - - ``pdf``: Override parsing config for PDF files, either - digital parsing, ocr parsing or layout parsing is - supported. - - ``html``: Override parsing config for HTML files, only - digital parsing and layout parsing are supported. - - ``docx``: Override parsing config for DOCX files, only - digital parsing and layout parsing are supported. - - ``pptx``: Override parsing config for PPTX files, only - digital parsing and layout parsing are supported. - - ``xlsx``: Override parsing config for XLSX files, only - digital parsing and layout parsing are supported. + Map from file type to override the default + parsing configuration based on the file type. + Supported keys: + + * ``pdf``: Override parsing config for PDF + files, either digital parsing, ocr parsing or + layout parsing is supported. + + * ``html``: Override parsing config for HTML + files, only digital parsing and layout parsing + are supported. + + * ``docx``: Override parsing config for DOCX + files, only digital parsing and layout parsing + are supported. + + * ``pptx``: Override parsing config for PPTX + files, only digital parsing and layout parsing + are supported. + + * ``xlsx``: Override parsing config for XLSX + files, only digital parsing and layout parsing + are supported. """ class ChunkingConfig(proto.Message): @@ -146,8 +157,9 @@ class OcrParsingConfig(proto.Message): Attributes: enhanced_document_elements (MutableSequence[str]): - [DEPRECATED] This field is deprecated. To use the additional - enhanced document elements processing, please switch to + [DEPRECATED] This field is deprecated. To use + the additional enhanced document elements + processing, please switch to ``layout_parsing_config``. use_native_text (bool): If true, will use native text instead of OCR diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/document_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/document_service.py index 37f30745eb28..f3dc02e8cba8 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/document_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/document_service.py @@ -41,24 +41,28 @@ class GetDocumentRequest(proto.Message): r"""Request message for - [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument] + `DocumentService.GetDocument + `__ method. Attributes: name (str): Required. Full resource name of - [Document][google.cloud.discoveryengine.v1alpha.Document], + `Document + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}``. - If the caller does not have permission to access the - [Document][google.cloud.discoveryengine.v1alpha.Document], + If the caller does not have permission to access + the `Document + `__, regardless of whether or not it exists, a ``PERMISSION_DENIED`` error is returned. - If the requested - [Document][google.cloud.discoveryengine.v1alpha.Document] - does not exist, a ``NOT_FOUND`` error is returned. + If the requested `Document + `__ + does not exist, a ``NOT_FOUND`` error is + returned. """ name: str = proto.Field( @@ -69,39 +73,50 @@ class GetDocumentRequest(proto.Message): class ListDocumentsRequest(proto.Message): r"""Request message for - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments] + `DocumentService.ListDocuments + `__ method. Attributes: parent (str): - Required. The parent branch resource name, such as + Required. The parent branch resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. - Use ``default_branch`` as the branch ID, to list documents - under the default branch. + Use ``default_branch`` as the branch ID, to list + documents under the default branch. If the caller does not have permission to list - [Document][google.cloud.discoveryengine.v1alpha.Document]s - under this branch, regardless of whether or not this branch - exists, a ``PERMISSION_DENIED`` error is returned. + `Document + `__s + under this branch, regardless of whether or not + this branch exists, a ``PERMISSION_DENIED`` + error is returned. page_size (int): Maximum number of - [Document][google.cloud.discoveryengine.v1alpha.Document]s - to return. If unspecified, defaults to 100. The maximum - allowed value is 1000. Values above 1000 are set to 1000. + `Document + `__s + to return. If unspecified, defaults to 100. The + maximum allowed value is 1000. Values above 1000 + are set to 1000. - If this field is negative, an ``INVALID_ARGUMENT`` error is - returned. + If this field is negative, an + ``INVALID_ARGUMENT`` error is returned. page_token (str): A page token - [ListDocumentsResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListDocumentsResponse.next_page_token], + `ListDocumentsResponse.next_page_token + `__, received from a previous - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments] - call. Provide this to retrieve the subsequent page. - - When paginating, all other parameters provided to - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments] - must match the call that provided the page token. Otherwise, - an ``INVALID_ARGUMENT`` error is returned. + `DocumentService.ListDocuments + `__ + call. Provide this to retrieve the subsequent + page. + + When paginating, all other parameters provided + to `DocumentService.ListDocuments + `__ + must match the call that provided the page + token. Otherwise, an ``INVALID_ARGUMENT`` error + is returned. """ parent: str = proto.Field( @@ -120,18 +135,20 @@ class ListDocumentsRequest(proto.Message): class ListDocumentsResponse(proto.Message): r"""Response message for - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments] + `DocumentService.ListDocuments + `__ method. Attributes: documents (MutableSequence[google.cloud.discoveryengine_v1alpha.types.Document]): - The - [Document][google.cloud.discoveryengine.v1alpha.Document]s. + The `Document + `__s. next_page_token (str): A token that can be sent as - [ListDocumentsRequest.page_token][google.cloud.discoveryengine.v1alpha.ListDocumentsRequest.page_token] - to retrieve the next page. If this field is omitted, there - are no subsequent pages. + `ListDocumentsRequest.page_token + `__ + to retrieve the next page. If this field is + omitted, there are no subsequent pages. """ @property @@ -151,7 +168,8 @@ def raw_page(self): class CreateDocumentRequest(proto.Message): r"""Request message for - [DocumentService.CreateDocument][google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocument] + `DocumentService.CreateDocument + `__ method. Attributes: @@ -159,30 +177,36 @@ class CreateDocumentRequest(proto.Message): Required. The parent resource name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. document (google.cloud.discoveryengine_v1alpha.types.Document): - Required. The - [Document][google.cloud.discoveryengine.v1alpha.Document] to - create. + Required. The `Document + `__ + to create. document_id (str): Required. The ID to use for the - [Document][google.cloud.discoveryengine.v1alpha.Document], + `Document + `__, which becomes the final component of the - [Document.name][google.cloud.discoveryengine.v1alpha.Document.name]. + `Document.name + `__. - If the caller does not have permission to create the - [Document][google.cloud.discoveryengine.v1alpha.Document], + If the caller does not have permission to create + the `Document + `__, regardless of whether or not it exists, a ``PERMISSION_DENIED`` error is returned. This field must be unique among all - [Document][google.cloud.discoveryengine.v1alpha.Document]s - with the same - [parent][google.cloud.discoveryengine.v1alpha.CreateDocumentRequest.parent]. - Otherwise, an ``ALREADY_EXISTS`` error is returned. - - This field must conform to - `RFC-1034 `__ standard - with a length limit of 63 characters. Otherwise, an - ``INVALID_ARGUMENT`` error is returned. + `Document + `__s + with the same `parent + `__. + Otherwise, an ``ALREADY_EXISTS`` error is + returned. + + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 characters. + Otherwise, an ``INVALID_ARGUMENT`` error is + returned. """ parent: str = proto.Field( @@ -202,29 +226,33 @@ class CreateDocumentRequest(proto.Message): class UpdateDocumentRequest(proto.Message): r"""Request message for - [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1alpha.DocumentService.UpdateDocument] + `DocumentService.UpdateDocument + `__ method. Attributes: document (google.cloud.discoveryengine_v1alpha.types.Document): Required. The document to update/create. - If the caller does not have permission to update the - [Document][google.cloud.discoveryengine.v1alpha.Document], + If the caller does not have permission to update + the `Document + `__, regardless of whether or not it exists, a ``PERMISSION_DENIED`` error is returned. - If the - [Document][google.cloud.discoveryengine.v1alpha.Document] to - update does not exist and - [allow_missing][google.cloud.discoveryengine.v1alpha.UpdateDocumentRequest.allow_missing] + If the `Document + `__ + to update does not exist and + `allow_missing + `__ is not set, a ``NOT_FOUND`` error is returned. allow_missing (bool): If set to ``true`` and the - [Document][google.cloud.discoveryengine.v1alpha.Document] is - not found, a new - [Document][google.cloud.discoveryengine.v1alpha.Document] is - be created. + `Document + `__ + is not found, a new `Document + `__ + is be created. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided imported 'document' to update. If not set, by @@ -249,24 +277,28 @@ class UpdateDocumentRequest(proto.Message): class DeleteDocumentRequest(proto.Message): r"""Request message for - [DocumentService.DeleteDocument][google.cloud.discoveryengine.v1alpha.DocumentService.DeleteDocument] + `DocumentService.DeleteDocument + `__ method. Attributes: name (str): Required. Full resource name of - [Document][google.cloud.discoveryengine.v1alpha.Document], + `Document + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}``. - If the caller does not have permission to delete the - [Document][google.cloud.discoveryengine.v1alpha.Document], + If the caller does not have permission to delete + the `Document + `__, regardless of whether or not it exists, a ``PERMISSION_DENIED`` error is returned. - If the - [Document][google.cloud.discoveryengine.v1alpha.Document] to - delete does not exist, a ``NOT_FOUND`` error is returned. + If the `Document + `__ + to delete does not exist, a ``NOT_FOUND`` error + is returned. """ name: str = proto.Field( @@ -277,24 +309,28 @@ class DeleteDocumentRequest(proto.Message): class GetProcessedDocumentRequest(proto.Message): r"""Request message for - [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument] + `DocumentService.GetDocument + `__ method. Attributes: name (str): Required. Full resource name of - [Document][google.cloud.discoveryengine.v1alpha.Document], + `Document + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}``. - If the caller does not have permission to access the - [Document][google.cloud.discoveryengine.v1alpha.Document], + If the caller does not have permission to access + the `Document + `__, regardless of whether or not it exists, a ``PERMISSION_DENIED`` error is returned. - If the requested - [Document][google.cloud.discoveryengine.v1alpha.Document] - does not exist, a ``NOT_FOUND`` error is returned. + If the requested `Document + `__ + does not exist, a ``NOT_FOUND`` error is + returned. processed_document_type (google.cloud.discoveryengine_v1alpha.types.GetProcessedDocumentRequest.ProcessedDocumentType): Required. What type of processing to return. processed_document_format (google.cloud.discoveryengine_v1alpha.types.GetProcessedDocumentRequest.ProcessedDocumentFormat): @@ -354,21 +390,24 @@ class ProcessedDocumentFormat(proto.Enum): class BatchGetDocumentsMetadataRequest(proto.Message): r"""Request message for - [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1alpha.DocumentService.BatchGetDocumentsMetadata] + `DocumentService.BatchGetDocumentsMetadata + `__ method. Attributes: parent (str): - Required. The parent branch resource name, such as + Required. The parent branch resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. matcher (google.cloud.discoveryengine_v1alpha.types.BatchGetDocumentsMetadataRequest.Matcher): Required. Matcher for the - [Document][google.cloud.discoveryengine.v1alpha.Document]s. + `Document + `__s. """ class UrisMatcher(proto.Message): - r"""Matcher for the - [Document][google.cloud.discoveryengine.v1alpha.Document]s by exact + r"""Matcher for the `Document + `__s by exact uris. Attributes: @@ -382,9 +421,9 @@ class UrisMatcher(proto.Message): ) class Matcher(proto.Message): - r"""Matcher for the - [Document][google.cloud.discoveryengine.v1alpha.Document]s. - Currently supports matching by exact URIs. + r"""Matcher for the `Document + `__s. Currently + supports matching by exact URIs. .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields @@ -416,35 +455,38 @@ class Matcher(proto.Message): class BatchGetDocumentsMetadataResponse(proto.Message): r"""Response message for - [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1alpha.DocumentService.BatchGetDocumentsMetadata] + `DocumentService.BatchGetDocumentsMetadata + `__ method. Attributes: documents_metadata (MutableSequence[google.cloud.discoveryengine_v1alpha.types.BatchGetDocumentsMetadataResponse.DocumentMetadata]): The metadata of the - [Document][google.cloud.discoveryengine.v1alpha.Document]s. + `Document + `__s. """ class State(proto.Enum): r"""The state of the - [Document][google.cloud.discoveryengine.v1alpha.Document]. + `Document `__. Values: STATE_UNSPECIFIED (0): Should never be set. INDEXED (1): - The - [Document][google.cloud.discoveryengine.v1alpha.Document] is - indexed. + The `Document + `__ + is indexed. NOT_IN_TARGET_SITE (2): - The - [Document][google.cloud.discoveryengine.v1alpha.Document] is - not indexed because its URI is not in the - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]. + The `Document + `__ + is not indexed because its URI is not in the + `TargetSite + `__. NOT_IN_INDEX (3): - The - [Document][google.cloud.discoveryengine.v1alpha.Document] is - not indexed. + The `Document + `__ + is not indexed. """ STATE_UNSPECIFIED = 0 INDEXED = 1 @@ -453,23 +495,25 @@ class State(proto.Enum): class DocumentMetadata(proto.Message): r"""The metadata of a - [Document][google.cloud.discoveryengine.v1alpha.Document]. + `Document `__. Attributes: matcher_value (google.cloud.discoveryengine_v1alpha.types.BatchGetDocumentsMetadataResponse.DocumentMetadata.MatcherValue): - The value of the matcher that was used to match the - [Document][google.cloud.discoveryengine.v1alpha.Document]. + The value of the matcher that was used to match + the `Document + `__. state (google.cloud.discoveryengine_v1alpha.types.BatchGetDocumentsMetadataResponse.State): The state of the document. last_refreshed_time (google.protobuf.timestamp_pb2.Timestamp): The timestamp of the last time the - [Document][google.cloud.discoveryengine.v1alpha.Document] + `Document + `__ was last indexed. """ class MatcherValue(proto.Message): r"""The value of the matcher that was used to match the - [Document][google.cloud.discoveryengine.v1alpha.Document]. + `Document `__. .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields @@ -477,7 +521,8 @@ class MatcherValue(proto.Message): Attributes: uri (str): If match by URI, the URI of the - [Document][google.cloud.discoveryengine.v1alpha.Document]. + `Document + `__. This field is a member of `oneof`_ ``matcher_value``. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/engine.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/engine.py index 42a29402806a..a9b431637ce4 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/engine.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/engine.py @@ -31,8 +31,8 @@ class Engine(proto.Message): - r"""Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1alpha.Engine]. + r"""Metadata that describes the training and serving parameters of + an `Engine `__. This message has `oneof`_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. @@ -43,60 +43,74 @@ class Engine(proto.Message): Attributes: similar_documents_config (google.cloud.discoveryengine_v1alpha.types.Engine.SimilarDocumentsEngineConfig): - Additional config specs for a ``similar-items`` engine. + Additional config specs for a ``similar-items`` + engine. This field is a member of `oneof`_ ``engine_config``. chat_engine_config (google.cloud.discoveryengine_v1alpha.types.Engine.ChatEngineConfig): - Configurations for the Chat Engine. Only applicable if - [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type] + Configurations for the Chat Engine. Only + applicable if `solution_type + `__ is - [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT]. + `SOLUTION_TYPE_CHAT + `__. This field is a member of `oneof`_ ``engine_config``. search_engine_config (google.cloud.discoveryengine_v1alpha.types.Engine.SearchEngineConfig): - Configurations for the Search Engine. Only applicable if - [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type] + Configurations for the Search Engine. Only + applicable if `solution_type + `__ is - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH]. + `SOLUTION_TYPE_SEARCH + `__. This field is a member of `oneof`_ ``engine_config``. media_recommendation_engine_config (google.cloud.discoveryengine_v1alpha.types.Engine.MediaRecommendationEngineConfig): - Configurations for the Media Engine. Only applicable on the - data stores with - [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type] - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION] + Configurations for the Media Engine. Only + applicable on the data stores with + `solution_type + `__ + `SOLUTION_TYPE_RECOMMENDATION + `__ and - [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1alpha.IndustryVertical.MEDIA] + `IndustryVertical.MEDIA + `__ vertical. This field is a member of `oneof`_ ``engine_config``. recommendation_metadata (google.cloud.discoveryengine_v1alpha.types.Engine.RecommendationMetadata): - Output only. Additional information of a recommendation - engine. Only applicable if - [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type] + Output only. Additional information of a + recommendation engine. Only applicable if + `solution_type + `__ is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + `SOLUTION_TYPE_RECOMMENDATION + `__. This field is a member of `oneof`_ ``engine_metadata``. chat_engine_metadata (google.cloud.discoveryengine_v1alpha.types.Engine.ChatEngineMetadata): - Output only. Additional information of the Chat Engine. Only - applicable if - [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type] + Output only. Additional information of the Chat + Engine. Only applicable if + `solution_type + `__ is - [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT]. + `SOLUTION_TYPE_CHAT + `__. This field is a member of `oneof`_ ``engine_metadata``. name (str): - Immutable. The fully qualified resource name of the engine. - - This field must be a UTF-8 encoded string with a length - limit of 1024 characters. + Immutable. The fully qualified resource name of + the engine. + This field must be a UTF-8 encoded string with a + length limit of 1024 characters. Format: + ``projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`` - engine should be 1-63 characters, and valid characters are - /[a-z0-9][a-z0-9-\_]*/. Otherwise, an INVALID_ARGUMENT error - is returned. + engine should be 1-63 characters, and valid + characters are /`a-z0-9 `__*/. + Otherwise, an INVALID_ARGUMENT error is + returned. display_name (str): Required. The display name of the engine. Should be human readable. UTF-8 encoded string @@ -111,34 +125,41 @@ class Engine(proto.Message): The data stores associated with this engine. For - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH] + `SOLUTION_TYPE_SEARCH + `__ and - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION] - type of engines, they can only associate with at most one - data store. + `SOLUTION_TYPE_RECOMMENDATION + `__ + type of engines, they can only associate with at + most one data store. If - [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type] + `solution_type + `__ is - [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT], - multiple - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s - in the same - [Collection][google.cloud.discoveryengine.v1alpha.Collection] + `SOLUTION_TYPE_CHAT + `__, + multiple `DataStore + `__s + in the same `Collection + `__ can be associated here. Note that when used in - [CreateEngineRequest][google.cloud.discoveryengine.v1alpha.CreateEngineRequest], - one DataStore id must be provided as the system will use it - for necessary initializations. + `CreateEngineRequest + `__, + one DataStore id must be provided as the system + will use it for necessary initializations. solution_type (google.cloud.discoveryengine_v1alpha.types.SolutionType): Required. The solutions of the engine. industry_vertical (google.cloud.discoveryengine_v1alpha.types.IndustryVertical): - The industry vertical that the engine registers. The - restriction of the Engine industry vertical is based on - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]: - If unspecified, default to ``GENERIC``. Vertical on Engine - has to match vertical of the DataStore linked to the engine. + The industry vertical that the engine registers. + The restriction of the Engine industry vertical + is based on `DataStore + `__: + If unspecified, default to ``GENERIC``. Vertical + on Engine has to match vertical of the DataStore + linked to the engine. common_config (google.cloud.discoveryengine_v1alpha.types.Engine.CommonConfig): Common config spec that specifies the metadata of the engine. @@ -151,11 +172,13 @@ class SearchEngineConfig(proto.Message): search_tier (google.cloud.discoveryengine_v1alpha.types.SearchTier): The search feature tier of this engine. - Different tiers might have different pricing. To learn more, - check the pricing documentation. + Different tiers might have different + pricing. To learn more, check the pricing + documentation. Defaults to - [SearchTier.SEARCH_TIER_STANDARD][google.cloud.discoveryengine.v1alpha.SearchTier.SEARCH_TIER_STANDARD] + `SearchTier.SEARCH_TIER_STANDARD + `__ if not specified. search_add_ons (MutableSequence[google.cloud.discoveryengine_v1alpha.types.SearchAddOn]): The add-on that this search engine enables. @@ -180,51 +203,60 @@ class MediaRecommendationEngineConfig(proto.Message): Attributes: type_ (str): - Required. The type of engine. e.g., ``recommended-for-you``. - + Required. The type of engine. e.g., + ``recommended-for-you``. This field together with - [optimization_objective][Engine.optimization_objective] - describe engine metadata to use to control engine training - and serving. + `optimization_objective + `__ describe + engine metadata to use to control engine + training and serving. - Currently supported values: ``recommended-for-you``, + Currently supported values: + ``recommended-for-you``, ``others-you-may-like``, ``more-like-this``, ``most-popular-items``. optimization_objective (str): The optimization objective. e.g., ``cvr``. This field together with - [optimization_objective][google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig.type] - describe engine metadata to use to control engine training - and serving. + `optimization_objective + `__ + describe engine metadata to use to control + engine training and serving. - Currently supported values: ``ctr``, ``cvr``. + Currently supported + values: ``ctr``, ``cvr``. - If not specified, we choose default based on engine type. - Default depends on type of recommendation: + If not specified, we choose default based on + engine type. Default depends on type of + recommendation: ``recommended-for-you`` => ``ctr`` ``others-you-may-like`` => ``ctr`` optimization_objective_config (google.cloud.discoveryengine_v1alpha.types.Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig): Name and value of the custom threshold for cvr - optimization_objective. For target_field ``watch-time``, - target_field_value must be an integer value indicating the - media progress time in seconds between (0, 86400] (excludes - 0, includes 86400) (e.g., 90). For target_field - ``watch-percentage``, the target_field_value must be a valid - float value between (0, 1.0] (excludes 0, includes 1.0) + optimization_objective. For target_field + ``watch-time``, target_field_value must be an + integer value indicating the media progress time + in seconds between (0, 86400] (excludes 0, + includes 86400) (e.g., 90). + For target_field ``watch-percentage``, the + target_field_value must be a valid float value + between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5). training_state (google.cloud.discoveryengine_v1alpha.types.Engine.MediaRecommendationEngineConfig.TrainingState): - The training state that the engine is in (e.g. ``TRAINING`` - or ``PAUSED``). - - Since part of the cost of running the service is frequency - of training - this can be used to determine when to train - engine in order to control cost. If not specified: the - default value for ``CreateEngine`` method is ``TRAINING``. - The default value for ``UpdateEngine`` method is to keep the - state the same as before. + The training state that the engine is in (e.g. + ``TRAINING`` or ``PAUSED``). + + Since part of the cost of running the service is + frequency of training - this can be used to + determine when to train engine in order to + control cost. If not specified: the default + value for ``CreateEngine`` method is + ``TRAINING``. The default value for + ``UpdateEngine`` method is to keep the state the + same as before. """ class TrainingState(proto.Enum): @@ -247,8 +279,9 @@ class OptimizationObjectiveConfig(proto.Message): Attributes: target_field (str): - Required. The name of the field to target. Currently - supported values: ``watch-percentage``, ``watch-time``. + Required. The name of the field to target. + Currently supported values: + ``watch-percentage``, ``watch-time``. target_field_value_float (float): Required. The threshold to be applied to the target (e.g., 0.5). @@ -289,44 +322,53 @@ class ChatEngineConfig(proto.Message): Attributes: agent_creation_config (google.cloud.discoveryengine_v1alpha.types.Engine.ChatEngineConfig.AgentCreationConfig): - The configurationt generate the Dialogflow agent that is - associated to this Engine. - - Note that these configurations are one-time consumed by and - passed to Dialogflow service. It means they cannot be - retrieved using - [EngineService.GetEngine][google.cloud.discoveryengine.v1alpha.EngineService.GetEngine] + The configurationt generate the Dialogflow agent + that is associated to this Engine. + + Note that these configurations are one-time + consumed by and passed to Dialogflow service. It + means they cannot be retrieved using + `EngineService.GetEngine + `__ or - [EngineService.ListEngines][google.cloud.discoveryengine.v1alpha.EngineService.ListEngines] + `EngineService.ListEngines + `__ API after engine creation. dialogflow_agent_to_link (str): - The resource name of an exist Dialogflow agent to link to - this Chat Engine. Customers can either provide - ``agent_creation_config`` to create agent or provide an - agent name that links the agent with the Chat engine. - - Format: - ``projects//locations//agents/``. - - Note that the ``dialogflow_agent_to_link`` are one-time - consumed by and passed to Dialogflow service. It means they - cannot be retrieved using - [EngineService.GetEngine][google.cloud.discoveryengine.v1alpha.EngineService.GetEngine] + The resource name of an exist Dialogflow agent + to link to this Chat Engine. Customers can + either provide ``agent_creation_config`` to + create agent or provide an agent name that links + the agent with the Chat engine. + + Format: ``projects//locations//agents/``. + + Note that the ``dialogflow_agent_to_link`` are + one-time consumed by and passed to Dialogflow + service. It means they cannot be retrieved using + `EngineService.GetEngine + `__ or - [EngineService.ListEngines][google.cloud.discoveryengine.v1alpha.EngineService.ListEngines] + `EngineService.ListEngines + `__ API after engine creation. Use - [ChatEngineMetadata.dialogflow_agent][google.cloud.discoveryengine.v1alpha.Engine.ChatEngineMetadata.dialogflow_agent] - for actual agent association after Engine is created. + `ChatEngineMetadata.dialogflow_agent + `__ + for actual agent association after Engine is + created. """ class AgentCreationConfig(proto.Message): r"""Configurations for generating a Dialogflow agent. - Note that these configurations are one-time consumed by and passed - to Dialogflow service. It means they cannot be retrieved using - [EngineService.GetEngine][google.cloud.discoveryengine.v1alpha.EngineService.GetEngine] + Note that these configurations are one-time consumed by and + passed to Dialogflow service. It means they cannot be retrieved + using `EngineService.GetEngine + `__ or - [EngineService.ListEngines][google.cloud.discoveryengine.v1alpha.EngineService.ListEngines] + `EngineService.ListEngines + `__ API after engine creation. Attributes: @@ -336,13 +378,16 @@ class AgentCreationConfig(proto.Message): knowledge connector LLM prompt and for knowledge search. default_language_code (str): - Required. The default language of the agent as a language - tag. See `Language - Support `__ - for a list of the currently supported language codes. + Required. The default language of the agent as a + language tag. See `Language + Support + `__ + for a list of the currently supported language + codes. time_zone (str): - Required. The time zone of the agent from the `time zone - database `__, e.g., + Required. The time zone of the agent from the + `time zone database + `__, e.g., America/New_York, Europe/Paris. location (str): Agent location for Agent creation, supported @@ -401,17 +446,19 @@ class RecommendationMetadata(proto.Message): Attributes: serving_state (google.cloud.discoveryengine_v1alpha.types.Engine.RecommendationMetadata.ServingState): - Output only. The serving state of the engine: ``ACTIVE``, - ``NOT_ACTIVE``. + Output only. The serving state of the engine: + ``ACTIVE``, ``NOT_ACTIVE``. data_state (google.cloud.discoveryengine_v1alpha.types.Engine.RecommendationMetadata.DataState): - Output only. The state of data requirements for this engine: - ``DATA_OK`` and ``DATA_ERROR``. - - Engine cannot be trained if the data is in ``DATA_ERROR`` - state. Engine can have ``DATA_ERROR`` state even if serving - state is ``ACTIVE``: engines were trained successfully - before, but cannot be refreshed because the underlying - engine no longer has sufficient data for training. + Output only. The state of data requirements for + this engine: ``DATA_OK`` and ``DATA_ERROR``. + + Engine cannot be trained if the data is in + ``DATA_ERROR`` state. Engine can have + ``DATA_ERROR`` state even if serving state is + ``ACTIVE``: engines were trained successfully + before, but cannot be refreshed because the + underlying engine no longer has sufficient data + for training. last_tune_time (google.protobuf.timestamp_pb2.Timestamp): Output only. The timestamp when the latest successful tune finished. Only applicable on @@ -493,11 +540,11 @@ class ChatEngineMetadata(proto.Message): Attributes: dialogflow_agent (str): - The resource name of a Dialogflow agent, that this Chat - Engine refers to. + The resource name of a Dialogflow agent, that + this Chat Engine refers to. - Format: - ``projects//locations//agents/``. + Format: ``projects//locations//agents/``. """ dialogflow_agent: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/engine_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/engine_service.py index 2c97a5d28828..ca43613d6b73 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/engine_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/engine_service.py @@ -45,7 +45,8 @@ class CreateEngineRequest(proto.Message): r"""Request for - [EngineService.CreateEngine][google.cloud.discoveryengine.v1alpha.EngineService.CreateEngine] + `EngineService.CreateEngine + `__ method. Attributes: @@ -53,20 +54,23 @@ class CreateEngineRequest(proto.Message): Required. The parent resource name, such as ``projects/{project}/locations/{location}/collections/{collection}``. engine (google.cloud.discoveryengine_v1alpha.types.Engine): - Required. The - [Engine][google.cloud.discoveryengine.v1alpha.Engine] to - create. + Required. The `Engine + `__ + to create. engine_id (str): Required. The ID to use for the - [Engine][google.cloud.discoveryengine.v1alpha.Engine], which - will become the final component of the - [Engine][google.cloud.discoveryengine.v1alpha.Engine]'s + `Engine + `__, + which will become the final component of the + `Engine + `__'s resource name. - This field must conform to - `RFC-1034 `__ standard - with a length limit of 63 characters. Otherwise, an - INVALID_ARGUMENT error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 characters. + Otherwise, an INVALID_ARGUMENT error is + returned. """ parent: str = proto.Field( @@ -86,7 +90,8 @@ class CreateEngineRequest(proto.Message): class CreateEngineMetadata(proto.Message): r"""Metadata related to the progress of the - [EngineService.CreateEngine][google.cloud.discoveryengine.v1alpha.EngineService.CreateEngine] + `EngineService.CreateEngine + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -112,23 +117,28 @@ class CreateEngineMetadata(proto.Message): class DeleteEngineRequest(proto.Message): r"""Request message for - [EngineService.DeleteEngine][google.cloud.discoveryengine.v1alpha.EngineService.DeleteEngine] + `EngineService.DeleteEngine + `__ method. Attributes: name (str): Required. Full resource name of - [Engine][google.cloud.discoveryengine.v1alpha.Engine], such - as + `Engine + `__, + such as ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. - If the caller does not have permission to delete the - [Engine][google.cloud.discoveryengine.v1alpha.Engine], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. + If the caller does not have permission to delete + the `Engine + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. - If the [Engine][google.cloud.discoveryengine.v1alpha.Engine] - to delete does not exist, a NOT_FOUND error is returned. + If the `Engine + `__ + to delete does not exist, a NOT_FOUND error is + returned. """ name: str = proto.Field( @@ -139,7 +149,8 @@ class DeleteEngineRequest(proto.Message): class DeleteEngineMetadata(proto.Message): r"""Metadata related to the progress of the - [EngineService.DeleteEngine][google.cloud.discoveryengine.v1alpha.EngineService.DeleteEngine] + `EngineService.DeleteEngine + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -165,14 +176,16 @@ class DeleteEngineMetadata(proto.Message): class GetEngineRequest(proto.Message): r"""Request message for - [EngineService.GetEngine][google.cloud.discoveryengine.v1alpha.EngineService.GetEngine] + `EngineService.GetEngine + `__ method. Attributes: name (str): Required. Full resource name of - [Engine][google.cloud.discoveryengine.v1alpha.Engine], such - as + `Engine + `__, + such as ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. """ @@ -184,7 +197,8 @@ class GetEngineRequest(proto.Message): class ListEnginesRequest(proto.Message): r"""Request message for - [EngineService.ListEngines][google.cloud.discoveryengine.v1alpha.EngineService.ListEngines] + `EngineService.ListEngines + `__ method. Attributes: @@ -220,13 +234,14 @@ class ListEnginesRequest(proto.Message): class ListEnginesResponse(proto.Message): r"""Response message for - [EngineService.ListEngines][google.cloud.discoveryengine.v1alpha.EngineService.ListEngines] + `EngineService.ListEngines + `__ method. Attributes: engines (MutableSequence[google.cloud.discoveryengine_v1alpha.types.Engine]): - All the customer's - [Engine][google.cloud.discoveryengine.v1alpha.Engine]s. + All the customer's `Engine + `__s. next_page_token (str): Not supported. """ @@ -248,29 +263,34 @@ def raw_page(self): class UpdateEngineRequest(proto.Message): r"""Request message for - [EngineService.UpdateEngine][google.cloud.discoveryengine.v1alpha.EngineService.UpdateEngine] + `EngineService.UpdateEngine + `__ method. Attributes: engine (google.cloud.discoveryengine_v1alpha.types.Engine): - Required. The - [Engine][google.cloud.discoveryengine.v1alpha.Engine] to - update. - - If the caller does not have permission to update the - [Engine][google.cloud.discoveryengine.v1alpha.Engine], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. - - If the [Engine][google.cloud.discoveryengine.v1alpha.Engine] - to update does not exist, a NOT_FOUND error is returned. + Required. The `Engine + `__ + to update. + + If the caller does not have permission to update + the `Engine + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. + + If the `Engine + `__ + to update does not exist, a NOT_FOUND error is + returned. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [Engine][google.cloud.discoveryengine.v1alpha.Engine] to - update. + `Engine + `__ + to update. - If an unsupported or unknown field is provided, an - INVALID_ARGUMENT error is returned. + If an unsupported or unknown field is provided, + an INVALID_ARGUMENT error is returned. """ engine: gcd_engine.Engine = proto.Field( @@ -290,7 +310,9 @@ class PauseEngineRequest(proto.Message): Attributes: name (str): - Required. The name of the engine to pause. Format: + Required. The name of the engine to pause. + Format: + ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`` """ @@ -305,7 +327,9 @@ class ResumeEngineRequest(proto.Message): Attributes: name (str): - Required. The name of the engine to resume. Format: + Required. The name of the engine to resume. + Format: + ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`` """ @@ -321,7 +345,9 @@ class TuneEngineRequest(proto.Message): Attributes: name (str): - Required. The resource name of the engine to tune. Format: + Required. The resource name of the engine to + tune. Format: + ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`` """ @@ -336,8 +362,9 @@ class TuneEngineMetadata(proto.Message): Attributes: engine (str): - Required. The resource name of the engine that this tune - applies to. Format: + Required. The resource name of the engine that + this tune applies to. Format: + ``projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`` """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/estimate_billing_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/estimate_billing_service.py index 11db5f0dd9b7..ef0106d2d7f5 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/estimate_billing_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/estimate_billing_service.py @@ -34,7 +34,8 @@ class EstimateDataSizeRequest(proto.Message): r"""Request message for - [EstimateBillingService.EstimateDataSize][google.cloud.discoveryengine.v1alpha.EstimateBillingService.EstimateDataSize] + `EstimateBillingService.EstimateDataSize + `__ method This message has `oneof`_ fields (mutually exclusive fields). @@ -54,7 +55,8 @@ class EstimateDataSizeRequest(proto.Message): This field is a member of `oneof`_ ``data_source``. location (str): - Required. Full resource name of the location, such as + Required. Full resource name of the location, + such as ``projects/{project}/locations/{location}``. """ @@ -64,9 +66,9 @@ class WebsiteDataSource(proto.Message): Attributes: estimator_uri_patterns (MutableSequence[google.cloud.discoveryengine_v1alpha.types.EstimateDataSizeRequest.WebsiteDataSource.EstimatorUriPattern]): - Required. The URI patterns to estimate the data sizes. At - most 10 patterns are allowed, otherwise an INVALID_ARGUMENT - error is thrown. + Required. The URI patterns to estimate the data + sizes. At most 10 patterns are allowed, + otherwise an INVALID_ARGUMENT error is thrown. """ class EstimatorUriPattern(proto.Message): @@ -74,7 +76,8 @@ class EstimatorUriPattern(proto.Message): Attributes: provided_uri_pattern (str): - User provided URI pattern. For example, ``foo.com/bar/*``. + User provided URI pattern. For example, + ``foo.com/bar/*``. exact_match (bool): Whether we infer the generated URI or use the exact provided one. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/evaluation.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/evaluation.py index adfc5ebade66..bd120e099eb7 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/evaluation.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/evaluation.py @@ -40,23 +40,25 @@ class Evaluation(proto.Message): Attributes: name (str): Identifier. The full resource name of the - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation], + `Evaluation + `__, in the format of ``projects/{project}/locations/{location}/evaluations/{evaluation}``. - This field must be a UTF-8 encoded string with a length - limit of 1024 characters. + This field must be a UTF-8 encoded string with a + length limit of 1024 characters. evaluation_spec (google.cloud.discoveryengine_v1alpha.types.Evaluation.EvaluationSpec): Required. The specification of the evaluation. quality_metrics (google.cloud.discoveryengine_v1alpha.types.QualityMetrics): - Output only. The metrics produced by the evaluation, - averaged across all - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s - in the - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]. - - Only populated when the evaluation's state is SUCCEEDED. + Output only. The metrics produced by the + evaluation, averaged across all `SampleQuery + `__s + in the `SampleQuerySet + `__. + + Only populated when the evaluation's state is + SUCCEEDED. state (google.cloud.discoveryengine_v1alpha.types.Evaluation.State): Output only. The state of the evaluation. error (google.rpc.status_pb2.Status): @@ -65,11 +67,13 @@ class Evaluation(proto.Message): state is FAILED. create_time (google.protobuf.timestamp_pb2.Timestamp): Output only. Timestamp the - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation] + `Evaluation + `__ was created at. end_time (google.protobuf.timestamp_pb2.Timestamp): Output only. Timestamp the - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation] + `Evaluation + `__ was completed at. error_samples (MutableSequence[google.rpc.status_pb2.Status]): Output only. A sample of errors encountered @@ -105,20 +109,29 @@ class EvaluationSpec(proto.Message): Attributes: search_request (google.cloud.discoveryengine_v1alpha.types.SearchRequest): - Required. The search request that is used to perform the - evaluation. - - Only the following fields within SearchRequest are - supported; if any other fields are provided, an UNSUPPORTED - error will be returned: - - - [SearchRequest.serving_config][google.cloud.discoveryengine.v1alpha.SearchRequest.serving_config] - - [SearchRequest.branch][google.cloud.discoveryengine.v1alpha.SearchRequest.branch] - - [SearchRequest.canonical_filter][google.cloud.discoveryengine.v1alpha.SearchRequest.canonical_filter] - - [SearchRequest.query_expansion_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.query_expansion_spec] - - [SearchRequest.spell_correction_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.spell_correction_spec] - - [SearchRequest.content_search_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.content_search_spec] - - [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1alpha.SearchRequest.user_pseudo_id] + Required. The search request that is used to + perform the evaluation. + Only the following fields within SearchRequest + are supported; if any other fields are provided, + an UNSUPPORTED error will be returned: + + * `SearchRequest.serving_config + `__ + * `SearchRequest.branch + `__ + + * `SearchRequest.canonical_filter + `__ + * `SearchRequest.query_expansion_spec + `__ + + * `SearchRequest.spell_correction_spec + `__ + * `SearchRequest.content_search_spec + `__ + + * `SearchRequest.user_pseudo_id + `__ This field is a member of `oneof`_ ``search_spec``. query_set_spec (google.cloud.discoveryengine_v1alpha.types.Evaluation.EvaluationSpec.QuerySetSpec): @@ -131,7 +144,8 @@ class QuerySetSpec(proto.Message): Attributes: sample_query_set (str): Required. The full resource name of the - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] + `SampleQuerySet + `__ used for the evaluation, in the format of ``projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}``. """ @@ -199,81 +213,98 @@ class QualityMetrics(proto.Message): Attributes: doc_recall (google.cloud.discoveryengine_v1alpha.types.QualityMetrics.TopkMetrics): - Recall per document, at various top-k cutoff levels. - - Recall is the fraction of relevant documents retrieved out - of all relevant documents. + Recall per document, at various top-k cutoff + levels. + Recall is the fraction of relevant documents + retrieved out of all relevant documents. Example (top-5): - - For a single - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], - If 3 out of 5 relevant documents are retrieved in the - top-5, recall@5 = 3/5 = 0.6 + * For a single + `SampleQuery + `__, + If 3 out of 5 relevant documents are retrieved + in the top-5, recall@5 = 3/5 = 0.6 doc_precision (google.cloud.discoveryengine_v1alpha.types.QualityMetrics.TopkMetrics): - Precision per document, at various top-k cutoff levels. - - Precision is the fraction of retrieved documents that are - relevant. + Precision per document, at various top-k cutoff + levels. + Precision is the fraction of retrieved documents + that are relevant. Example (top-5): - - For a single - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], - If 4 out of 5 retrieved documents in the top-5 are - relevant, precision@5 = 4/5 = 0.8 + * For a single + `SampleQuery + `__, + If 4 out of 5 retrieved documents in the top-5 + are relevant, precision@5 = 4/5 = 0.8 doc_ndcg (google.cloud.discoveryengine_v1alpha.types.QualityMetrics.TopkMetrics): - Normalized discounted cumulative gain (NDCG) per document, - at various top-k cutoff levels. + Normalized discounted cumulative gain (NDCG) per + document, at various top-k cutoff levels. - NDCG measures the ranking quality, giving higher relevance - to top results. + NDCG measures the ranking quality, giving higher + relevance to top results. - Example (top-3): Suppose - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] - with three retrieved documents (D1, D2, D3) and binary - relevance judgements (1 for relevant, 0 for not relevant): + Example (top-3): - Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), - D3 (0)] + Suppose `SampleQuery + `__ + with three retrieved documents (D1, D2, D3) and + binary relevance judgements (1 for relevant, 0 + for not relevant): - Calculate NDCG@3 for each - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]: - \* DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 \* - Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 - \* NDCG@3: 1.13/1.63 = 0.693 + Retrieved: [D3 (0), D1 (1), D2 (1)] + Ideal: [D1 (1), D2 (1), D3 (0)] + + Calculate NDCG@3 for each + `SampleQuery + `__: + + * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) + = 1.13 * Ideal DCG@3: 1/log2(1+1) + + 1/log2(2+1) + 0/log2(3+1) = 1.63 + + * NDCG@3: 1.13/1.63 = 0.693 page_recall (google.cloud.discoveryengine_v1alpha.types.QualityMetrics.TopkMetrics): Recall per page, at various top-k cutoff levels. - Recall is the fraction of relevant pages retrieved out of - all relevant pages. + Recall is the fraction of relevant pages + retrieved out of all relevant pages. Example (top-5): - - For a single - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], - if 3 out of 5 relevant pages are retrieved in the top-5, - recall@5 = 3/5 = 0.6 + * For a single + `SampleQuery + `__, + if 3 out of 5 relevant pages are retrieved in + the top-5, recall@5 = 3/5 = 0.6 page_ndcg (google.cloud.discoveryengine_v1alpha.types.QualityMetrics.TopkMetrics): - Normalized discounted cumulative gain (NDCG) per page, at - various top-k cutoff levels. + Normalized discounted cumulative gain (NDCG) per + page, at various top-k cutoff levels. + + NDCG measures the ranking quality, giving higher + relevance to top results. + + Example (top-3): + + Suppose `SampleQuery + `__ + with three retrieved pages (P1, P2, P3) and + binary relevance judgements (1 for relevant, 0 + for not relevant): - NDCG measures the ranking quality, giving higher relevance - to top results. + Retrieved: [P3 (0), P1 (1), P2 (1)] + Ideal: [P1 (1), P2 (1), P3 (0)] - Example (top-3): Suppose - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] - with three retrieved pages (P1, P2, P3) and binary relevance - judgements (1 for relevant, 0 for not relevant): + Calculate NDCG@3 for + `SampleQuery + `__: - Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), - P3 (0)] + * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) + = 1.13 * Ideal DCG@3: 1/log2(1+1) + + 1/log2(2+1) + 0/log2(3+1) = 1.63 - Calculate NDCG@3 for - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]: - \* DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 \* - Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 - \* NDCG@3: 1.13/1.63 = 0.693 + * NDCG@3: 1.13/1.63 = 0.693 """ class TopkMetrics(proto.Message): diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/evaluation_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/evaluation_service.py index 9f1f49fe4228..0b21d9c0312b 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/evaluation_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/evaluation_service.py @@ -38,23 +38,27 @@ class GetEvaluationRequest(proto.Message): r"""Request message for - [EvaluationService.GetEvaluation][google.cloud.discoveryengine.v1alpha.EvaluationService.GetEvaluation] + `EvaluationService.GetEvaluation + `__ method. Attributes: name (str): Required. Full resource name of - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation], + `Evaluation + `__, such as ``projects/{project}/locations/{location}/evaluations/{evaluation}``. - If the caller does not have permission to access the - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. + If the caller does not have permission to access + the `Evaluation + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. If the requested - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation] + `Evaluation + `__ does not exist, a NOT_FOUND error is returned. """ @@ -66,38 +70,48 @@ class GetEvaluationRequest(proto.Message): class ListEvaluationsRequest(proto.Message): r"""Request message for - [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluations] + `EvaluationService.ListEvaluations + `__ method. Attributes: parent (str): - Required. The parent location resource name, such as + Required. The parent location resource name, + such as ``projects/{project}/locations/{location}``. If the caller does not have permission to list - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s - under this location, regardless of whether or not this - location exists, a ``PERMISSION_DENIED`` error is returned. + `Evaluation + `__s + under this location, regardless of whether or + not this location exists, a + ``PERMISSION_DENIED`` error is returned. page_size (int): Maximum number of - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s - to return. If unspecified, defaults to 100. The maximum - allowed value is 1000. Values above 1000 will be coerced to - 1000. - - If this field is negative, an ``INVALID_ARGUMENT`` error is - returned. + `Evaluation + `__s + to return. If unspecified, defaults to 100. The + maximum allowed value is 1000. Values above 1000 + will be coerced to 1000. + + If this field is negative, an + ``INVALID_ARGUMENT`` error is returned. page_token (str): A page token - [ListEvaluationsResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListEvaluationsResponse.next_page_token], + `ListEvaluationsResponse.next_page_token + `__, received from a previous - [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluations] - call. Provide this to retrieve the subsequent page. - - When paginating, all other parameters provided to - [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluations] - must match the call that provided the page token. Otherwise, - an ``INVALID_ARGUMENT`` error is returned. + `EvaluationService.ListEvaluations + `__ + call. Provide this to retrieve the subsequent + page. + + When paginating, all other parameters provided + to `EvaluationService.ListEvaluations + `__ + must match the call that provided the page + token. Otherwise, an ``INVALID_ARGUMENT`` error + is returned. """ parent: str = proto.Field( @@ -116,18 +130,20 @@ class ListEvaluationsRequest(proto.Message): class ListEvaluationsResponse(proto.Message): r"""Response message for - [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluations] + `EvaluationService.ListEvaluations + `__ method. Attributes: evaluations (MutableSequence[google.cloud.discoveryengine_v1alpha.types.Evaluation]): - The - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s. + The `Evaluation + `__s. next_page_token (str): A token that can be sent as - [ListEvaluationsRequest.page_token][google.cloud.discoveryengine.v1alpha.ListEvaluationsRequest.page_token] - to retrieve the next page. If this field is omitted, there - are no subsequent pages. + `ListEvaluationsRequest.page_token + `__ + to retrieve the next page. If this field is + omitted, there are no subsequent pages. """ @property @@ -147,7 +163,8 @@ def raw_page(self): class CreateEvaluationRequest(proto.Message): r"""Request message for - [EvaluationService.CreateEvaluation][google.cloud.discoveryengine.v1alpha.EvaluationService.CreateEvaluation] + `EvaluationService.CreateEvaluation + `__ method. Attributes: @@ -155,8 +172,8 @@ class CreateEvaluationRequest(proto.Message): Required. The parent resource name, such as ``projects/{project}/locations/{location}``. evaluation (google.cloud.discoveryengine_v1alpha.types.Evaluation): - Required. The - [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation] + Required. The `Evaluation + `__ to create. """ @@ -173,7 +190,8 @@ class CreateEvaluationRequest(proto.Message): class CreateEvaluationMetadata(proto.Message): r"""Metadata for - [EvaluationService.CreateEvaluation][google.cloud.discoveryengine.v1alpha.EvaluationService.CreateEvaluation] + `EvaluationService.CreateEvaluation + `__ method. """ @@ -181,7 +199,8 @@ class CreateEvaluationMetadata(proto.Message): class ListEvaluationResultsRequest(proto.Message): r"""Request message for - [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluationResults] + `EvaluationService.ListEvaluationResults + `__ method. Attributes: @@ -190,27 +209,34 @@ class ListEvaluationResultsRequest(proto.Message): ``projects/{project}/locations/{location}/evaluations/{evaluation}``. If the caller does not have permission to list - [EvaluationResult][] under this evaluation, regardless of - whether or not this evaluation set exists, a - ``PERMISSION_DENIED`` error is returned. + [EvaluationResult][] under this evaluation, + regardless of whether or not this evaluation set + exists, a ``PERMISSION_DENIED`` error is + returned. page_size (int): - Maximum number of [EvaluationResult][] to return. If - unspecified, defaults to 100. The maximum allowed value is - 1000. Values above 1000 will be coerced to 1000. + Maximum number of [EvaluationResult][] to + return. If unspecified, defaults to 100. The + maximum allowed value is 1000. Values above 1000 + will be coerced to 1000. - If this field is negative, an ``INVALID_ARGUMENT`` error is - returned. + If this field is negative, an + ``INVALID_ARGUMENT`` error is returned. page_token (str): A page token - [ListEvaluationResultsResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListEvaluationResultsResponse.next_page_token], + `ListEvaluationResultsResponse.next_page_token + `__, received from a previous - [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluationResults] - call. Provide this to retrieve the subsequent page. - - When paginating, all other parameters provided to - [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluationResults] - must match the call that provided the page token. Otherwise, - an ``INVALID_ARGUMENT`` error is returned. + `EvaluationService.ListEvaluationResults + `__ + call. Provide this to retrieve the subsequent + page. + + When paginating, all other parameters provided + to `EvaluationService.ListEvaluationResults + `__ + must match the call that provided the page + token. Otherwise, an ``INVALID_ARGUMENT`` error + is returned. """ evaluation: str = proto.Field( @@ -229,33 +255,38 @@ class ListEvaluationResultsRequest(proto.Message): class ListEvaluationResultsResponse(proto.Message): r"""Response message for - [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluationResults] + `EvaluationService.ListEvaluationResults + `__ method. Attributes: evaluation_results (MutableSequence[google.cloud.discoveryengine_v1alpha.types.ListEvaluationResultsResponse.EvaluationResult]): The - [EvaluationResult][google.cloud.discoveryengine.v1alpha.ListEvaluationResultsResponse.EvaluationResult]s. + `EvaluationResult + `__s. next_page_token (str): A token that can be sent as - [ListEvaluationResultsRequest.page_token][google.cloud.discoveryengine.v1alpha.ListEvaluationResultsRequest.page_token] - to retrieve the next page. If this field is omitted, there - are no subsequent pages. + `ListEvaluationResultsRequest.page_token + `__ + to retrieve the next page. If this field is + omitted, there are no subsequent pages. """ class EvaluationResult(proto.Message): r"""Represents the results of an evaluation for a single - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]. + `SampleQuery + `__. Attributes: sample_query (google.cloud.discoveryengine_v1alpha.types.SampleQuery): Output only. The - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] + `SampleQuery + `__ that was evaluated. quality_metrics (google.cloud.discoveryengine_v1alpha.types.QualityMetrics): - Output only. The metrics produced by the evaluation, for a - given - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]. + Output only. The metrics produced by the + evaluation, for a given `SampleQuery + `__. """ sample_query: gcd_sample_query.SampleQuery = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/grounded_generation_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/grounded_generation_service.py index 9b8178e5fd55..6d7bc949ef53 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/grounded_generation_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/grounded_generation_service.py @@ -38,12 +38,13 @@ class CheckGroundingSpec(proto.Message): Attributes: citation_threshold (float): - The threshold (in [0,1]) used for determining whether a fact - must be cited for a claim in the answer candidate. Choosing - a higher threshold will lead to fewer but very strong - citations, while choosing a lower threshold may lead to more - but somewhat weaker citations. If unset, the threshold will - default to 0.6. + The threshold (in [0,1]) used for determining + whether a fact must be cited for a claim in the + answer candidate. Choosing a higher threshold + will lead to fewer but very strong citations, + while choosing a lower threshold may lead to + more but somewhat weaker citations. If unset, + the threshold will default to 0.6. This field is a member of `oneof`_ ``_citation_threshold``. """ @@ -57,12 +58,14 @@ class CheckGroundingSpec(proto.Message): class CheckGroundingRequest(proto.Message): r"""Request message for - [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1alpha.GroundedGenerationService.CheckGrounding] + `GroundedGenerationService.CheckGrounding + `__ method. Attributes: grounding_config (str): - Required. The resource name of the grounding config, such as + Required. The resource name of the grounding + config, such as ``projects/*/locations/global/groundingConfigs/default_grounding_config``. answer_candidate (str): Answer candidate to check. Can have a maximum @@ -73,26 +76,32 @@ class CheckGroundingRequest(proto.Message): grounding_spec (google.cloud.discoveryengine_v1alpha.types.CheckGroundingSpec): Configuration of the grounding check. user_labels (MutableMapping[str, str]): - The user labels applied to a resource must meet the - following requirements: - - - Each resource can have multiple labels, up to a maximum of - 64. - - Each label must be a key-value pair. - - Keys have a minimum length of 1 character and a maximum - length of 63 characters and cannot be empty. Values can be - empty and have a maximum length of 63 characters. - - Keys and values can contain only lowercase letters, - numeric characters, underscores, and dashes. All - characters must use UTF-8 encoding, and international - characters are allowed. - - The key portion of a label must be unique. However, you - can use the same key with multiple resources. - - Keys must start with a lowercase letter or international - character. + The user labels applied to a resource must meet + the following requirements: + * Each resource can have multiple labels, up to + a maximum of 64. + + * Each label must be a key-value pair. + * Keys have a minimum length of 1 character and + a maximum length of 63 characters and cannot + be empty. Values can be empty and have a maximum + length of 63 characters. + + * Keys and values can contain only lowercase + letters, numeric characters, underscores, and + dashes. All characters must use UTF-8 encoding, + and international characters are allowed. + + * The key portion of a label must be unique. + However, you can use the same key with + multiple resources. + + * Keys must start with a lowercase letter or + international character. See `Google Cloud - Document `__ + Document + `__ for more details. """ @@ -123,7 +132,8 @@ class CheckGroundingRequest(proto.Message): class CheckGroundingResponse(proto.Message): r"""Response message for the - [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1alpha.GroundedGenerationService.CheckGrounding] + `GroundedGenerationService.CheckGrounding + `__ method. @@ -168,21 +178,27 @@ class Claim(proto.Message): Always provided regardless of whether citations or anti-citations are found. citation_indices (MutableSequence[int]): - A list of indices (into 'cited_chunks') specifying the - citations associated with the claim. For instance [1,3,4] - means that cited_chunks[1], cited_chunks[3], cited_chunks[4] - are the facts cited supporting for the claim. A citation to - a fact indicates that the claim is supported by the fact. + A list of indices (into 'cited_chunks') + specifying the citations associated with the + claim. For instance [1,3,4] means that + cited_chunks[1], cited_chunks[3], + cited_chunks[4] are the facts cited supporting + for the claim. A citation to a fact indicates + that the claim is supported by the fact. grounding_check_required (bool): - Indicates that this claim required grounding check. When the - system decided this claim doesn't require - attribution/grounding check, this field will be set to - false. In that case, no grounding check was done for the - claim and therefore - [citation_indices][google.cloud.discoveryengine.v1alpha.CheckGroundingResponse.Claim.citation_indices], - [anti_citation_indices][google.cloud.discoveryengine.v1alpha.CheckGroundingResponse.Claim.anti_citation_indices], + Indicates that this claim required grounding + check. When the system decided this claim + doesn't require attribution/grounding check, + this field will be set to false. In that case, + no grounding check was done for the claim and + therefore + `citation_indices + `__, + `anti_citation_indices + `__, and - [score][google.cloud.discoveryengine.v1alpha.CheckGroundingResponse.Claim.score] + `score + `__ should not be returned. This field is a member of `oneof`_ ``_grounding_check_required``. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/grounding.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/grounding.py index 623c792cc652..f6944ecba357 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/grounding.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/grounding.py @@ -36,10 +36,10 @@ class GroundingFact(proto.Message): Text content of the fact. Can be at most 10K characters long. attributes (MutableMapping[str, str]): - Attributes associated with the fact. Common attributes - include ``source`` (indicating where the fact was sourced - from), ``author`` (indicating the author of the fact), and - so on. + Attributes associated with the fact. + Common attributes include ``source`` (indicating + where the fact was sourced from), ``author`` + (indicating the author of the fact), and so on. """ fact_text: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/import_config.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/import_config.py index abf627df7402..1bfc46af660f 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/import_config.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/import_config.py @@ -67,44 +67,56 @@ class GcsSource(proto.Message): Attributes: input_uris (MutableSequence[str]): - Required. Cloud Storage URIs to input files. Each URI can be - up to 2000 characters long. URIs can match the full object - path (for example, ``gs://bucket/directory/object.json``) or - a pattern matching one or more files, such as + Required. Cloud Storage URIs to input files. + Each URI can be up to 2000 characters long. URIs + can match the full object path (for example, + ``gs://bucket/directory/object.json``) or a + pattern matching one or more files, such as ``gs://bucket/directory/*.json``. - A request can contain at most 100 files (or 100,000 files if - ``data_schema`` is ``content``). Each file can be up to 2 GB - (or 100 MB if ``data_schema`` is ``content``). + A request can contain at most 100 files (or + 100,000 files if ``data_schema`` is + ``content``). Each file can be up to 2 GB (or + 100 MB if ``data_schema`` is ``content``). data_schema (str): - The schema to use when parsing the data from the source. - + The schema to use when parsing the data from the + source. Supported values for document imports: - - ``document`` (default): One JSON - [Document][google.cloud.discoveryengine.v1alpha.Document] - per line. Each document must have a valid - [Document.id][google.cloud.discoveryengine.v1alpha.Document.id]. - - ``content``: Unstructured data (e.g. PDF, HTML). Each file - matched by ``input_uris`` becomes a document, with the ID - set to the first 128 bits of SHA256(URI) encoded as a hex - string. - - ``custom``: One custom data JSON per row in arbitrary - format that conforms to the defined - [Schema][google.cloud.discoveryengine.v1alpha.Schema] of - the data store. This can only be used by the GENERIC Data - Store vertical. - - ``csv``: A CSV file with header conforming to the defined - [Schema][google.cloud.discoveryengine.v1alpha.Schema] of - the data store. Each entry after the header is imported as - a Document. This can only be used by the GENERIC Data - Store vertical. + * ``document`` (default): One JSON + `Document + `__ + per line. Each document must + have a valid + `Document.id + `__. + + * ``content``: Unstructured data (e.g. PDF, + HTML). Each file matched by ``input_uris`` + becomes a document, with the ID set to the first + 128 bits of SHA256(URI) encoded as a hex + string. + + * ``custom``: One custom data JSON per row in + arbitrary format that conforms to the defined + `Schema + `__ + of the data store. This can only be used by + the GENERIC Data Store vertical. + + * ``csv``: A CSV file with header conforming to + the defined `Schema + `__ + of the data store. Each entry after the header + is imported as a Document. This can only be + used by the GENERIC Data Store vertical. Supported values for user event imports: - - ``user_event`` (default): One JSON - [UserEvent][google.cloud.discoveryengine.v1alpha.UserEvent] - per line. + * ``user_event`` (default): One JSON + `UserEvent + `__ + per line. """ input_uris: MutableSequence[str] = proto.RepeatedField( @@ -124,8 +136,8 @@ class BigQuerySource(proto.Message): Attributes: partition_date (google.type.date_pb2.Date): - BigQuery time partitioned table's \_PARTITIONDATE in - YYYY-MM-DD format. + BigQuery time partitioned table's _PARTITIONDATE + in YYYY-MM-DD format. This field is a member of `oneof`_ ``partition``. project_id (str): @@ -147,29 +159,37 @@ class BigQuerySource(proto.Message): have the BigQuery export to a specific Cloud Storage directory. data_schema (str): - The schema to use when parsing the data from the source. - + The schema to use when parsing the data from the + source. Supported values for user event imports: - - ``user_event`` (default): One - [UserEvent][google.cloud.discoveryengine.v1alpha.UserEvent] - per row. + * ``user_event`` (default): One + `UserEvent + `__ + per row. Supported values for document imports: - - ``document`` (default): One - [Document][google.cloud.discoveryengine.v1alpha.Document] - format per row. Each document must have a valid - [Document.id][google.cloud.discoveryengine.v1alpha.Document.id] - and one of - [Document.json_data][google.cloud.discoveryengine.v1alpha.Document.json_data] - or - [Document.struct_data][google.cloud.discoveryengine.v1alpha.Document.struct_data]. - - ``custom``: One custom data per row in arbitrary format - that conforms to the defined - [Schema][google.cloud.discoveryengine.v1alpha.Schema] of - the data store. This can only be used by the GENERIC Data - Store vertical. + * ``document`` (default): One + `Document + `__ + format per row. Each document must have a + valid + `Document.id + `__ + and one of + `Document.json_data + `__ + or + `Document.struct_data + `__. + + * ``custom``: One custom data per row in + arbitrary format that conforms to the defined + `Schema + `__ + of the data store. This can only be used by + the GENERIC Data Store vertical. """ partition_date: date_pb2.Date = proto.Field( @@ -219,9 +239,10 @@ class SpannerSource(proto.Message): Required. The table name of the Spanner database that needs to be imported. enable_data_boost (bool): - Whether to apply data boost on Spanner export. Enabling this - option will incur additional cost. More info can be found - `here `__. + Whether to apply data boost on Spanner export. + Enabling this option will incur additional cost. + More info can be found `here + `__. """ project_id: str = proto.Field( @@ -252,9 +273,9 @@ class BigtableOptions(proto.Message): Attributes: key_field_name (str): - The field name used for saving row key value in the - document. The name has to match the pattern - ``[a-zA-Z0-9][a-zA-Z0-9-_]*``. + The field name used for saving row key value in + the document. The name has to match the pattern + ```a-zA-Z0-9 `__*``. families (MutableMapping[str, google.cloud.discoveryengine_v1alpha.types.BigtableOptions.BigtableColumnFamily]): The mapping from family names to an object that contains column families level information @@ -263,9 +284,11 @@ class BigtableOptions(proto.Message): """ class Type(proto.Enum): - r"""The type of values in a Bigtable column or column family. The values - are expected to be encoded using `HBase - Bytes.toBytes `__ + r"""The type of values in a Bigtable column or column family. + The values are expected to be encoded using + `HBase + Bytes.toBytes + `__ function when the encoding value is set to ``BINARY``. Values: @@ -315,25 +338,28 @@ class BigtableColumnFamily(proto.Message): Attributes: field_name (str): - The field name to use for this column family in the - document. The name has to match the pattern - ``[a-zA-Z0-9][a-zA-Z0-9-_]*``. If not set, it is parsed from - the family name with best effort. However, due to different - naming patterns, field name collisions could happen, where - parsing behavior is undefined. + The field name to use for this column family in + the document. The name has to match the pattern + ```a-zA-Z0-9 `__*``. If not set, it + is parsed from the family name with best effort. + However, due to different naming patterns, field + name collisions could happen, where parsing + behavior is undefined. encoding (google.cloud.discoveryengine_v1alpha.types.BigtableOptions.Encoding): - The encoding mode of the values when the type is not STRING. - Acceptable encoding values are: - - - ``TEXT``: indicates values are alphanumeric text strings. - - ``BINARY``: indicates values are encoded using - ``HBase Bytes.toBytes`` family of functions. This can be - overridden for a specific column by listing that column in - ``columns`` and specifying an encoding for it. + The encoding mode of the values when the type is + not STRING. Acceptable encoding values are: + + * ``TEXT``: indicates values are alphanumeric + text strings. * ``BINARY``: indicates values are + encoded using ``HBase Bytes.toBytes`` family of + functions. This can be overridden for a specific + column by listing that column in ``columns`` and + specifying an encoding for it. type_ (google.cloud.discoveryengine_v1alpha.types.BigtableOptions.Type): - The type of values in this column family. The values are - expected to be encoded using ``HBase Bytes.toBytes`` - function when the encoding value is set to ``BINARY``. + The type of values in this column family. + The values are expected to be encoded using + ``HBase Bytes.toBytes`` function when the + encoding value is set to ``BINARY``. columns (MutableSequence[google.cloud.discoveryengine_v1alpha.types.BigtableOptions.BigtableColumn]): The list of objects that contains column level information for each column. If a column @@ -371,25 +397,28 @@ class BigtableColumn(proto.Message): cannot be decoded with utf-8, use a base-64 encoded string instead. field_name (str): - The field name to use for this column in the document. The - name has to match the pattern ``[a-zA-Z0-9][a-zA-Z0-9-_]*``. - If not set, it is parsed from the qualifier bytes with best - effort. However, due to different naming patterns, field - name collisions could happen, where parsing behavior is - undefined. + The field name to use for this column in the + document. The name has to match the pattern + ```a-zA-Z0-9 `__*``. If not set, it + is parsed from the qualifier bytes with best + effort. However, due to different naming + patterns, field name collisions could happen, + where parsing behavior is undefined. encoding (google.cloud.discoveryengine_v1alpha.types.BigtableOptions.Encoding): - The encoding mode of the values when the type is not - ``STRING``. Acceptable encoding values are: - - - ``TEXT``: indicates values are alphanumeric text strings. - - ``BINARY``: indicates values are encoded using - ``HBase Bytes.toBytes`` family of functions. This can be - overridden for a specific column by listing that column in - ``columns`` and specifying an encoding for it. + The encoding mode of the values when the type is + not ``STRING``. Acceptable encoding values are: + + * ``TEXT``: indicates values are alphanumeric + text strings. * ``BINARY``: indicates values are + encoded using ``HBase Bytes.toBytes`` family of + functions. This can be overridden for a specific + column by listing that column in ``columns`` and + specifying an encoding for it. type_ (google.cloud.discoveryengine_v1alpha.types.BigtableOptions.Type): - The type of values in this column family. The values are - expected to be encoded using ``HBase Bytes.toBytes`` - function when the encoding value is set to ``BINARY``. + The type of values in this column family. + The values are expected to be encoded using + ``HBase Bytes.toBytes`` function when the + encoding value is set to ``BINARY``. """ qualifier: bytes = proto.Field( @@ -469,8 +498,8 @@ class FhirStoreSource(proto.Message): Attributes: fhir_store (str): - Required. The full resource name of the FHIR store to import - data from, in the format of + Required. The full resource name of the FHIR + store to import data from, in the format of ``projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}``. gcs_staging_dir (str): Intermediate Cloud Storage directory used for @@ -479,10 +508,12 @@ class FhirStoreSource(proto.Message): have the FhirStore export to a specific Cloud Storage directory. resource_types (MutableSequence[str]): - The FHIR resource types to import. The resource types should - be a subset of all `supported FHIR resource - types `__. - Default to all supported FHIR resource types if empty. + The FHIR resource types to import. The resource + types should be a subset of all `supported FHIR + resource types + `__. + Default to all supported FHIR resource types if + empty. """ fhir_store: str = proto.Field( @@ -528,9 +559,10 @@ class CloudSqlSource(proto.Message): the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. offload (bool): - Option for serverless export. Enabling this option will - incur additional cost. More info can be found - `here `__. + Option for serverless export. Enabling this + option will incur additional cost. More info can + be found `here + `__. """ project_id: str = proto.Field( @@ -671,10 +703,11 @@ class ImportErrorConfig(proto.Message): Attributes: gcs_prefix (str): - Cloud Storage prefix for import errors. This must be an - empty, existing Cloud Storage directory. Import errors are - written to sharded files in this directory, one per line, as - a JSON-encoded ``google.rpc.Status`` message. + Cloud Storage prefix for import errors. This + must be an empty, existing Cloud Storage + directory. Import errors are written to sharded + files in this directory, one per line, as a + JSON-encoded ``google.rpc.Status`` message. This field is a member of `oneof`_ ``destination``. """ @@ -711,7 +744,8 @@ class ImportUserEventsRequest(proto.Message): This field is a member of `oneof`_ ``source``. parent (str): - Required. Parent DataStore resource name, of the form + Required. Parent DataStore resource name, of the + form ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`` error_config (google.cloud.discoveryengine_v1alpha.types.ImportErrorConfig): The desired location of errors incurred @@ -939,92 +973,126 @@ class ImportDocumentsRequest(proto.Message): This field is a member of `oneof`_ ``source``. parent (str): - Required. The parent branch resource name, such as + Required. The parent branch resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. Requires create/update permission. error_config (google.cloud.discoveryengine_v1alpha.types.ImportErrorConfig): The desired location of errors incurred during the Import. reconciliation_mode (google.cloud.discoveryengine_v1alpha.types.ImportDocumentsRequest.ReconciliationMode): - The mode of reconciliation between existing documents and - the documents to be imported. Defaults to - [ReconciliationMode.INCREMENTAL][google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL]. + The mode of reconciliation between existing + documents and the documents to be imported. + Defaults to `ReconciliationMode.INCREMENTAL + `__. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields. auto_generate_ids (bool): - Whether to automatically generate IDs for the documents if - absent. - + Whether to automatically generate IDs for the + documents if absent. If set to ``true``, - [Document.id][google.cloud.discoveryengine.v1alpha.Document.id]s - are automatically generated based on the hash of the - payload, where IDs may not be consistent during multiple - imports. In which case - [ReconciliationMode.FULL][google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.ReconciliationMode.FULL] - is highly recommended to avoid duplicate contents. If unset - or set to ``false``, - [Document.id][google.cloud.discoveryengine.v1alpha.Document.id]s + `Document.id + `__s + are automatically generated based on the hash of + the payload, where IDs may not be consistent + during multiple imports. In which case + `ReconciliationMode.FULL + `__ + is highly recommended to avoid duplicate + contents. If unset or set to ``false``, + `Document.id + `__s have to be specified using - [id_field][google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.id_field], - otherwise, documents without IDs fail to be imported. + `id_field + `__, + otherwise, documents without IDs fail to be + imported. Supported data sources: - - [GcsSource][google.cloud.discoveryengine.v1alpha.GcsSource]. - [GcsSource.data_schema][google.cloud.discoveryengine.v1alpha.GcsSource.data_schema] - must be ``custom`` or ``csv``. Otherwise, an - INVALID_ARGUMENT error is thrown. - - [BigQuerySource][google.cloud.discoveryengine.v1alpha.BigQuerySource]. - [BigQuerySource.data_schema][google.cloud.discoveryengine.v1alpha.BigQuerySource.data_schema] - must be ``custom`` or ``csv``. Otherwise, an - INVALID_ARGUMENT error is thrown. - - [SpannerSource][google.cloud.discoveryengine.v1alpha.SpannerSource]. - - [CloudSqlSource][google.cloud.discoveryengine.v1alpha.CloudSqlSource]. - - [FirestoreSource][google.cloud.discoveryengine.v1alpha.FirestoreSource]. - - [BigtableSource][google.cloud.discoveryengine.v1alpha.BigtableSource]. + * `GcsSource + `__. + `GcsSource.data_schema + `__ + must be ``custom`` or ``csv``. Otherwise, an + INVALID_ARGUMENT error is thrown. + + * `BigQuerySource + `__. + `BigQuerySource.data_schema + `__ + must be ``custom`` or ``csv``. Otherwise, an + INVALID_ARGUMENT error is thrown. + + * `SpannerSource + `__. + * `CloudSqlSource + `__. + + * `FirestoreSource + `__. + * `BigtableSource + `__. id_field (str): - The field indicates the ID field or column to be used as - unique IDs of the documents. - - For - [GcsSource][google.cloud.discoveryengine.v1alpha.GcsSource] - it is the key of the JSON field. For instance, ``my_id`` for - JSON ``{"my_id": "some_uuid"}``. For others, it may be the - column name of the table where the unique ids are stored. - - The values of the JSON field or the table column are used as - the - [Document.id][google.cloud.discoveryengine.v1alpha.Document.id]s. - The JSON field or the table column must be of string type, - and the values must be set as valid strings conform to - `RFC-1034 `__ with 1-63 - characters. Otherwise, documents without valid IDs fail to - be imported. + The field indicates the ID field or column to be + used as unique IDs of the documents. + + For `GcsSource + `__ + it is the key of the JSON field. For instance, + ``my_id`` for JSON ``{"my_id": + + "some_uuid"}``. For others, it may be the column + name of the table where the unique ids are + stored. + + The values of the JSON field or the table column + are used as the `Document.id + `__s. + The JSON field or the table column must be of + string type, and the values must be set as valid + strings conform to + `RFC-1034 + `__ with + 1-63 characters. Otherwise, documents without + valid IDs fail to be imported. Only set this field when - [auto_generate_ids][google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.auto_generate_ids] - is unset or set as ``false``. Otherwise, an INVALID_ARGUMENT - error is thrown. + `auto_generate_ids + `__ + is unset or set as ``false``. Otherwise, an + INVALID_ARGUMENT error is thrown. - If it is unset, a default value ``_id`` is used when - importing from the allowed data sources. + If it is unset, a default value ``_id`` is used + when importing from the allowed data sources. Supported data sources: - - [GcsSource][google.cloud.discoveryengine.v1alpha.GcsSource]. - [GcsSource.data_schema][google.cloud.discoveryengine.v1alpha.GcsSource.data_schema] - must be ``custom`` or ``csv``. Otherwise, an - INVALID_ARGUMENT error is thrown. - - [BigQuerySource][google.cloud.discoveryengine.v1alpha.BigQuerySource]. - [BigQuerySource.data_schema][google.cloud.discoveryengine.v1alpha.BigQuerySource.data_schema] - must be ``custom`` or ``csv``. Otherwise, an - INVALID_ARGUMENT error is thrown. - - [SpannerSource][google.cloud.discoveryengine.v1alpha.SpannerSource]. - - [CloudSqlSource][google.cloud.discoveryengine.v1alpha.CloudSqlSource]. - - [FirestoreSource][google.cloud.discoveryengine.v1alpha.FirestoreSource]. - - [BigtableSource][google.cloud.discoveryengine.v1alpha.BigtableSource]. + * `GcsSource + `__. + `GcsSource.data_schema + `__ + must be ``custom`` or ``csv``. Otherwise, an + INVALID_ARGUMENT error is thrown. + + * `BigQuerySource + `__. + `BigQuerySource.data_schema + `__ + must be ``custom`` or ``csv``. Otherwise, an + INVALID_ARGUMENT error is thrown. + + * `SpannerSource + `__. + * `CloudSqlSource + `__. + + * `FirestoreSource + `__. + * `BigtableSource + `__. """ class ReconciliationMode(proto.Enum): @@ -1053,9 +1121,9 @@ class InlineSource(proto.Message): Attributes: documents (MutableSequence[google.cloud.discoveryengine_v1alpha.types.Document]): - Required. A list of documents to update/create. Each - document must have a valid - [Document.id][google.cloud.discoveryengine.v1alpha.Document.id]. + Required. A list of documents to update/create. + Each document must have a valid `Document.id + `__. Recommended max of 100 items. """ @@ -1150,10 +1218,11 @@ class InlineSource(proto.Message): class ImportDocumentsResponse(proto.Message): r"""Response of the - [ImportDocumentsRequest][google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest]. - If the long running operation is done, then this message is returned - by the google.longrunning.Operations.response field if the operation - was successful. + `ImportDocumentsRequest + `__. + If the long running operation is done, then this message is + returned by the google.longrunning.Operations.response field if + the operation was successful. Attributes: error_samples (MutableSequence[google.rpc.status_pb2.Status]): @@ -1178,7 +1247,8 @@ class ImportDocumentsResponse(proto.Message): class ImportSuggestionDenyListEntriesRequest(proto.Message): r"""Request message for - [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.ImportSuggestionDenyListEntries] + `CompletionService.ImportSuggestionDenyListEntries + `__ method. This message has `oneof`_ fields (mutually exclusive fields). @@ -1197,17 +1267,19 @@ class ImportSuggestionDenyListEntriesRequest(proto.Message): gcs_source (google.cloud.discoveryengine_v1alpha.types.GcsSource): Cloud Storage location for the input content. - Only 1 file can be specified that contains all entries to - import. Supported values ``gcs_source.schema`` for - autocomplete suggestion deny list entry imports: + Only 1 file can be specified that contains all + entries to import. Supported values + ``gcs_source.schema`` for autocomplete + suggestion deny list entry imports: - - ``suggestion_deny_list`` (default): One JSON - [SuggestionDenyListEntry] per line. + * ``suggestion_deny_list`` (default): One JSON + [SuggestionDenyListEntry] per line. This field is a member of `oneof`_ ``source``. parent (str): - Required. The parent data store resource name for which to - import denylist entries. Follows pattern + Required. The parent data store resource name + for which to import denylist entries. Follows + pattern projects/*/locations/*/collections/*/dataStores/*. """ @@ -1248,7 +1320,8 @@ class InlineSource(proto.Message): class ImportSuggestionDenyListEntriesResponse(proto.Message): r"""Response message for - [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.ImportSuggestionDenyListEntries] + `CompletionService.ImportSuggestionDenyListEntries + `__ method. Attributes: @@ -1305,7 +1378,8 @@ class ImportSuggestionDenyListEntriesMetadata(proto.Message): class ImportCompletionSuggestionsRequest(proto.Message): r"""Request message for - [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.ImportCompletionSuggestions] + `CompletionService.ImportCompletionSuggestions + `__ method. This message has `oneof`_ fields (mutually exclusive fields). @@ -1329,8 +1403,9 @@ class ImportCompletionSuggestionsRequest(proto.Message): This field is a member of `oneof`_ ``source``. parent (str): - Required. The parent data store resource name for which to - import customer autocomplete suggestions. + Required. The parent data store resource name + for which to import customer autocomplete + suggestions. Follows pattern ``projects/*/locations/*/collections/*/dataStores/*`` @@ -1387,10 +1462,11 @@ class InlineSource(proto.Message): class ImportCompletionSuggestionsResponse(proto.Message): r"""Response of the - [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.ImportCompletionSuggestions] + `CompletionService.ImportCompletionSuggestions + `__ method. If the long running operation is done, this message is - returned by the google.longrunning.Operations.response field if the - operation is successful. + returned by the google.longrunning.Operations.response field if + the operation is successful. Attributes: error_samples (MutableSequence[google.rpc.status_pb2.Status]): @@ -1426,11 +1502,13 @@ class ImportCompletionSuggestionsMetadata(proto.Message): is done, this is also the finish time. success_count (int): Count of - [CompletionSuggestion][google.cloud.discoveryengine.v1alpha.CompletionSuggestion]s + `CompletionSuggestion + `__s successfully imported. failure_count (int): Count of - [CompletionSuggestion][google.cloud.discoveryengine.v1alpha.CompletionSuggestion]s + `CompletionSuggestion + `__s that failed to be imported. """ @@ -1456,7 +1534,8 @@ class ImportCompletionSuggestionsMetadata(proto.Message): class ImportSampleQueriesRequest(proto.Message): r"""Request message for - [SampleQueryService.ImportSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ImportSampleQueries] + `SampleQueryService.ImportSampleQueries + `__ method. This message has `oneof`_ fields (mutually exclusive fields). @@ -1480,14 +1559,16 @@ class ImportSampleQueriesRequest(proto.Message): This field is a member of `oneof`_ ``source``. parent (str): - Required. The parent sample query set resource name, such as + Required. The parent sample query set resource + name, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}``. If the caller does not have permission to list - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s - under this sample query set, regardless of whether or not - this sample query set exists, a ``PERMISSION_DENIED`` error - is returned. + `SampleQuery + `__s + under this sample query set, regardless of + whether or not this sample query set exists, a + ``PERMISSION_DENIED`` error is returned. error_config (google.cloud.discoveryengine_v1alpha.types.ImportErrorConfig): The desired location of errors incurred during the Import. @@ -1495,12 +1576,14 @@ class ImportSampleQueriesRequest(proto.Message): class InlineSource(proto.Message): r"""The inline source for - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s. + `SampleQuery + `__s. Attributes: sample_queries (MutableSequence[google.cloud.discoveryengine_v1alpha.types.SampleQuery]): Required. A list of - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s + `SampleQuery + `__s to import. Max of 1000 items. """ @@ -1541,10 +1624,11 @@ class InlineSource(proto.Message): class ImportSampleQueriesResponse(proto.Message): r"""Response of the - [SampleQueryService.ImportSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ImportSampleQueries] + `SampleQueryService.ImportSampleQueries + `__ method. If the long running operation is done, this message is - returned by the google.longrunning.Operations.response field if the - operation is successful. + returned by the google.longrunning.Operations.response field if + the operation is successful. Attributes: error_samples (MutableSequence[google.rpc.status_pb2.Status]): @@ -1580,16 +1664,17 @@ class ImportSampleQueriesMetadata(proto.Message): time. If the operation is done, this is also the finish time. success_count (int): - Count of - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s + Count of `SampleQuery + `__s successfully imported. failure_count (int): - Count of - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s + Count of `SampleQuery + `__s that failed to be imported. total_count (int): Total count of - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s + `SampleQuery + `__s that were processed. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/project.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/project.py index 4fbc542736c7..6d6dfbc5402a 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/project.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/project.py @@ -34,10 +34,11 @@ class Project(proto.Message): Attributes: name (str): - Output only. Full resource name of the project, for example - ``projects/{project_number}``. Note that when making - requests, project number and project id are both acceptable, - but the server will always respond in project number. + Output only. Full resource name of the project, + for example ``projects/{project_number}``. + Note that when making requests, project number + and project id are both acceptable, but the + server will always respond in project number. create_time (google.protobuf.timestamp_pb2.Timestamp): Output only. The timestamp when this project is created. @@ -47,9 +48,9 @@ class Project(proto.Message): this project is still provisioning and is not ready for use. service_terms_map (MutableMapping[str, google.cloud.discoveryengine_v1alpha.types.Project.ServiceTerms]): - Output only. A map of terms of services. The key is the - ``id`` of - [ServiceTerms][google.cloud.discoveryengine.v1alpha.Project.ServiceTerms]. + Output only. A map of terms of services. The key + is the ``id`` of `ServiceTerms + `__. """ class ServiceTerms(proto.Message): @@ -57,18 +58,21 @@ class ServiceTerms(proto.Message): Attributes: id (str): - The unique identifier of this terms of service. Available - terms: + The unique identifier of this terms of service. + Available terms: - - ``GA_DATA_USE_TERMS``: `Terms for data - use `__. - When using this as ``id``, the acceptable - [version][google.cloud.discoveryengine.v1alpha.Project.ServiceTerms.version] - to provide is ``2022-11-23``. + * ``GA_DATA_USE_TERMS``: `Terms for data + use + `__. + When using this as ``id``, the acceptable + `version + `__ + to provide is ``2022-11-23``. version (str): - The version string of the terms of service. For acceptable - values, see the comments for - [id][google.cloud.discoveryengine.v1alpha.Project.ServiceTerms.id] + The version string of the terms of service. + For acceptable values, see the comments for + `id + `__ above. state (google.cloud.discoveryengine_v1alpha.types.Project.ServiceTerms.State): Whether the project has accepted/rejected the diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/project_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/project_service.py index 1b8fe4e3315b..15f667615dd1 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/project_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/project_service.py @@ -32,13 +32,15 @@ class GetProjectRequest(proto.Message): r"""Request message for - [ProjectService.GetProject][google.cloud.discoveryengine.v1alpha.ProjectService.GetProject] + `ProjectService.GetProject + `__ method. Attributes: name (str): Required. Full resource name of a - [Project][google.cloud.discoveryengine.v1alpha.Project], + `Project + `__, such as ``projects/{project_id_or_number}``. """ @@ -50,25 +52,30 @@ class GetProjectRequest(proto.Message): class ProvisionProjectRequest(proto.Message): r"""Request for - [ProjectService.ProvisionProject][google.cloud.discoveryengine.v1alpha.ProjectService.ProvisionProject] + `ProjectService.ProvisionProject + `__ method. Attributes: name (str): Required. Full resource name of a - [Project][google.cloud.discoveryengine.v1alpha.Project], + `Project + `__, such as ``projects/{project_id_or_number}``. accept_data_use_terms (bool): - Required. Set to ``true`` to specify that caller has read - and would like to give consent to the `Terms for data - use `__. + Required. Set to ``true`` to specify that caller + has read and would like to give consent to the + `Terms for data use + `__. data_use_terms_version (str): Required. The version of the `Terms for data - use `__ that - caller has read and would like to give consent to. + use + `__ + that caller has read and would like to give + consent to. - Acceptable version is ``2022-11-23``, and this may change - over time. + Acceptable version is ``2022-11-23``, and this + may change over time. """ name: str = proto.Field( @@ -99,17 +106,20 @@ class ReportConsentChangeRequest(proto.Message): At this moment, only accept action is supported. project (str): Required. Full resource name of a - [Project][google.cloud.discoveryengine.v1alpha.Project], + `Project + `__, such as ``projects/{project_id_or_number}``. service_term_id (str): - Required. The unique identifier of the terms of service to - update. Available term ids: - - - ``GA_DATA_USE_TERMS``: `Terms for data - use `__. - When using this service term id, the acceptable - [service_term_version][google.cloud.discoveryengine.v1alpha.ReportConsentChangeRequest.service_term_version] - to provide is ``2022-11-23``. + Required. The unique identifier of the terms of + service to update. Available term ids: + + * ``GA_DATA_USE_TERMS``: `Terms for data + use + `__. + When using this service term id, the acceptable + `service_term_version + `__ + to provide is ``2022-11-23``. service_term_version (str): Required. The version string of the terms of service to update. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/purge_config.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/purge_config.py index f7c0e7ac2f29..9fc134596445 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/purge_config.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/purge_config.py @@ -48,39 +48,59 @@ class PurgeUserEventsRequest(proto.Message): Attributes: parent (str): - Required. The resource name of the catalog under which the - events are created. The format is + Required. The resource name of the catalog under + which the events are created. The format is ``projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`` filter (str): - Required. The filter string to specify the events to be - deleted with a length limit of 5,000 characters. The - eligible fields for filtering are: - - - ``eventType``: Double quoted - [UserEvent.event_type][google.cloud.discoveryengine.v1alpha.UserEvent.event_type] - string. - - ``eventTime``: in ISO 8601 "zulu" format. - - ``userPseudoId``: Double quoted string. Specifying this - will delete all events associated with a visitor. - - ``userId``: Double quoted string. Specifying this will - delete all events associated with a user. + Required. The filter string to specify the + events to be deleted with a length limit of + 5,000 characters. The eligible fields for + filtering are: + + * ``eventType``: Double quoted + `UserEvent.event_type + `__ + string. + + * ``eventTime``: in ISO 8601 "zulu" format. + * ``userPseudoId``: Double quoted string. + Specifying this will delete all events + associated with a visitor. + + * ``userId``: Double quoted string. Specifying + this will delete all events associated with a + user. Examples: - - Deleting all events in a time range: - ``eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"`` - - Deleting specific eventType: ``eventType = "search"`` - - Deleting all events for a specific visitor: + * Deleting all events in a time range: + + ``eventTime > "2012-04-23T18:25:43.511Z" + eventTime < "2012-04-23T18:30:43.511Z"`` + + * Deleting specific eventType: + + ``eventType = "search"`` + + * Deleting all events for a specific visitor: + ``userPseudoId = "visitor1024"`` - - Deleting all events inside a DataStore: ``*`` - The filtering fields are assumed to have an implicit AND. + * Deleting all events inside a DataStore: + + ``*`` + + The filtering fields are assumed to have an + implicit AND. force (bool): - The ``force`` field is currently not supported. Purge user - event requests will permanently delete all purgeable events. - Once the development is complete: If ``force`` is set to - false, the method will return the expected purge count - without deleting any user events. This field will default to + The ``force`` field is currently not supported. + Purge user event requests will permanently + delete all purgeable events. Once the + development is complete: + + If ``force`` is set to false, the method will + return the expected purge count without deleting + any user events. This field will default to false if not included in the request. """ @@ -161,10 +181,11 @@ class PurgeErrorConfig(proto.Message): Attributes: gcs_prefix (str): - Cloud Storage prefix for purge errors. This must be an - empty, existing Cloud Storage directory. Purge errors are - written to sharded files in this directory, one per line, as - a JSON-encoded ``google.rpc.Status`` message. + Cloud Storage prefix for purge errors. This must + be an empty, existing Cloud Storage directory. + Purge errors are written to sharded files in + this directory, one per line, as a JSON-encoded + ``google.rpc.Status`` message. This field is a member of `oneof`_ ``destination``. """ @@ -178,7 +199,8 @@ class PurgeErrorConfig(proto.Message): class PurgeDocumentsRequest(proto.Message): r"""Request message for - [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.PurgeDocuments] + `DocumentService.PurgeDocuments + `__ method. This message has `oneof`_ fields (mutually exclusive fields). @@ -190,12 +212,13 @@ class PurgeDocumentsRequest(proto.Message): Attributes: gcs_source (google.cloud.discoveryengine_v1alpha.types.GcsSource): - Cloud Storage location for the input content. Supported - ``data_schema``: + Cloud Storage location for the input content. + Supported ``data_schema``: - - ``document_id``: One valid - [Document.id][google.cloud.discoveryengine.v1alpha.Document.id] - per line. + * ``document_id``: One valid + `Document.id + `__ + per line. This field is a member of `oneof`_ ``source``. inline_source (google.cloud.discoveryengine_v1alpha.types.PurgeDocumentsRequest.InlineSource): @@ -207,26 +230,28 @@ class PurgeDocumentsRequest(proto.Message): Required. The parent resource name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. filter (str): - Required. Filter matching documents to purge. Only currently - supported value is ``*`` (all items). + Required. Filter matching documents to purge. + Only currently supported value is + ``*`` (all items). error_config (google.cloud.discoveryengine_v1alpha.types.PurgeErrorConfig): The desired location of errors incurred during the purge. force (bool): - Actually performs the purge. If ``force`` is set to false, - return the expected purge count without deleting any - documents. + Actually performs the purge. If ``force`` is set + to false, return the expected purge count + without deleting any documents. """ class InlineSource(proto.Message): r"""The inline source for the input config for - [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.PurgeDocuments] + `DocumentService.PurgeDocuments + `__ method. Attributes: documents (MutableSequence[str]): - Required. A list of full resource name of documents to - purge. In the format + Required. A list of full resource name of + documents to purge. In the format ``projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*``. Recommended max of 100 items. """ @@ -269,7 +294,8 @@ class InlineSource(proto.Message): class PurgeDocumentsResponse(proto.Message): r"""Response message for - [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.PurgeDocuments] + `DocumentService.PurgeDocuments + `__ method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field. @@ -279,9 +305,10 @@ class PurgeDocumentsResponse(proto.Message): The total count of documents purged as a result of the operation. purge_sample (MutableSequence[str]): - A sample of document names that will be deleted. Only - populated if ``force`` is set to false. A max of 100 names - will be returned and the names are chosen at random. + A sample of document names that will be deleted. + Only populated if ``force`` is set to false. A + max of 100 names will be returned and the names + are chosen at random. """ purge_count: int = proto.Field( @@ -342,13 +369,15 @@ class PurgeDocumentsMetadata(proto.Message): class PurgeSuggestionDenyListEntriesRequest(proto.Message): r"""Request message for - [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.PurgeSuggestionDenyListEntries] + `CompletionService.PurgeSuggestionDenyListEntries + `__ method. Attributes: parent (str): - Required. The parent data store resource name for which to - import denylist entries. Follows pattern + Required. The parent data store resource name + for which to import denylist entries. Follows + pattern projects/*/locations/*/collections/*/dataStores/*. """ @@ -360,7 +389,8 @@ class PurgeSuggestionDenyListEntriesRequest(proto.Message): class PurgeSuggestionDenyListEntriesResponse(proto.Message): r"""Response message for - [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1alpha.CompletionService.PurgeSuggestionDenyListEntries] + `CompletionService.PurgeSuggestionDenyListEntries + `__ method. Attributes: @@ -410,13 +440,15 @@ class PurgeSuggestionDenyListEntriesMetadata(proto.Message): class PurgeCompletionSuggestionsRequest(proto.Message): r"""Request message for - [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.PurgeCompletionSuggestions] + `CompletionService.PurgeCompletionSuggestions + `__ method. Attributes: parent (str): - Required. The parent data store resource name for which to - purge completion suggestions. Follows pattern + Required. The parent data store resource name + for which to purge completion suggestions. + Follows pattern projects/*/locations/*/collections/*/dataStores/*. """ @@ -428,7 +460,8 @@ class PurgeCompletionSuggestionsRequest(proto.Message): class PurgeCompletionSuggestionsResponse(proto.Message): r"""Response message for - [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.PurgeCompletionSuggestions] + `CompletionService.PurgeCompletionSuggestions + `__ method. Attributes: diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/rank_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/rank_service.py index 10344f5ca79f..63ad582f49a7 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/rank_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/rank_service.py @@ -31,24 +31,31 @@ class RankingRecord(proto.Message): r"""Record message for - [RankService.Rank][google.cloud.discoveryengine.v1alpha.RankService.Rank] + `RankService.Rank + `__ method. Attributes: id (str): The unique ID to represent the record. title (str): - The title of the record. Empty by default. At least one of - [title][google.cloud.discoveryengine.v1alpha.RankingRecord.title] - or - [content][google.cloud.discoveryengine.v1alpha.RankingRecord.content] - should be set otherwise an INVALID_ARGUMENT error is thrown. + The title of the record. Empty by default. + At least one of + `title + `__ + or `content + `__ + should be set otherwise an INVALID_ARGUMENT + error is thrown. content (str): - The content of the record. Empty by default. At least one of - [title][google.cloud.discoveryengine.v1alpha.RankingRecord.title] - or - [content][google.cloud.discoveryengine.v1alpha.RankingRecord.content] - should be set otherwise an INVALID_ARGUMENT error is thrown. + The content of the record. Empty by default. + At least one of + `title + `__ + or `content + `__ + should be set otherwise an INVALID_ARGUMENT + error is thrown. score (float): The score of this record based on the given query and selected model. @@ -74,22 +81,23 @@ class RankingRecord(proto.Message): class RankRequest(proto.Message): r"""Request message for - [RankService.Rank][google.cloud.discoveryengine.v1alpha.RankService.Rank] + `RankService.Rank + `__ method. Attributes: ranking_config (str): - Required. The resource name of the rank service config, such - as + Required. The resource name of the rank service + config, such as ``projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config``. model (str): - The identifier of the model to use. It is one of: + The identifier of the model to use. It is one + of: + * ``semantic-ranker-512@latest``: Semantic + ranking model with maxiumn input token size 512. - - ``semantic-ranker-512@latest``: Semantic ranking model - with maxiumn input token size 512. - - It is set to ``semantic-ranker-512@latest`` by default if - unspecified. + It is set to ``semantic-ranker-512@latest`` by + default if unspecified. top_n (int): The number of results to return. If this is unset or no bigger than zero, returns all @@ -104,26 +112,32 @@ class RankRequest(proto.Message): record ID and score. By default, it is false, the response will contain record details. user_labels (MutableMapping[str, str]): - The user labels applied to a resource must meet the - following requirements: - - - Each resource can have multiple labels, up to a maximum of - 64. - - Each label must be a key-value pair. - - Keys have a minimum length of 1 character and a maximum - length of 63 characters and cannot be empty. Values can be - empty and have a maximum length of 63 characters. - - Keys and values can contain only lowercase letters, - numeric characters, underscores, and dashes. All - characters must use UTF-8 encoding, and international - characters are allowed. - - The key portion of a label must be unique. However, you - can use the same key with multiple resources. - - Keys must start with a lowercase letter or international - character. + The user labels applied to a resource must meet + the following requirements: + * Each resource can have multiple labels, up to + a maximum of 64. + + * Each label must be a key-value pair. + * Keys have a minimum length of 1 character and + a maximum length of 63 characters and cannot + be empty. Values can be empty and have a maximum + length of 63 characters. + + * Keys and values can contain only lowercase + letters, numeric characters, underscores, and + dashes. All characters must use UTF-8 encoding, + and international characters are allowed. + + * The key portion of a label must be unique. + However, you can use the same key with + multiple resources. + + * Keys must start with a lowercase letter or + international character. See `Google Cloud - Document `__ + Document + `__ for more details. """ @@ -161,7 +175,8 @@ class RankRequest(proto.Message): class RankResponse(proto.Message): r"""Response message for - [RankService.Rank][google.cloud.discoveryengine.v1alpha.RankService.Rank] + `RankService.Rank + `__ method. Attributes: diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/recommendation_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/recommendation_service.py index db06b8c5820a..9b70a8da62c1 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/recommendation_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/recommendation_service.py @@ -38,38 +38,48 @@ class RecommendRequest(proto.Message): Attributes: serving_config (str): Required. Full resource name of a - [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig]: + `ServingConfig + `__: + ``projects/*/locations/global/collections/*/engines/*/servingConfigs/*``, or ``projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`` - One default serving config is created along with your - recommendation engine creation. The engine ID is used as the - ID of the default serving config. For example, for Engine + One default serving config is created along with + your recommendation engine creation. The engine + ID is used as the ID of the default serving + config. For example, for Engine ``projects/*/locations/global/collections/*/engines/my-engine``, you can use ``projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`` for your - [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend] + `RecommendationService.Recommend + `__ requests. user_event (google.cloud.discoveryengine_v1alpha.types.UserEvent): - Required. Context about the user, what they are looking at - and what action they took to trigger the Recommend request. - Note that this user event detail won't be ingested to - userEvent logs. Thus, a separate userEvent write request is + Required. Context about the user, what they are + looking at and what action they took to trigger + the Recommend request. Note that this user event + detail won't be ingested to userEvent logs. + Thus, a separate userEvent write request is required for event logging. Don't set - [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1alpha.UserEvent.user_pseudo_id] + `UserEvent.user_pseudo_id + `__ or - [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1alpha.UserInfo.user_id] - to the same fixed ID for different users. If you are trying - to receive non-personalized recommendations (not - recommended; this can negatively impact model performance), - instead set - [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1alpha.UserEvent.user_pseudo_id] + `UserEvent.user_info.user_id + `__ + to the same fixed ID for different users. If you + are trying to receive non-personalized + recommendations (not recommended; this can + negatively impact model performance), instead + set + `UserEvent.user_pseudo_id + `__ to a random unique ID and leave - [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1alpha.UserInfo.user_id] + `UserEvent.user_info.user_id + `__ unset. page_size (int): Maximum number of results to return. Set this @@ -78,95 +88,120 @@ class RecommendRequest(proto.Message): reasonable default. The maximum allowed value is 100. Values above 100 are set to 100. filter (str): - Filter for restricting recommendation results with a length - limit of 5,000 characters. Currently, only filter - expressions on the ``filter_tags`` attribute is supported. + Filter for restricting recommendation results + with a length limit of 5,000 characters. + Currently, only filter expressions on the + ``filter_tags`` attribute is supported. Examples: - - ``(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))`` - - ``(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))`` - - If ``attributeFilteringSyntax`` is set to true under the - ``params`` field, then attribute-based expressions are - expected instead of the above described tag-based syntax. - Examples: - - - (launguage: ANY("en", "es")) AND NOT (categories: - ANY("Movie")) - - (available: true) AND (launguage: ANY("en", "es")) OR - (categories: ANY("Movie")) - - If your filter blocks all results, the API returns generic - (unfiltered) popular Documents. If you only want results - strictly matching the filters, set ``strictFiltering`` to - ``true`` in - [RecommendRequest.params][google.cloud.discoveryengine.v1alpha.RecommendRequest.params] + * ``(filter_tags: ANY("Red", "Blue") OR + filter_tags: ANY("Hot", "Cold"))`` * + ``(filter_tags: ANY("Red", "Blue")) AND NOT + (filter_tags: ANY("Green"))`` + + If ``attributeFilteringSyntax`` is set to true + under the ``params`` field, then attribute-based + expressions are expected instead of the above + described tag-based syntax. Examples: + + * (launguage: ANY("en", "es")) AND NOT + (categories: ANY("Movie")) * (available: true) + AND + (launguage: ANY("en", "es")) OR (categories: + ANY("Movie")) + + If your filter blocks all results, the API + returns generic (unfiltered) popular Documents. + If you only want results strictly matching the + filters, set ``strictFiltering`` to ``true`` in + `RecommendRequest.params + `__ to receive empty results instead. Note that the API never returns - [Document][google.cloud.discoveryengine.v1alpha.Document]s - with ``storageStatus`` as ``EXPIRED`` or ``DELETED`` - regardless of filter choices. + `Document + `__s + with ``storageStatus`` as ``EXPIRED`` or + ``DELETED`` regardless of filter choices. validate_only (bool): - Use validate only mode for this recommendation query. If set - to ``true``, a fake model is used that returns arbitrary - Document IDs. Note that the validate only mode should only - be used for testing the API, or if the model is not ready. + Use validate only mode for this recommendation + query. If set to ``true``, a fake model is used + that returns arbitrary Document IDs. Note that + the validate only mode should only be used for + testing the API, or if the model is not ready. params (MutableMapping[str, google.protobuf.struct_pb2.Value]): Additional domain specific parameters for the recommendations. - Allowed values: - - ``returnDocument``: Boolean. If set to ``true``, the - associated Document object is returned in - [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1alpha.RecommendResponse.RecommendationResult.document]. - - ``returnScore``: Boolean. If set to true, the - recommendation score corresponding to each returned - Document is set in - [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1alpha.RecommendResponse.RecommendationResult.metadata]. - The given score indicates the probability of a Document - conversion given the user's context and history. - - ``strictFiltering``: Boolean. True by default. If set to - ``false``, the service returns generic (unfiltered) - popular Documents instead of empty if your filter blocks - all recommendation results. - - ``diversityLevel``: String. Default empty. If set to be - non-empty, then it needs to be one of: - - - ``no-diversity`` - - ``low-diversity`` - - ``medium-diversity`` - - ``high-diversity`` - - ``auto-diversity`` This gives request-level control and - adjusts recommendation results based on Document - category. - - - ``attributeFilteringSyntax``: Boolean. False by default. - If set to true, the ``filter`` field is interpreted - according to the new, attribute-based syntax. + * ``returnDocument``: Boolean. If set to + ``true``, the associated Document object is + returned in + `RecommendResponse.RecommendationResult.document + `__. + + * ``returnScore``: Boolean. If set to true, the + recommendation score corresponding to each + returned Document is set in + `RecommendResponse.RecommendationResult.metadata + `__. + The given score indicates the probability of a + Document conversion given the user's context + and history. + + * ``strictFiltering``: Boolean. True by default. + If set to ``false``, the service + returns generic (unfiltered) popular + Documents instead of empty if your filter + blocks all recommendation results. + + * ``diversityLevel``: String. Default empty. If + set to be non-empty, then it needs to be one + of: + + * ``no-diversity`` + * ``low-diversity`` + + * ``medium-diversity`` + * ``high-diversity`` + + * ``auto-diversity`` + This gives request-level control and adjusts + recommendation results based on Document + category. + + * ``attributeFilteringSyntax``: Boolean. False + by default. If set to true, the ``filter`` + field is interpreted according to the new, + attribute-based syntax. user_labels (MutableMapping[str, str]): - The user labels applied to a resource must meet the - following requirements: - - - Each resource can have multiple labels, up to a maximum of - 64. - - Each label must be a key-value pair. - - Keys have a minimum length of 1 character and a maximum - length of 63 characters and cannot be empty. Values can be - empty and have a maximum length of 63 characters. - - Keys and values can contain only lowercase letters, - numeric characters, underscores, and dashes. All - characters must use UTF-8 encoding, and international - characters are allowed. - - The key portion of a label must be unique. However, you - can use the same key with multiple resources. - - Keys must start with a lowercase letter or international - character. + The user labels applied to a resource must meet + the following requirements: + * Each resource can have multiple labels, up to + a maximum of 64. + + * Each label must be a key-value pair. + * Keys have a minimum length of 1 character and + a maximum length of 63 characters and cannot + be empty. Values can be empty and have a maximum + length of 63 characters. + + * Keys and values can contain only lowercase + letters, numeric characters, underscores, and + dashes. All characters must use UTF-8 encoding, + and international characters are allowed. + + * The key portion of a label must be unique. + However, you can use the same key with + multiple resources. + + * Keys must start with a lowercase letter or + international character. See `Requirements for - labels `__ + labels + `__ for more details. """ @@ -213,17 +248,20 @@ class RecommendResponse(proto.Message): represents the ranking (from the most relevant Document to the least). attribution_token (str): - A unique attribution token. This should be included in the - [UserEvent][google.cloud.discoveryengine.v1alpha.UserEvent] - logs resulting from this recommendation, which enables - accurate attribution of recommendation model performance. + A unique attribution token. This should be + included in the `UserEvent + `__ + logs resulting from this recommendation, which + enables accurate attribution of recommendation + model performance. missing_ids (MutableSequence[str]): IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig. validate_only (bool): True if - [RecommendRequest.validate_only][google.cloud.discoveryengine.v1alpha.RecommendRequest.validate_only] + `RecommendRequest.validate_only + `__ was set. """ @@ -236,15 +274,18 @@ class RecommendationResult(proto.Message): Resource ID of the recommended Document. document (google.cloud.discoveryengine_v1alpha.types.Document): Set if ``returnDocument`` is set to true in - [RecommendRequest.params][google.cloud.discoveryengine.v1alpha.RecommendRequest.params]. + `RecommendRequest.params + `__. metadata (MutableMapping[str, google.protobuf.struct_pb2.Value]): Additional Document metadata or annotations. Possible values: - - ``score``: Recommendation score in double value. Is set if - ``returnScore`` is set to true in - [RecommendRequest.params][google.cloud.discoveryengine.v1alpha.RecommendRequest.params]. + * ``score``: Recommendation score in double + value. Is set if ``returnScore`` is set to + true in + `RecommendRequest.params + `__. """ id: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/sample_query.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/sample_query.py index e6d834a42d5c..2ad69ae91c1f 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/sample_query.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/sample_query.py @@ -39,15 +39,16 @@ class SampleQuery(proto.Message): This field is a member of `oneof`_ ``content``. name (str): - Identifier. The full resource name of the sample query, in - the format of + Identifier. The full resource name of the sample + query, in the format of ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}``. - This field must be a UTF-8 encoded string with a length - limit of 1024 characters. + This field must be a UTF-8 encoded string with a + length limit of 1024 characters. create_time (google.protobuf.timestamp_pb2.Timestamp): Output only. Timestamp the - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] + `SampleQuery + `__ was created at. """ @@ -71,10 +72,11 @@ class Target(proto.Message): uri (str): Expected uri of the target. - This field must be a UTF-8 encoded string with a length - limit of 2048 characters. + This field must be a UTF-8 encoded string with a + length limit of 2048 characters. - Example of valid uris: ``https://example.com/abc``, + Example of valid uris: + ``https://example.com/abc``, ``gcs://example/example.pdf``. page_numbers (MutableSequence[int]): Expected page numbers of the target. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/sample_query_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/sample_query_service.py index 29a623493981..ff9fe427dc4b 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/sample_query_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/sample_query_service.py @@ -37,23 +37,27 @@ class GetSampleQueryRequest(proto.Message): r"""Request message for - [SampleQueryService.GetSampleQuery][google.cloud.discoveryengine.v1alpha.SampleQueryService.GetSampleQuery] + `SampleQueryService.GetSampleQuery + `__ method. Attributes: name (str): Required. Full resource name of - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], + `SampleQuery + `__, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}``. - If the caller does not have permission to access the - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. + If the caller does not have permission to access + the `SampleQuery + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. If the requested - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] + `SampleQuery + `__ does not exist, a NOT_FOUND error is returned. """ @@ -65,39 +69,48 @@ class GetSampleQueryRequest(proto.Message): class ListSampleQueriesRequest(proto.Message): r"""Request message for - [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueries] + `SampleQueryService.ListSampleQueries + `__ method. Attributes: parent (str): - Required. The parent sample query set resource name, such as + Required. The parent sample query set resource + name, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}``. If the caller does not have permission to list - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s - under this sample query set, regardless of whether or not - this sample query set exists, a ``PERMISSION_DENIED`` error - is returned. + `SampleQuery + `__s + under this sample query set, regardless of + whether or not this sample query set exists, a + ``PERMISSION_DENIED`` error is returned. page_size (int): Maximum number of - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s - to return. If unspecified, defaults to 100. The maximum - allowed value is 1000. Values above 1000 will be coerced to - 1000. + `SampleQuery + `__s + to return. If unspecified, defaults to 100. The + maximum allowed value is 1000. Values above 1000 + will be coerced to 1000. - If this field is negative, an ``INVALID_ARGUMENT`` error is - returned. + If this field is negative, an + ``INVALID_ARGUMENT`` error is returned. page_token (str): A page token - [ListSampleQueriesResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListSampleQueriesResponse.next_page_token], + `ListSampleQueriesResponse.next_page_token + `__, received from a previous - [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueries] - call. Provide this to retrieve the subsequent page. - - When paginating, all other parameters provided to - [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueries] - must match the call that provided the page token. Otherwise, - an ``INVALID_ARGUMENT`` error is returned. + `SampleQueryService.ListSampleQueries + `__ + call. Provide this to retrieve the subsequent + page. + + When paginating, all other parameters provided + to `SampleQueryService.ListSampleQueries + `__ + must match the call that provided the page + token. Otherwise, an ``INVALID_ARGUMENT`` error + is returned. """ parent: str = proto.Field( @@ -116,18 +129,20 @@ class ListSampleQueriesRequest(proto.Message): class ListSampleQueriesResponse(proto.Message): r"""Response message for - [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueries] + `SampleQueryService.ListSampleQueries + `__ method. Attributes: sample_queries (MutableSequence[google.cloud.discoveryengine_v1alpha.types.SampleQuery]): - The - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s. + The `SampleQuery + `__s. next_page_token (str): A token that can be sent as - [ListSampleQueriesRequest.page_token][google.cloud.discoveryengine.v1alpha.ListSampleQueriesRequest.page_token] - to retrieve the next page. If this field is omitted, there - are no subsequent pages. + `ListSampleQueriesRequest.page_token + `__ + to retrieve the next page. If this field is + omitted, there are no subsequent pages. """ @property @@ -147,7 +162,8 @@ def raw_page(self): class CreateSampleQueryRequest(proto.Message): r"""Request message for - [SampleQueryService.CreateSampleQuery][google.cloud.discoveryengine.v1alpha.SampleQueryService.CreateSampleQuery] + `SampleQueryService.CreateSampleQuery + `__ method. Attributes: @@ -156,29 +172,37 @@ class CreateSampleQueryRequest(proto.Message): ``projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}``. sample_query (google.cloud.discoveryengine_v1alpha.types.SampleQuery): Required. The - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] + `SampleQuery + `__ to create. sample_query_id (str): Required. The ID to use for the - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], + `SampleQuery + `__, which will become the final component of the - [SampleQuery.name][google.cloud.discoveryengine.v1alpha.SampleQuery.name]. + `SampleQuery.name + `__. - If the caller does not have permission to create the - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], + If the caller does not have permission to create + the `SampleQuery + `__, regardless of whether or not it exists, a ``PERMISSION_DENIED`` error is returned. This field must be unique among all - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s + `SampleQuery + `__s with the same - [parent][google.cloud.discoveryengine.v1alpha.CreateSampleQueryRequest.parent]. - Otherwise, an ``ALREADY_EXISTS`` error is returned. + `parent + `__. + Otherwise, an ``ALREADY_EXISTS`` error is + returned. - This field must conform to - `RFC-1034 `__ standard - with a length limit of 63 characters. Otherwise, an - ``INVALID_ARGUMENT`` error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 characters. + Otherwise, an ``INVALID_ARGUMENT`` error is + returned. """ parent: str = proto.Field( @@ -198,21 +222,24 @@ class CreateSampleQueryRequest(proto.Message): class UpdateSampleQueryRequest(proto.Message): r"""Request message for - [SampleQueryService.UpdateSampleQuery][google.cloud.discoveryengine.v1alpha.SampleQueryService.UpdateSampleQuery] + `SampleQueryService.UpdateSampleQuery + `__ method. Attributes: sample_query (google.cloud.discoveryengine_v1alpha.types.SampleQuery): Required. The simple query to update. - If the caller does not have permission to update the - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], + If the caller does not have permission to update + the `SampleQuery + `__, regardless of whether or not it exists, a ``PERMISSION_DENIED`` error is returned. - If the - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] - to update does not exist a ``NOT_FOUND`` error is returned. + If the `SampleQuery + `__ + to update does not exist a ``NOT_FOUND`` error + is returned. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided imported 'simple query' to update. If not set, @@ -233,24 +260,28 @@ class UpdateSampleQueryRequest(proto.Message): class DeleteSampleQueryRequest(proto.Message): r"""Request message for - [SampleQueryService.DeleteSampleQuery][google.cloud.discoveryengine.v1alpha.SampleQueryService.DeleteSampleQuery] + `SampleQueryService.DeleteSampleQuery + `__ method. Attributes: name (str): Required. Full resource name of - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], + `SampleQuery + `__, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}``. - If the caller does not have permission to delete the - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], + If the caller does not have permission to delete + the `SampleQuery + `__, regardless of whether or not it exists, a ``PERMISSION_DENIED`` error is returned. - If the - [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] - to delete does not exist, a ``NOT_FOUND`` error is returned. + If the `SampleQuery + `__ + to delete does not exist, a ``NOT_FOUND`` error + is returned. """ name: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/sample_query_set.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/sample_query_set.py index 0b91372a0e2e..130925d33577 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/sample_query_set.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/sample_query_set.py @@ -35,12 +35,13 @@ class SampleQuerySet(proto.Message): Attributes: name (str): Identifier. The full resource name of the - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], + `SampleQuerySet + `__, in the format of ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}``. - This field must be a UTF-8 encoded string with a length - limit of 1024 characters. + This field must be a UTF-8 encoded string with a + length limit of 1024 characters. display_name (str): Required. The sample query set display name. @@ -48,11 +49,13 @@ class SampleQuerySet(proto.Message): length limit of 128 characters. create_time (google.protobuf.timestamp_pb2.Timestamp): Output only. Timestamp the - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] + `SampleQuerySet + `__ was created at. description (str): The description of the - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]. + `SampleQuerySet + `__. """ name: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/sample_query_set_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/sample_query_set_service.py index b493508c4cd9..a7f2512907fc 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/sample_query_set_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/sample_query_set_service.py @@ -39,23 +39,27 @@ class GetSampleQuerySetRequest(proto.Message): r"""Request message for - [SampleQuerySetService.GetSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.GetSampleQuerySet] + `SampleQuerySetService.GetSampleQuerySet + `__ method. Attributes: name (str): Required. Full resource name of - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], + `SampleQuerySet + `__, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}``. - If the caller does not have permission to access the - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. + If the caller does not have permission to access + the `SampleQuerySet + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. If the requested - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] + `SampleQuerySet + `__ does not exist, a NOT_FOUND error is returned. """ @@ -67,38 +71,48 @@ class GetSampleQuerySetRequest(proto.Message): class ListSampleQuerySetsRequest(proto.Message): r"""Request message for - [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.ListSampleQuerySets] + `SampleQuerySetService.ListSampleQuerySets + `__ method. Attributes: parent (str): - Required. The parent location resource name, such as + Required. The parent location resource name, + such as ``projects/{project}/locations/{location}``. If the caller does not have permission to list - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s - under this location, regardless of whether or not this - location exists, a ``PERMISSION_DENIED`` error is returned. + `SampleQuerySet + `__s + under this location, regardless of whether or + not this location exists, a + ``PERMISSION_DENIED`` error is returned. page_size (int): Maximum number of - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s - to return. If unspecified, defaults to 100. The maximum - allowed value is 1000. Values above 1000 will be coerced to - 1000. + `SampleQuerySet + `__s + to return. If unspecified, defaults to 100. The + maximum allowed value is 1000. Values above 1000 + will be coerced to 1000. - If this field is negative, an ``INVALID_ARGUMENT`` error is - returned. + If this field is negative, an + ``INVALID_ARGUMENT`` error is returned. page_token (str): A page token - [ListSampleQuerySetsResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListSampleQuerySetsResponse.next_page_token], + `ListSampleQuerySetsResponse.next_page_token + `__, received from a previous - [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.ListSampleQuerySets] - call. Provide this to retrieve the subsequent page. - - When paginating, all other parameters provided to - [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.ListSampleQuerySets] - must match the call that provided the page token. Otherwise, - an ``INVALID_ARGUMENT`` error is returned. + `SampleQuerySetService.ListSampleQuerySets + `__ + call. Provide this to retrieve the subsequent + page. + + When paginating, all other parameters provided + to `SampleQuerySetService.ListSampleQuerySets + `__ + must match the call that provided the page + token. Otherwise, an ``INVALID_ARGUMENT`` error + is returned. """ parent: str = proto.Field( @@ -117,18 +131,20 @@ class ListSampleQuerySetsRequest(proto.Message): class ListSampleQuerySetsResponse(proto.Message): r"""Response message for - [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.ListSampleQuerySets] + `SampleQuerySetService.ListSampleQuerySets + `__ method. Attributes: sample_query_sets (MutableSequence[google.cloud.discoveryengine_v1alpha.types.SampleQuerySet]): - The - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s. + The `SampleQuerySet + `__s. next_page_token (str): A token that can be sent as - [ListSampleQuerySetsRequest.page_token][google.cloud.discoveryengine.v1alpha.ListSampleQuerySetsRequest.page_token] - to retrieve the next page. If this field is omitted, there - are no subsequent pages. + `ListSampleQuerySetsRequest.page_token + `__ + to retrieve the next page. If this field is + omitted, there are no subsequent pages. """ @property @@ -150,7 +166,8 @@ def raw_page(self): class CreateSampleQuerySetRequest(proto.Message): r"""Request message for - [SampleQuerySetService.CreateSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.CreateSampleQuerySet] + `SampleQuerySetService.CreateSampleQuerySet + `__ method. Attributes: @@ -159,29 +176,37 @@ class CreateSampleQuerySetRequest(proto.Message): ``projects/{project}/locations/{location}``. sample_query_set (google.cloud.discoveryengine_v1alpha.types.SampleQuerySet): Required. The - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] + `SampleQuerySet + `__ to create. sample_query_set_id (str): Required. The ID to use for the - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], + `SampleQuerySet + `__, which will become the final component of the - [SampleQuerySet.name][google.cloud.discoveryengine.v1alpha.SampleQuerySet.name]. + `SampleQuerySet.name + `__. - If the caller does not have permission to create the - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], + If the caller does not have permission to create + the `SampleQuerySet + `__, regardless of whether or not it exists, a ``PERMISSION_DENIED`` error is returned. This field must be unique among all - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s + `SampleQuerySet + `__s with the same - [parent][google.cloud.discoveryengine.v1alpha.CreateSampleQuerySetRequest.parent]. - Otherwise, an ``ALREADY_EXISTS`` error is returned. + `parent + `__. + Otherwise, an ``ALREADY_EXISTS`` error is + returned. - This field must conform to - `RFC-1034 `__ standard - with a length limit of 63 characters. Otherwise, an - ``INVALID_ARGUMENT`` error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 characters. + Otherwise, an ``INVALID_ARGUMENT`` error is + returned. """ parent: str = proto.Field( @@ -201,21 +226,25 @@ class CreateSampleQuerySetRequest(proto.Message): class UpdateSampleQuerySetRequest(proto.Message): r"""Request message for - [SampleQuerySetService.UpdateSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.UpdateSampleQuerySet] + `SampleQuerySetService.UpdateSampleQuerySet + `__ method. Attributes: sample_query_set (google.cloud.discoveryengine_v1alpha.types.SampleQuerySet): Required. The sample query set to update. - If the caller does not have permission to update the - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], + If the caller does not have permission to update + the `SampleQuerySet + `__, regardless of whether or not it exists, a ``PERMISSION_DENIED`` error is returned. If the - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] - to update does not exist a ``NOT_FOUND`` error is returned. + `SampleQuerySet + `__ + to update does not exist a ``NOT_FOUND`` error + is returned. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided imported 'sample query set' to update. If not @@ -236,24 +265,29 @@ class UpdateSampleQuerySetRequest(proto.Message): class DeleteSampleQuerySetRequest(proto.Message): r"""Request message for - [SampleQuerySetService.DeleteSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.DeleteSampleQuerySet] + `SampleQuerySetService.DeleteSampleQuerySet + `__ method. Attributes: name (str): Required. Full resource name of - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], + `SampleQuerySet + `__, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}``. - If the caller does not have permission to delete the - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], + If the caller does not have permission to delete + the `SampleQuerySet + `__, regardless of whether or not it exists, a ``PERMISSION_DENIED`` error is returned. If the - [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] - to delete does not exist, a ``NOT_FOUND`` error is returned. + `SampleQuerySet + `__ + to delete does not exist, a ``NOT_FOUND`` error + is returned. """ name: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/schema.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/schema.py index c689e740ae89..2196466f1dce 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/schema.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/schema.py @@ -49,12 +49,12 @@ class Schema(proto.Message): This field is a member of `oneof`_ ``schema``. name (str): - Immutable. The full resource name of the schema, in the - format of + Immutable. The full resource name of the schema, + in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}``. - This field must be a UTF-8 encoded string with a length - limit of 1024 characters. + This field must be a UTF-8 encoded string with a + length limit of 1024 characters. field_configs (MutableSequence[google.cloud.discoveryengine_v1alpha.types.FieldConfig]): Output only. Configurations for fields of the schema. @@ -88,179 +88,241 @@ class FieldConfig(proto.Message): Attributes: field_path (str): - Required. Field path of the schema field. For example: - ``title``, ``description``, ``release_info.release_year``. + Required. Field path of the schema field. + For example: ``title``, ``description``, + ``release_info.release_year``. field_type (google.cloud.discoveryengine_v1alpha.types.FieldConfig.FieldType): Output only. Raw type of the field. indexable_option (google.cloud.discoveryengine_v1alpha.types.FieldConfig.IndexableOption): If - [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option] + `indexable_option + `__ is - [INDEXABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_ENABLED], - field values are indexed so that it can be filtered or - faceted in - [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search]. + `INDEXABLE_ENABLED + `__, + field values are indexed so that it can be + filtered or faceted in `SearchService.Search + `__. If - [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option] + `indexable_option + `__ is unset, the server behavior defaults to - [INDEXABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_DISABLED] - for fields that support setting indexable options. For those - fields that do not support setting indexable options, such - as ``object`` and ``boolean`` and key properties, the server + `INDEXABLE_DISABLED + `__ + for fields that support setting indexable + options. For those fields that do not support + setting indexable options, such as ``object`` + and ``boolean`` and key properties, the server will skip - [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option] + `indexable_option + `__ setting, and setting - [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option] - for those fields will throw ``INVALID_ARGUMENT`` error. + `indexable_option + `__ + for those fields will throw ``INVALID_ARGUMENT`` + error. dynamic_facetable_option (google.cloud.discoveryengine_v1alpha.types.FieldConfig.DynamicFacetableOption): If - [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option] + `dynamic_facetable_option + `__ is - [DYNAMIC_FACETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_ENABLED], - field values are available for dynamic facet. Could only be - [DYNAMIC_FACETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_DISABLED] + `DYNAMIC_FACETABLE_ENABLED + `__, + field values are available for dynamic facet. + Could only be `DYNAMIC_FACETABLE_DISABLED + `__ if - [FieldConfig.indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option] + `FieldConfig.indexable_option + `__ is - [INDEXABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_DISABLED]. - Otherwise, an ``INVALID_ARGUMENT`` error will be returned. + `INDEXABLE_DISABLED + `__. + Otherwise, an ``INVALID_ARGUMENT`` error will be + returned. If - [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option] + `dynamic_facetable_option + `__ is unset, the server behavior defaults to - [DYNAMIC_FACETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_DISABLED] - for fields that support setting dynamic facetable options. - For those fields that do not support setting dynamic - facetable options, such as ``object`` and ``boolean``, the - server will skip dynamic facetable option setting, and + `DYNAMIC_FACETABLE_DISABLED + `__ + for fields that support setting dynamic + facetable options. For those fields that do not + support setting dynamic facetable options, such + as ``object`` and ``boolean``, the server will + skip dynamic facetable option setting, and setting - [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option] - for those fields will throw ``INVALID_ARGUMENT`` error. + `dynamic_facetable_option + `__ + for those fields will throw ``INVALID_ARGUMENT`` + error. searchable_option (google.cloud.discoveryengine_v1alpha.types.FieldConfig.SearchableOption): If - [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option] + `searchable_option + `__ is - [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED], + `SEARCHABLE_ENABLED + `__, field values are searchable by text queries in - [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search]. + `SearchService.Search + `__. If - [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED] - but field type is numerical, field values will not be - searchable by text queries in - [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search], - as there are no text values associated to numerical fields. + `SEARCHABLE_ENABLED + `__ + but field type is numerical, field values will + not be searchable by text queries in + `SearchService.Search + `__, + as there are no text values associated to + numerical fields. If - [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option] + `searchable_option + `__ is unset, the server behavior defaults to - [SEARCHABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_DISABLED] - for fields that support setting searchable options. Only - ``string`` fields that have no key property mapping support - setting - [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]. - - For those fields that do not support setting searchable - options, the server will skip searchable option setting, and - setting - [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option] - for those fields will throw ``INVALID_ARGUMENT`` error. + `SEARCHABLE_DISABLED + `__ + for fields that support setting searchable + options. Only ``string`` fields that have no key + property mapping support setting + `searchable_option + `__. + + For those fields that do not support setting + searchable options, the server will skip + searchable option setting, and setting + `searchable_option + `__ + for those fields will throw ``INVALID_ARGUMENT`` + error. retrievable_option (google.cloud.discoveryengine_v1alpha.types.FieldConfig.RetrievableOption): If - [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option] + `retrievable_option + `__ is - [RETRIEVABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_ENABLED], + `RETRIEVABLE_ENABLED + `__, field values are included in the search results. If - [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option] + `retrievable_option + `__ is unset, the server behavior defaults to - [RETRIEVABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_DISABLED] - for fields that support setting retrievable options. For - those fields that do not support setting retrievable - options, such as ``object`` and ``boolean``, the server will - skip retrievable option setting, and setting - [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option] - for those fields will throw ``INVALID_ARGUMENT`` error. + `RETRIEVABLE_DISABLED + `__ + for fields that support setting retrievable + options. For those fields that do not support + setting retrievable options, such as ``object`` + and ``boolean``, the server will skip + retrievable option setting, and setting + `retrievable_option + `__ + for those fields will throw ``INVALID_ARGUMENT`` + error. completable_option (google.cloud.discoveryengine_v1alpha.types.FieldConfig.CompletableOption): If - [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option] + `completable_option + `__ is - [COMPLETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_ENABLED], - field values are directly used and returned as suggestions - for Autocomplete in - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery]. + `COMPLETABLE_ENABLED + `__, + field values are directly used and returned as + suggestions for Autocomplete in + `CompletionService.CompleteQuery + `__. If - [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option] + `completable_option + `__ is unset, the server behavior defaults to - [COMPLETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_DISABLED] - for fields that support setting completable options, which - are just ``string`` fields. For those fields that do not - support setting completable options, the server will skip + `COMPLETABLE_DISABLED + `__ + for fields that support setting completable + options, which are just ``string`` fields. For + those fields that do not support setting + completable options, the server will skip completable option setting, and setting - [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option] - for those fields will throw ``INVALID_ARGUMENT`` error. + `completable_option + `__ + for those fields will throw ``INVALID_ARGUMENT`` + error. recs_filterable_option (google.cloud.discoveryengine_v1alpha.types.FieldConfig.FilterableOption): If - [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option] + `recs_filterable_option + `__ is - [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED], - field values are filterable by filter expression in - [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend]. + `FILTERABLE_ENABLED + `__, + field values are filterable by filter expression + in `RecommendationService.Recommend + `__. If - [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED] - but the field type is numerical, field values are not - filterable by text queries in - [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend]. + `FILTERABLE_ENABLED + `__ + but the field type is numerical, field values + are not filterable by text queries in + `RecommendationService.Recommend + `__. Only textual fields are supported. If - [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option] + `recs_filterable_option + `__ is unset, the default setting is - [FILTERABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_DISABLED] - for fields that support setting filterable options. - - When a field set to [FILTERABLE_DISABLED] is filtered, a - warning is generated and an empty result is returned. + `FILTERABLE_DISABLED + `__ + for fields that support setting filterable + options. + + When a field set to [FILTERABLE_DISABLED] is + filtered, a warning is generated and an empty + result is returned. key_property_type (str): - Output only. Type of the key property that this field is - mapped to. Empty string if this is not annotated as mapped - to a key property. - - Example types are ``title``, ``description``. Full list is - defined by ``keyPropertyMapping`` in the schema field - annotation. - - If the schema field has a ``KeyPropertyMapping`` annotation, - ``indexable_option`` and ``searchable_option`` of this field - cannot be modified. + Output only. Type of the key property that this + field is mapped to. Empty string if this is not + annotated as mapped to a key property. + + Example types are ``title``, ``description``. + Full list is defined by ``keyPropertyMapping`` + in the schema field annotation. + + If the schema field has a ``KeyPropertyMapping`` + annotation, ``indexable_option`` and + ``searchable_option`` of this field cannot be + modified. advanced_site_search_data_sources (MutableSequence[google.cloud.discoveryengine_v1alpha.types.FieldConfig.AdvancedSiteSearchDataSource]): - If this field is set, only the corresponding source will be - indexed for this field. Otherwise, the values from different - sources are merged. - - Assuming a page with ```` in meta tag, and - ```` in page map: if this enum is set to - METATAGS, we will only index ````; if this enum - is not set, we will merge them and index - ````. + If this field is set, only the corresponding + source will be indexed for this field. + Otherwise, the values from different sources are + merged. + + Assuming a page with ```` in meta + tag, and ```` in page map: + + if this enum is set to METATAGS, we will only + index ````; if this enum is not set, + we will merge them and index ````. schema_org_paths (MutableSequence[str]): - Field paths for indexing custom attribute from schema.org - data. More details of schema.org and its defined types can - be found at `schema.org `__. + Field paths for indexing custom attribute from + schema.org data. More details of schema.org and + its defined types can be found at `schema.org + `__. It is only used on advanced site search schema. - Currently only support full path from root. The full path to - a field is constructed by concatenating field names, - starting from ``_root``, with a period ``.`` as the - delimiter. Examples: + Currently only support full path from root. The + full path to a field is constructed by + concatenating field names, starting from + ``_root``, with a period ``.`` as the delimiter. + Examples: - - Publish date of the root: \_root.datePublished - - Publish date of the reviews: \_root.review.datePublished + * Publish date of the root: _root.datePublished + * Publish date of the reviews: + _root.review.datePublished """ class FieldType(proto.Enum): @@ -280,31 +342,37 @@ class FieldType(proto.Enum): BOOLEAN (5): Field value type is Boolean. GEOLOCATION (6): - Field value type is Geolocation. Geolocation is expressed as - an object with the following keys: - - - ``id``: a string representing the location id - - ``longitude``: a number representing the longitude - coordinate of the location - - ``latitude``: a number repesenting the latitude coordinate - of the location - - ``address``: a string representing the full address of the - location - - ``latitude`` and ``longitude`` must always be provided - together. At least one of a) ``address`` or b) - ``latitude``-``longitude`` pair must be provided. + Field value type is Geolocation. Geolocation is + expressed as an object with the following keys: + + * ``id``: a string representing the location id + * ``longitude``: a number representing the + longitude coordinate of the location + + * ``latitude``: a number repesenting the + latitude coordinate of the location + + * ``address``: a string representing the full + address of the location + + ``latitude`` and ``longitude`` must always be + provided together. At least one of a) + ``address`` or b) ``latitude``-``longitude`` + pair must be provided. DATETIME (7): - Field value type is Datetime. Datetime can be expressed as - either: - - - a number representing milliseconds-since-the-epoch - - a string representing milliseconds-since-the-epoch. e.g. - ``"1420070400001"`` - - a string representing the `ISO - 8601 `__ date or - date and time. e.g. ``"2015-01-01"`` or - ``"2015-01-01T12:10:30Z"`` + Field value type is Datetime. Datetime can be + expressed as either: + * a number representing + milliseconds-since-the-epoch + + * a string representing + milliseconds-since-the-epoch. e.g. + ``"1420070400001"`` + + * a string representing the `ISO + 8601 `__ + date or date and time. e.g. ``"2015-01-01"`` or + ``"2015-01-01T12:10:30Z"`` """ FIELD_TYPE_UNSPECIFIED = 0 OBJECT = 1 @@ -425,7 +493,8 @@ class AdvancedSiteSearchDataSource(proto.Enum): Retrieve value from page map. URI_PATTERN_MAPPING (3): Retrieve value from the attributes set by - [SiteSearchEngineService.SetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData] + `SiteSearchEngineService.SetUriPatternDocumentData + `__ API. SCHEMA_ORG (4): Retrieve value from schema.org data. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/schema_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/schema_service.py index 1bcb7a03dc21..b97565b58844 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/schema_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/schema_service.py @@ -40,13 +40,14 @@ class GetSchemaRequest(proto.Message): r"""Request message for - [SchemaService.GetSchema][google.cloud.discoveryengine.v1alpha.SchemaService.GetSchema] + `SchemaService.GetSchema + `__ method. Attributes: name (str): - Required. The full resource name of the schema, in the - format of + Required. The full resource name of the schema, + in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}``. """ @@ -58,33 +59,41 @@ class GetSchemaRequest(proto.Message): class ListSchemasRequest(proto.Message): r"""Request message for - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1alpha.SchemaService.ListSchemas] + `SchemaService.ListSchemas + `__ method. Attributes: parent (str): - Required. The parent data store resource name, in the format - of + Required. The parent data store resource name, + in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}``. page_size (int): The maximum number of - [Schema][google.cloud.discoveryengine.v1alpha.Schema]s to - return. The service may return fewer than this value. + `Schema + `__s + to return. The service may return fewer than + this value. If unspecified, at most 100 - [Schema][google.cloud.discoveryengine.v1alpha.Schema]s are - returned. + `Schema + `__s + are returned. - The maximum value is 1000; values above 1000 are set to - 1000. + The maximum value is 1000; values above 1000 are + set to 1000. page_token (str): A page token, received from a previous - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1alpha.SchemaService.ListSchemas] - call. Provide this to retrieve the subsequent page. - - When paginating, all other parameters provided to - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1alpha.SchemaService.ListSchemas] - must match the call that provided the page token. + `SchemaService.ListSchemas + `__ + call. Provide this to retrieve the subsequent + page. + + When paginating, all other parameters provided + to `SchemaService.ListSchemas + `__ + must match the call that provided the page + token. """ parent: str = proto.Field( @@ -103,17 +112,20 @@ class ListSchemasRequest(proto.Message): class ListSchemasResponse(proto.Message): r"""Response message for - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1alpha.SchemaService.ListSchemas] + `SchemaService.ListSchemas + `__ method. Attributes: schemas (MutableSequence[google.cloud.discoveryengine_v1alpha.types.Schema]): - The [Schema][google.cloud.discoveryengine.v1alpha.Schema]s. + The `Schema + `__s. next_page_token (str): A token that can be sent as - [ListSchemasRequest.page_token][google.cloud.discoveryengine.v1alpha.ListSchemasRequest.page_token] - to retrieve the next page. If this field is omitted, there - are no subsequent pages. + `ListSchemasRequest.page_token + `__ + to retrieve the next page. If this field is + omitted, there are no subsequent pages. """ @property @@ -133,27 +145,31 @@ def raw_page(self): class CreateSchemaRequest(proto.Message): r"""Request message for - [SchemaService.CreateSchema][google.cloud.discoveryengine.v1alpha.SchemaService.CreateSchema] + `SchemaService.CreateSchema + `__ method. Attributes: parent (str): - Required. The parent data store resource name, in the format - of + Required. The parent data store resource name, + in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}``. schema (google.cloud.discoveryengine_v1alpha.types.Schema): - Required. The - [Schema][google.cloud.discoveryengine.v1alpha.Schema] to - create. + Required. The `Schema + `__ + to create. schema_id (str): Required. The ID to use for the - [Schema][google.cloud.discoveryengine.v1alpha.Schema], which - becomes the final component of the - [Schema.name][google.cloud.discoveryengine.v1alpha.Schema.name]. + `Schema + `__, + which becomes the final component of the + `Schema.name + `__. This field should conform to - `RFC-1034 `__ standard - with a length limit of 63 characters. + `RFC-1034 + `__ + standard with a length limit of 63 characters. """ parent: str = proto.Field( @@ -173,20 +189,23 @@ class CreateSchemaRequest(proto.Message): class UpdateSchemaRequest(proto.Message): r"""Request message for - [SchemaService.UpdateSchema][google.cloud.discoveryengine.v1alpha.SchemaService.UpdateSchema] + `SchemaService.UpdateSchema + `__ method. Attributes: schema (google.cloud.discoveryengine_v1alpha.types.Schema): - Required. The - [Schema][google.cloud.discoveryengine.v1alpha.Schema] to - update. + Required. The `Schema + `__ + to update. allow_missing (bool): If set to true, and the - [Schema][google.cloud.discoveryengine.v1alpha.Schema] is not - found, a new - [Schema][google.cloud.discoveryengine.v1alpha.Schema] is - created. In this situation, ``update_mask`` is ignored. + `Schema + `__ + is not found, a new `Schema + `__ + is created. In this situation, ``update_mask`` + is ignored. """ schema: gcd_schema.Schema = proto.Field( @@ -202,13 +221,14 @@ class UpdateSchemaRequest(proto.Message): class DeleteSchemaRequest(proto.Message): r"""Request message for - [SchemaService.DeleteSchema][google.cloud.discoveryengine.v1alpha.SchemaService.DeleteSchema] + `SchemaService.DeleteSchema + `__ method. Attributes: name (str): - Required. The full resource name of the schema, in the - format of + Required. The full resource name of the schema, + in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}``. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/search_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/search_service.py index ec032e3f2105..0b5a5ac6097a 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/search_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/search_service.py @@ -35,63 +35,73 @@ class SearchRequest(proto.Message): r"""Request message for - [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search] + `SearchService.Search + `__ method. Attributes: serving_config (str): - Required. The resource name of the Search serving config, - such as + Required. The resource name of the Search + serving config, such as ``projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config``, or ``projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config``. - This field is used to identify the serving configuration - name, set of models used to make the search. + This field is used to identify the serving + configuration name, set of models used to make + the search. branch (str): The branch resource name, such as ``projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0``. - Use ``default_branch`` as the branch ID or leave this field - empty, to search documents under the default branch. + Use ``default_branch`` as the branch ID or leave + this field empty, to search documents under the + default branch. query (str): Raw search query. image_query (google.cloud.discoveryengine_v1alpha.types.SearchRequest.ImageQuery): Raw image query. page_size (int): Maximum number of - [Document][google.cloud.discoveryengine.v1alpha.Document]s - to return. The maximum allowed value depends on the data - type. Values above the maximum value are coerced to the - maximum value. - - - Websites with basic indexing: Default ``10``, Maximum - ``25``. - - Websites with advanced indexing: Default ``25``, Maximum - ``50``. - - Other: Default ``50``, Maximum ``100``. - - If this field is negative, an ``INVALID_ARGUMENT`` is - returned. + `Document + `__s + to return. The maximum allowed value depends on + the data type. Values above the maximum value + are coerced to the maximum value. + + * Websites with basic indexing: Default ``10``, + Maximum ``25``. * Websites with advanced + indexing: Default ``25``, Maximum ``50``. + + * Other: Default ``50``, Maximum ``100``. + + If this field is negative, an + ``INVALID_ARGUMENT`` is returned. page_token (str): A page token received from a previous - [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search] - call. Provide this to retrieve the subsequent page. - - When paginating, all other parameters provided to - [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search] - must match the call that provided the page token. Otherwise, - an ``INVALID_ARGUMENT`` error is returned. + `SearchService.Search + `__ + call. Provide this to retrieve the subsequent + page. + + When paginating, all other parameters provided + to `SearchService.Search + `__ + must match the call that provided the page + token. Otherwise, an ``INVALID_ARGUMENT`` + error is returned. offset (int): - A 0-indexed integer that specifies the current offset (that - is, starting result location, amongst the - [Document][google.cloud.discoveryengine.v1alpha.Document]s - deemed by the API as relevant) in search results. This field - is only considered if - [page_token][google.cloud.discoveryengine.v1alpha.SearchRequest.page_token] + A 0-indexed integer that specifies the current + offset (that is, starting result location, + amongst the `Document + `__s + deemed by the API as relevant) in search + results. This field is only considered if + `page_token + `__ is unset. - If this field is negative, an ``INVALID_ARGUMENT`` is - returned. + If this field is negative, an + ``INVALID_ARGUMENT`` is returned. data_store_specs (MutableSequence[google.cloud.discoveryengine_v1alpha.types.SearchRequest.DataStoreSpec]): Specs defining dataStores to filter on in a search call and configurations for those @@ -100,98 +110,115 @@ class SearchRequest(proto.Message): dataStore within an engine, they should use the specs at the top level. filter (str): - The filter syntax consists of an expression language for - constructing a predicate from one or more fields of the - documents being filtered. Filter expression is - case-sensitive. - - If this field is unrecognizable, an ``INVALID_ARGUMENT`` is - returned. - - Filtering in Vertex AI Search is done by mapping the LHS - filter key to a key property defined in the Vertex AI Search - backend -- this mapping is defined by the customer in their - schema. For example a media customer might have a field - 'name' in their schema. In this case the filter would look - like this: filter --> name:'ANY("king kong")' - - For more information about filtering including syntax and - filter operators, see - `Filter `__ + The filter syntax consists of an expression + language for constructing a predicate from one + or more fields of the documents being filtered. + Filter expression is case-sensitive. + + If this field is unrecognizable, an + ``INVALID_ARGUMENT`` is returned. + + Filtering in Vertex AI Search is done by mapping + the LHS filter key to a key property defined in + the Vertex AI Search backend -- this mapping is + defined by the customer in their schema. For + example a media customer might have a field + 'name' in their schema. In this case the filter + would look like this: filter --> name:'ANY("king + kong")' + + For more information about filtering including + syntax and filter operators, see + `Filter + `__ canonical_filter (str): - The default filter that is applied when a user performs a - search without checking any filters on the search page. - - The filter applied to every search request when quality - improvement such as query expansion is needed. In the case a - query does not have a sufficient amount of results this - filter will be used to determine whether or not to enable - the query expansion flow. The original filter will still be - used for the query expanded search. This field is strongly - recommended to achieve high search quality. + The default filter that is applied when a user + performs a search without checking any filters + on the search page. + + The filter applied to every search request when + quality improvement such as query expansion is + needed. In the case a query does not have a + sufficient amount of results this filter will be + used to determine whether or not to enable the + query expansion flow. The original filter will + still be used for the query expanded search. + This field is strongly recommended to achieve + high search quality. For more information about filter syntax, see - [SearchRequest.filter][google.cloud.discoveryengine.v1alpha.SearchRequest.filter]. + `SearchRequest.filter + `__. order_by (str): - The order in which documents are returned. Documents can be - ordered by a field in an - [Document][google.cloud.discoveryengine.v1alpha.Document] - object. Leave it unset if ordered by relevance. ``order_by`` - expression is case-sensitive. - - For more information on ordering the website search results, - see `Order web search - results `__. - For more information on ordering the healthcare search - results, see `Order healthcare search - results `__. - If this field is unrecognizable, an ``INVALID_ARGUMENT`` is - returned. + The order in which documents are returned. + Documents can be ordered by a field in an + `Document + `__ + object. Leave it unset if ordered by relevance. + ``order_by`` expression is case-sensitive. + + For more information on ordering the website + search results, see `Order web search + results + `__. + For more information on ordering the healthcare + search results, see `Order healthcare search + results + `__. + If this field is unrecognizable, an + ``INVALID_ARGUMENT`` is returned. user_info (google.cloud.discoveryengine_v1alpha.types.UserInfo): - Information about the end user. Highly recommended for - analytics. - [UserInfo.user_agent][google.cloud.discoveryengine.v1alpha.UserInfo.user_agent] + Information about the end user. + Highly recommended for analytics. + `UserInfo.user_agent + `__ is used to deduce ``device_type`` for analytics. language_code (str): - The BCP-47 language code, such as "en-US" or "sr-Latn". For - more information, see `Standard - fields `__. - This field helps to better interpret the query. If a value - isn't specified, the query language code is automatically - detected, which may not be accurate. + The BCP-47 language code, such as "en-US" or + "sr-Latn". For more information, see `Standard + fields + `__. + This field helps to better interpret the query. + If a value isn't specified, the query language + code is automatically detected, which may not be + accurate. region_code (str): - The Unicode country/region code (CLDR) of a location, such - as "US" and "419". For more information, see `Standard - fields `__. - If set, then results will be boosted based on the - region_code provided. + The Unicode country/region code (CLDR) of a + location, such as "US" and "419". For more + information, see `Standard fields + `__. + If set, then results will be boosted based on + the region_code provided. facet_specs (MutableSequence[google.cloud.discoveryengine_v1alpha.types.SearchRequest.FacetSpec]): - Facet specifications for faceted search. If empty, no facets - are returned. - - A maximum of 100 values are allowed. Otherwise, an - ``INVALID_ARGUMENT`` error is returned. + Facet specifications for faceted search. If + empty, no facets are returned. + A maximum of 100 values are allowed. Otherwise, + an ``INVALID_ARGUMENT`` error is returned. boost_spec (google.cloud.discoveryengine_v1alpha.types.SearchRequest.BoostSpec): - Boost specification to boost certain documents. For more - information on boosting, see - `Boosting `__ + Boost specification to boost certain documents. + For more information on boosting, see + `Boosting + `__ params (MutableMapping[str, google.protobuf.struct_pb2.Value]): Additional search parameters. - For public website search only, supported values are: + For public website search only, supported values + are: - - ``user_country_code``: string. Default empty. If set to - non-empty, results are restricted or boosted based on the - location provided. For example, - ``user_country_code: "au"`` + * ``user_country_code``: string. Default empty. + If set to non-empty, results are restricted + or boosted based on the location provided. + For example, ``user_country_code: "au"`` - For available codes see `Country - Codes `__ + For available codes see `Country + Codes + `__ - - ``search_type``: double. Default empty. Enables - non-webpage searching depending on the value. The only - valid non-default value is 1, which enables image - searching. For example, ``search_type: 1`` + * ``search_type``: double. Default empty. + Enables non-webpage searching depending on + the value. The only valid non-default value is + 1, which enables image searching. + For example, ``search_type: 1`` query_expansion_spec (google.cloud.discoveryengine_v1alpha.types.SearchRequest.QueryExpansionSpec): The query expansion specification that specifies the conditions under which query @@ -201,68 +228,62 @@ class SearchRequest(proto.Message): specifies the mode under which spell correction takes effect. user_pseudo_id (str): - A unique identifier for tracking visitors. For example, this - could be implemented with an HTTP cookie, which should be - able to uniquely identify a visitor on a single device. This - unique identifier should not change if the visitor logs in - or out of the website. + A unique identifier for tracking visitors. For + example, this could be implemented with an HTTP + cookie, which should be able to uniquely + identify a visitor on a single device. This + unique identifier should not change if the + visitor logs in or out of the website. This field should NOT have a fixed value such as ``unknown_visitor``. This should be the same identifier as - [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1alpha.UserEvent.user_pseudo_id] + `UserEvent.user_pseudo_id + `__ and - [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1alpha.CompleteQueryRequest.user_pseudo_id] + `CompleteQueryRequest.user_pseudo_id + `__ - The field must be a UTF-8 encoded string with a length limit - of 128 characters. Otherwise, an ``INVALID_ARGUMENT`` error - is returned. + The field must be a UTF-8 encoded string with a + length limit of 128 characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. content_search_spec (google.cloud.discoveryengine_v1alpha.types.SearchRequest.ContentSearchSpec): A specification for configuring the behavior of content search. embedding_spec (google.cloud.discoveryengine_v1alpha.types.SearchRequest.EmbeddingSpec): - Uses the provided embedding to do additional semantic - document retrieval. The retrieval is based on the dot - product of - [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.vector] + Uses the provided embedding to do additional + semantic document retrieval. The retrieval is + based on the dot product of + `SearchRequest.EmbeddingSpec.EmbeddingVector.vector + `__ and the document embedding that is provided in - [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path]. + `SearchRequest.EmbeddingSpec.EmbeddingVector.field_path + `__. If - [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path] + `SearchRequest.EmbeddingSpec.EmbeddingVector.field_path + `__ is not provided, it will use - [ServingConfig.EmbeddingConfig.field_path][google.cloud.discoveryengine.v1alpha.ServingConfig.embedding_config]. + `ServingConfig.EmbeddingConfig.field_path + `__. ranking_expression (str): - The ranking expression controls the customized ranking on - retrieval documents. This overrides - [ServingConfig.ranking_expression][google.cloud.discoveryengine.v1alpha.ServingConfig.ranking_expression]. - The syntax and supported features depend on the - ``ranking_expression_backend`` value. If - ``ranking_expression_backend`` is not provided, it defaults - to ``RANK_BY_EMBEDDING``. + The ranking expression controls the customized ranking on retrieval documents. This overrides [ServingConfig.ranking_expression][google.cloud.discoveryengine.v1alpha.ServingConfig.ranking_expression]. The syntax and supported features depend on the ``ranking_expression_backend`` value. If ``ranking_expression_backend`` is not provided, it defaults to ``RANK_BY_EMBEDDING``. - If - [ranking_expression_backend][google.cloud.discoveryengine.v1alpha.SearchRequest.ranking_expression_backend] - is not provided or set to ``RANK_BY_EMBEDDING``, it should - be a single function or multiple functions that are joined - by "+". + If [ranking_expression_backend][google.cloud.discoveryengine.v1alpha.SearchRequest.ranking_expression_backend] is not provided or set to ``RANK_BY_EMBEDDING``, it should be a single function or multiple functions that are joined by "+". - - ranking_expression = function, { " + ", function }; + - ranking_expression = function, { " + ", function }; Supported functions: - - double \* relevance_score - - double \* dotProduct(embedding_field_path) + - double \* relevance_score + - double \* dotProduct(embedding_field_path) Function variables: - - ``relevance_score``: pre-defined keywords, used for - measure relevance between query and document. - - ``embedding_field_path``: the document embedding field - used with query embedding vector. - - ``dotProduct``: embedding function between - ``embedding_field_path`` and query embedding vector. + - ``relevance_score``: pre-defined keywords, used for measure relevance between query and document. + - ``embedding_field_path``: the document embedding field used with query embedding vector. + - ``dotProduct``: embedding function between ``embedding_field_path`` and query embedding vector. Example ranking expression: @@ -271,71 +292,34 @@ class SearchRequest(proto.Message): If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. - If - [ranking_expression_backend][google.cloud.discoveryengine.v1alpha.SearchRequest.ranking_expression_backend] - is set to ``RANK_BY_FORMULA``, the following expression - types (and combinations of those chained using + or - - - operators) are supported: - - - ``double`` - - ``signal`` - - ``log(signal)`` - - ``exp(signal)`` - - ``rr(signal, double > 0)`` -- reciprocal rank - transformation with second argument being a denominator - constant. - - ``is_nan(signal)`` -- returns 0 if signal is NaN, 1 - otherwise. - - ``fill_nan(signal1, signal2 | double)`` -- if signal1 is - NaN, returns signal2 \| double, else returns signal1. - - Here are a few examples of ranking formulas that use the - supported ranking expression types: - - - ``0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`` - -- mostly rank by the logarithm of - ``keyword_similarity_score`` with slight - ``semantic_smilarity_score`` adjustment. - - ``0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)`` - -- rank by the exponent of ``semantic_similarity_score`` - filling the value with 0 if it's NaN, also add constant - 0.3 adjustment to the final score if - ``semantic_similarity_score`` is NaN. - - ``0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)`` - -- mostly rank by the reciprocal rank of - ``keyword_similarity_score`` with slight adjustment of - reciprocal rank of ``semantic_smilarity_score``. + If [ranking_expression_backend][google.cloud.discoveryengine.v1alpha.SearchRequest.ranking_expression_backend] is set to ``RANK_BY_FORMULA``, the following expression types (and combinations of those chained using + or + + - operators) are supported: + + - ``double`` + - ``signal`` + - ``log(signal)`` + - ``exp(signal)`` + - ``rr(signal, double > 0)`` -- reciprocal rank transformation with second argument being a denominator constant. + - ``is_nan(signal)`` -- returns 0 if signal is NaN, 1 otherwise. + - ``fill_nan(signal1, signal2 | double)`` -- if signal1 is NaN, returns signal2 \| double, else returns signal1. + + Here are a few examples of ranking formulas that use the supported ranking expression types: + + - ``0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`` -- mostly rank by the logarithm of ``keyword_similarity_score`` with slight ``semantic_smilarity_score`` adjustment. + - ``0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)`` -- rank by the exponent of ``semantic_similarity_score`` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if ``semantic_similarity_score`` is NaN. + - ``0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)`` -- mostly rank by the reciprocal rank of ``keyword_similarity_score`` with slight adjustment of reciprocal rank of ``semantic_smilarity_score``. The following signals are supported: - - ``semantic_similarity_score``: semantic similarity - adjustment that is calculated using the embeddings - generated by a proprietary Google model. This score - determines how semantically similar a search query is to a - document. - - ``keyword_similarity_score``: keyword match adjustment - uses the Best Match 25 (BM25) ranking function. This score - is calculated using a probabilistic model to estimate the - probability that a document is relevant to a given query. - - ``relevance_score``: semantic relevance adjustment that - uses a proprietary Google model to determine the meaning - and intent behind a user's query in context with the - content in the documents. - - ``pctr_rank``: predicted conversion rate adjustment as a - rank use predicted Click-through rate (pCTR) to gauge the - relevance and attractiveness of a search result from a - user's perspective. A higher pCTR suggests that the result - is more likely to satisfy the user's query and intent, - making it a valuable signal for ranking. - - ``freshness_rank``: freshness adjustment as a rank - - ``document_age``: The time in hours elapsed since the - document was last updated, a floating-point number (e.g., - 0.25 means 15 minutes). - - ``topicality_rank``: topicality adjustment as a rank. Uses - proprietary Google model to determine the keyword-based - overlap between the query and the document. - - ``base_rank``: the default rank of the result + - ``semantic_similarity_score``: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. + - ``keyword_similarity_score``: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. + - ``relevance_score``: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. + - ``pctr_rank``: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. + - ``freshness_rank``: freshness adjustment as a rank + - ``document_age``: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). + - ``topicality_rank``: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. + - ``base_rank``: the default rank of the result ranking_expression_backend (google.cloud.discoveryengine_v1alpha.types.SearchRequest.RankingExpressionBackend): The backend to use for the ranking expression evaluation. @@ -343,39 +327,47 @@ class SearchRequest(proto.Message): Whether to turn on safe search. This is only supported for website search. user_labels (MutableMapping[str, str]): - The user labels applied to a resource must meet the - following requirements: - - - Each resource can have multiple labels, up to a maximum of - 64. - - Each label must be a key-value pair. - - Keys have a minimum length of 1 character and a maximum - length of 63 characters and cannot be empty. Values can be - empty and have a maximum length of 63 characters. - - Keys and values can contain only lowercase letters, - numeric characters, underscores, and dashes. All - characters must use UTF-8 encoding, and international - characters are allowed. - - The key portion of a label must be unique. However, you - can use the same key with multiple resources. - - Keys must start with a lowercase letter or international - character. + The user labels applied to a resource must meet + the following requirements: + * Each resource can have multiple labels, up to + a maximum of 64. + + * Each label must be a key-value pair. + * Keys have a minimum length of 1 character and + a maximum length of 63 characters and cannot + be empty. Values can be empty and have a maximum + length of 63 characters. + + * Keys and values can contain only lowercase + letters, numeric characters, underscores, and + dashes. All characters must use UTF-8 encoding, + and international characters are allowed. + + * The key portion of a label must be unique. + However, you can use the same key with + multiple resources. + + * Keys must start with a lowercase letter or + international character. See `Google Cloud - Document `__ + Document + `__ for more details. natural_language_query_understanding_spec (google.cloud.discoveryengine_v1alpha.types.SearchRequest.NaturalLanguageQueryUnderstandingSpec): - If ``naturalLanguageQueryUnderstandingSpec`` is not - specified, no additional natural language query - understanding will be done. + If ``naturalLanguageQueryUnderstandingSpec`` is + not specified, no additional natural language + query understanding will be done. search_as_you_type_spec (google.cloud.discoveryengine_v1alpha.types.SearchRequest.SearchAsYouTypeSpec): - Search as you type configuration. Only supported for the - [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1alpha.IndustryVertical.MEDIA] + Search as you type configuration. Only supported + for the `IndustryVertical.MEDIA + `__ vertical. custom_fine_tuning_spec (google.cloud.discoveryengine_v1alpha.types.CustomFineTuningSpec): - Custom fine tuning configs. If set, it has higher priority - than the configs set in - [ServingConfig.custom_fine_tuning_spec][google.cloud.discoveryengine.v1alpha.ServingConfig.custom_fine_tuning_spec]. + Custom fine tuning configs. + If set, it has higher priority than the configs + set in `ServingConfig.custom_fine_tuning_spec + `__. session (str): The session resource name. Optional. @@ -487,7 +479,8 @@ class DataStoreSpec(proto.Message): Attributes: data_store (str): Required. Full resource name of - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], + `DataStore + `__, such as ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. """ @@ -504,80 +497,91 @@ class FacetSpec(proto.Message): facet_key (google.cloud.discoveryengine_v1alpha.types.SearchRequest.FacetSpec.FacetKey): Required. The facet key specification. limit (int): - Maximum facet values that are returned for this facet. If - unspecified, defaults to 20. The maximum allowed value is - 300. Values above 300 are coerced to 300. For aggregation in - healthcare search, when the [FacetKey.key] is - "healthcare_aggregation_key", the limit will be overridden - to 10,000 internally, regardless of the value set here. - - If this field is negative, an ``INVALID_ARGUMENT`` is - returned. + Maximum facet values that are returned for this + facet. If unspecified, defaults to 20. The + maximum allowed value is 300. Values above 300 + are coerced to 300. + For aggregation in healthcare search, when the + [FacetKey.key] is "healthcare_aggregation_key", + the limit will be overridden to 10,000 + internally, regardless of the value set here. + + If this field is negative, an + ``INVALID_ARGUMENT`` is returned. excluded_filter_keys (MutableSequence[str]): List of keys to exclude when faceting. By default, - [FacetKey.key][google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey.key] - is not excluded from the filter unless it is listed in this - field. - - Listing a facet key in this field allows its values to - appear as facet results, even when they are filtered out of - search results. Using this field does not affect what search - results are returned. - - For example, suppose there are 100 documents with the color - facet "Red" and 200 documents with the color facet "Blue". A - query containing the filter "color:ANY("Red")" and having - "color" as - [FacetKey.key][google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey.key] - would by default return only "Red" documents in the search - results, and also return "Red" with count 100 as the only - color facet. Although there are also blue documents - available, "Blue" would not be shown as an available facet - value. - - If "color" is listed in "excludedFilterKeys", then the query - returns the facet values "Red" with count 100 and "Blue" - with count 200, because the "color" key is now excluded from - the filter. Because this field doesn't affect search - results, the search results are still correctly filtered to - return only "Red" documents. - - A maximum of 100 values are allowed. Otherwise, an - ``INVALID_ARGUMENT`` error is returned. + `FacetKey.key + `__ + is not excluded from the filter unless it is + listed in this field. + + Listing a facet key in this field allows its + values to appear as facet results, even when + they are filtered out of search results. Using + this field does not affect what search results + are returned. + + For example, suppose there are 100 documents + with the color facet "Red" and 200 documents + with the color facet "Blue". A query containing + the filter "color:ANY("Red")" and having "color" + as `FacetKey.key + `__ + would by default return only "Red" documents in + the search results, and also return "Red" with + count 100 as the only color facet. Although + there are also blue documents available, "Blue" + would not be shown as an available facet value. + + If "color" is listed in "excludedFilterKeys", + then the query returns the facet values "Red" + with count 100 and "Blue" with count 200, + because the "color" key is now excluded from the + filter. Because this field doesn't affect search + results, the search results are still correctly + filtered to return only "Red" documents. + + A maximum of 100 values are allowed. Otherwise, + an ``INVALID_ARGUMENT`` error is returned. enable_dynamic_position (bool): - Enables dynamic position for this facet. If set to true, the - position of this facet among all facets in the response is - determined automatically. If dynamic facets are enabled, it - is ordered together. If set to false, the position of this - facet in the response is the same as in the request, and it - is ranked before the facets with dynamic position enable and - all dynamic facets. - - For example, you may always want to have rating facet - returned in the response, but it's not necessarily to always - display the rating facet at the top. In that case, you can - set enable_dynamic_position to true so that the position of - rating facet in response is determined automatically. - - Another example, assuming you have the following facets in - the request: - - - "rating", enable_dynamic_position = true - - - "price", enable_dynamic_position = false - - - "brands", enable_dynamic_position = false - - And also you have a dynamic facets enabled, which generates - a facet ``gender``. Then the final order of the facets in - the response can be ("price", "brands", "rating", "gender") - or ("price", "brands", "gender", "rating") depends on how - API orders "gender" and "rating" facets. However, notice - that "price" and "brands" are always ranked at first and - second position because their enable_dynamic_position is - false. + Enables dynamic position for this facet. If set + to true, the position of this facet among all + facets in the response is determined + automatically. If dynamic facets are enabled, it + is ordered together. If set to false, the + position of this facet in the response is the + same as in the request, and it is ranked before + the facets with dynamic position enable and all + dynamic facets. + + For example, you may always want to have rating + facet returned in the response, but it's not + necessarily to always display the rating facet + at the top. In that case, you can set + enable_dynamic_position to true so that the + position of rating facet in response is + determined automatically. + + Another example, assuming you have the following + facets in the request: + + * "rating", enable_dynamic_position = true + + * "price", enable_dynamic_position = false + + * "brands", enable_dynamic_position = false + + And also you have a dynamic facets enabled, + which generates a facet ``gender``. Then the + final order of the facets in the response can be + ("price", "brands", "rating", "gender") or + ("price", "brands", "gender", "rating") depends + on how API orders "gender" and "rating" facets. + However, notice that "price" and "brands" are + always ranked at first and second position + because their enable_dynamic_position is false. """ class FacetKey(proto.Message): @@ -585,21 +589,23 @@ class FacetKey(proto.Message): Attributes: key (str): - Required. Supported textual and numerical facet keys in - [Document][google.cloud.discoveryengine.v1alpha.Document] - object, over which the facet values are computed. Facet key - is case-sensitive. + Required. Supported textual and numerical facet + keys in `Document + `__ + object, over which the facet values are + computed. Facet key is case-sensitive. intervals (MutableSequence[google.cloud.discoveryengine_v1alpha.types.Interval]): Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30. restricted_values (MutableSequence[str]): - Only get facet for the given restricted values. Only - supported on textual fields. For example, suppose "category" - has three values "Action > 2022", "Action > 2021" and - "Sci-Fi > 2022". If set "restricted_values" to "Action > - 2022", the "category" facet only contains "Action > 2022". + Only get facet for the given restricted values. + Only supported on textual fields. For example, + suppose "category" has three values "Action > + 2022", "Action > 2021" and "Sci-Fi > 2022". If + set "restricted_values" to "Action > 2022", the + "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10. prefixes (MutableSequence[str]): Only get facet values that start with the @@ -627,18 +633,24 @@ class FacetKey(proto.Message): Allowed values are: - - "count desc", which means order by - [SearchResponse.Facet.values.count][google.cloud.discoveryengine.v1alpha.SearchResponse.Facet.FacetValue.count] - descending. - - - "value desc", which means order by - [SearchResponse.Facet.values.value][google.cloud.discoveryengine.v1alpha.SearchResponse.Facet.FacetValue.value] - descending. Only applies to textual facets. - - If not set, textual values are sorted in `natural - order `__; - numerical intervals are sorted in the order given by - [FacetSpec.FacetKey.intervals][google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey.intervals]. + * "count desc", which means order by + `SearchResponse.Facet.values.count + `__ + descending. + + * "value desc", which means order by + `SearchResponse.Facet.values.value + `__ + descending. + Only applies to textual facets. + + If not set, textual values are sorted in + `natural order + `__; + numerical intervals are sorted in the order + given by + `FacetSpec.FacetKey.intervals + `__. """ key: str = proto.Field( @@ -707,39 +719,46 @@ class ConditionBoostSpec(proto.Message): Attributes: condition (str): - An expression which specifies a boost condition. The syntax - and supported fields are the same as a filter expression. - See - [SearchRequest.filter][google.cloud.discoveryengine.v1alpha.SearchRequest.filter] + An expression which specifies a boost condition. + The syntax and supported fields are the same as + a filter expression. See `SearchRequest.filter + `__ for detail syntax and limitations. Examples: - - To boost documents with document ID "doc_1" or "doc_2", - and color "Red" or "Blue": - ``(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`` + * To boost documents with document ID "doc_1" or + "doc_2", and color "Red" or "Blue": + + ``(document_id: ANY("doc_1", "doc_2")) AND + (color: ANY("Red", "Blue"))`` boost (float): - Strength of the condition boost, which should be in [-1, 1]. - Negative boost means demotion. Default is 0.0. - - Setting to 1.0 gives the document a big promotion. However, - it does not necessarily mean that the boosted document will - be the top result at all times, nor that other documents - will be excluded. Results could still be shown even when - none of them matches the condition. And results that are - significantly more relevant to the search query can still - trump your heavily favored but irrelevant documents. - - Setting to -1.0 gives the document a big demotion. However, - results that are deeply relevant might still be shown. The - document will have an upstream battle to get a fairly high + Strength of the condition boost, which should be + in [-1, 1]. Negative boost means demotion. + Default is 0.0. + + Setting to 1.0 gives the document a big + promotion. However, it does not necessarily mean + that the boosted document will be the top result + at all times, nor that other documents will be + excluded. Results could still be shown even when + none of them matches the condition. And results + that are significantly more relevant to the + search query can still trump your heavily + favored but irrelevant documents. + + Setting to -1.0 gives the document a big + demotion. However, results that are deeply + relevant might still be shown. The document will + have an upstream battle to get a fairly high ranking, but it is not blocked out completely. - Setting to 0.0 means no boost applied. The boosting - condition is ignored. Only one of the (condition, boost) - combination or the boost_control_spec below are set. If both - are set then the global boost is ignored and the more - fine-grained boost_control_spec is applied. + Setting to 0.0 means no boost applied. The + boosting condition is ignored. Only one of the + (condition, boost) combination or the + boost_control_spec below are set. If both are + set then the global boost is ignored and the + more fine-grained boost_control_spec is applied. boost_control_spec (google.cloud.discoveryengine_v1alpha.types.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec): Complex specification for custom ranking based on customer defined attribute value. @@ -755,19 +774,22 @@ class BoostControlSpec(proto.Message): The name of the field whose value will be used to determine the boost amount. attribute_type (google.cloud.discoveryengine_v1alpha.types.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType): - The attribute type to be used to determine the boost amount. - The attribute value can be derived from the field value of - the specified field_name. In the case of numerical it is + The attribute type to be used to determine the + boost amount. The attribute value can be derived + from the field value of the specified + field_name. In the case of numerical it is straightforward i.e. attribute_value = - numerical_field_value. In the case of freshness however, - attribute_value = (time.now() - datetime_field_value). + numerical_field_value. In the case of freshness + however, attribute_value = (time.now() - + datetime_field_value). interpolation_type (google.cloud.discoveryengine_v1alpha.types.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType): The interpolation type to be applied to connect the control points listed below. control_points (MutableSequence[google.cloud.discoveryengine_v1alpha.types.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint]): - The control points used to define the curve. The monotonic - function (defined through the interpolation_type above) - passes through the control points listed here. + The control points used to define the curve. The + monotonic function (defined through the + interpolation_type above) passes through the + control points listed here. """ class AttributeType(proto.Enum): @@ -778,19 +800,21 @@ class AttributeType(proto.Enum): ATTRIBUTE_TYPE_UNSPECIFIED (0): Unspecified AttributeType. NUMERICAL (1): - The value of the numerical field will be used to dynamically - update the boost amount. In this case, the attribute_value - (the x value) of the control point will be the actual value - of the numerical field for which the boost_amount is + The value of the numerical field will be used to + dynamically update the boost amount. In this + case, the attribute_value (the x value) of the + control point will be the actual value of the + numerical field for which the boost_amount is specified. FRESHNESS (2): - For the freshness use case the attribute value will be the - duration between the current time and the date in the - datetime field specified. The value must be formatted as an - XSD ``dayTimeDuration`` value (a restricted subset of an ISO - 8601 duration value). The pattern for this is: - ``[nD][T[nH][nM][nS]]``. For example, ``5D``, ``3DT12H30M``, - ``T24H``. + For the freshness use case the attribute value + will be the duration between the current time + and the date in the datetime field specified. + The value must be formatted as an XSD + ``dayTimeDuration`` value (a restricted subset + of an ISO 8601 duration value). The pattern for + this is: ```nD `__`nM `__]``. For + example, ``5D``, ``3DT12H30M``, ``T24H``. """ ATTRIBUTE_TYPE_UNSPECIFIED = 0 NUMERICAL = 1 @@ -821,13 +845,16 @@ class ControlPoint(proto.Message): Can be one of: 1. The numerical field value. - 2. The duration spec for freshness: The value must be - formatted as an XSD ``dayTimeDuration`` value (a - restricted subset of an ISO 8601 duration value). The - pattern for this is: ``[nD][T[nH][nM][nS]]``. + 2. The duration spec for freshness: + + The value must be formatted as an XSD + ``dayTimeDuration`` value (a restricted subset + of an ISO 8601 duration value). The pattern for + this is: ```nD `__`nM `__]``. boost_amount (float): - The value between -1 to 1 by which to boost the score if the - attribute_value evaluates to the value specified above. + The value between -1 to 1 by which to boost the + score if the attribute_value evaluates to the + value specified above. """ attribute_value: str = proto.Field( @@ -889,9 +916,9 @@ class QueryExpansionSpec(proto.Message): Attributes: condition (google.cloud.discoveryengine_v1alpha.types.SearchRequest.QueryExpansionSpec.Condition): - The condition under which query expansion should occur. - Default to - [Condition.DISABLED][google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec.Condition.DISABLED]. + The condition under which query expansion should + occur. Default to `Condition.DISABLED + `__. pin_unexpanded_results (bool): Whether to pin unexpanded results. If this field is set to true, unexpanded products are @@ -905,13 +932,15 @@ class Condition(proto.Enum): Values: CONDITION_UNSPECIFIED (0): - Unspecified query expansion condition. In this case, server - behavior defaults to - [Condition.DISABLED][google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec.Condition.DISABLED]. + Unspecified query expansion condition. In this + case, server behavior defaults to + `Condition.DISABLED + `__. DISABLED (1): - Disabled query expansion. Only the exact search query is - used, even if - [SearchResponse.total_size][google.cloud.discoveryengine.v1alpha.SearchResponse.total_size] + Disabled query expansion. Only the exact search + query is used, even if + `SearchResponse.total_size + `__ is zero. AUTO (2): Automatic query expansion built by the Search @@ -936,9 +965,10 @@ class SpellCorrectionSpec(proto.Message): Attributes: mode (google.cloud.discoveryengine_v1alpha.types.SearchRequest.SpellCorrectionSpec.Mode): - The mode under which spell correction replaces the original - search query. Defaults to - [Mode.AUTO][google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec.Mode.AUTO]. + The mode under which spell correction + replaces the original search query. Defaults to + `Mode.AUTO + `__. """ class Mode(proto.Enum): @@ -947,14 +977,17 @@ class Mode(proto.Enum): Values: MODE_UNSPECIFIED (0): - Unspecified spell correction mode. In this case, server - behavior defaults to - [Mode.AUTO][google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec.Mode.AUTO]. + Unspecified spell correction mode. In this case, + server behavior defaults to + `Mode.AUTO + `__. SUGGESTION_ONLY (1): - Search API tries to find a spelling suggestion. If a - suggestion is found, it is put in the - [SearchResponse.corrected_query][google.cloud.discoveryengine.v1alpha.SearchResponse.corrected_query]. - The spelling suggestion won't be used as the search query. + Search API tries to find a spelling suggestion. + If a suggestion is found, it is put in the + `SearchResponse.corrected_query + `__. + The spelling suggestion won't be used as the + search query. AUTO (2): Automatic spell correction built by the Search API. Search will be based on the @@ -976,28 +1009,32 @@ class ContentSearchSpec(proto.Message): Attributes: snippet_spec (google.cloud.discoveryengine_v1alpha.types.SearchRequest.ContentSearchSpec.SnippetSpec): - If ``snippetSpec`` is not specified, snippets are not - included in the search response. + If ``snippetSpec`` is not specified, snippets + are not included in the search response. summary_spec (google.cloud.discoveryengine_v1alpha.types.SearchRequest.ContentSearchSpec.SummarySpec): - If ``summarySpec`` is not specified, summaries are not - included in the search response. + If ``summarySpec`` is not specified, summaries + are not included in the search response. extractive_content_spec (google.cloud.discoveryengine_v1alpha.types.SearchRequest.ContentSearchSpec.ExtractiveContentSpec): - If there is no extractive_content_spec provided, there will - be no extractive answer in the search response. + If there is no extractive_content_spec provided, + there will be no extractive answer in the search + response. search_result_mode (google.cloud.discoveryengine_v1alpha.types.SearchRequest.ContentSearchSpec.SearchResultMode): - Specifies the search result mode. If unspecified, the search - result mode defaults to ``DOCUMENTS``. + Specifies the search result mode. If + unspecified, the search result mode defaults to + ``DOCUMENTS``. chunk_spec (google.cloud.discoveryengine_v1alpha.types.SearchRequest.ContentSearchSpec.ChunkSpec): - Specifies the chunk spec to be returned from the search - response. Only available if the - [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.search_result_mode] + Specifies the chunk spec to be returned from the + search response. Only available if the + `SearchRequest.ContentSearchSpec.search_result_mode + `__ is set to - [CHUNKS][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS] + `CHUNKS + `__ """ class SearchResultMode(proto.Enum): - r"""Specifies the search result mode. If unspecified, the search result - mode defaults to ``DOCUMENTS``. + r"""Specifies the search result mode. If unspecified, the + search result mode defaults to ``DOCUMENTS``. Values: SEARCH_RESULT_MODE_UNSPECIFIED (0): @@ -1005,9 +1042,10 @@ class SearchResultMode(proto.Enum): DOCUMENTS (1): Returns documents in the search result. CHUNKS (2): - Returns chunks in the search result. Only available if the - [DataStore.DocumentProcessingConfig.chunking_config][] is - specified. + Returns chunks in the search result. Only + available if the + [DataStore.DocumentProcessingConfig.chunking_config][] + is specified. """ SEARCH_RESULT_MODE_UNSPECIFIED = 0 DOCUMENTS = 1 @@ -1019,18 +1057,19 @@ class SnippetSpec(proto.Message): Attributes: max_snippet_count (int): - [DEPRECATED] This field is deprecated. To control snippet - return, use ``return_snippet`` field. For backwards - compatibility, we will return snippet if max_snippet_count > - 0. + [DEPRECATED] This field is deprecated. To + control snippet return, use ``return_snippet`` + field. For backwards compatibility, we will + return snippet if max_snippet_count > 0. reference_only (bool): - [DEPRECATED] This field is deprecated and will have no - affect on the snippet. + [DEPRECATED] This field is deprecated and will + have no affect on the snippet. return_snippet (bool): - If ``true``, then return snippet. If no snippet can be - generated, we return "No snippet is available for this - page." A ``snippet_status`` with ``SUCCESS`` or - ``NO_SNIPPET_AVAILABLE`` will also be returned. + If ``true``, then return snippet. If no snippet + can be generated, we return "No snippet is + available for this page." A ``snippet_status`` + with ``SUCCESS`` or ``NO_SNIPPET_AVAILABLE`` + will also be returned. """ max_snippet_count: int = proto.Field( @@ -1052,77 +1091,89 @@ class SummarySpec(proto.Message): Attributes: summary_result_count (int): - The number of top results to generate the summary from. If - the number of results returned is less than - ``summaryResultCount``, the summary is generated from all of - the results. - - At most 10 results for documents mode, or 50 for chunks - mode, can be used to generate a summary. The chunks mode is - used when - [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.search_result_mode] + The number of top results to generate the + summary from. If the number of results returned + is less than ``summaryResultCount``, the summary + is generated from all of the results. + + At most 10 results for documents mode, or 50 for + chunks mode, can be used to generate a summary. + The chunks mode is used when + `SearchRequest.ContentSearchSpec.search_result_mode + `__ is set to - [CHUNKS][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]. + `CHUNKS + `__. include_citations (bool): - Specifies whether to include citations in the summary. The - default value is ``false``. + Specifies whether to include citations in the + summary. The default value is ``false``. - When this field is set to ``true``, summaries include - in-line citation numbers. + When this field is set to ``true``, summaries + include in-line citation numbers. Example summary including citations: - BigQuery is Google Cloud's fully managed and completely - serverless enterprise data warehouse [1]. BigQuery supports - all data types, works across clouds, and has built-in - machine learning and business intelligence, all within a - unified platform [2, 3]. - - The citation numbers refer to the returned search results - and are 1-indexed. For example, [1] means that the sentence - is attributed to the first search result. [2, 3] means that - the sentence is attributed to both the second and third - search results. + BigQuery is Google Cloud's fully managed and + completely serverless enterprise data warehouse + [1]. BigQuery supports all data types, works + across clouds, and has built-in machine learning + and business intelligence, all within a unified + platform [2, 3]. + + The citation numbers refer to the returned + search results and are 1-indexed. For example, + [1] means that the sentence is attributed to the + first search result. [2, 3] means that the + sentence is attributed to both the second and + third search results. ignore_adversarial_query (bool): - Specifies whether to filter out adversarial queries. The - default value is ``false``. - - Google employs search-query classification to detect - adversarial queries. No summary is returned if the search - query is classified as an adversarial query. For example, a - user might ask a question regarding negative comments about - the company or submit a query designed to generate unsafe, - policy-violating output. If this field is set to ``true``, - we skip generating summaries for adversarial queries and - return fallback messages instead. + Specifies whether to filter out adversarial + queries. The default value is ``false``. + + Google employs search-query classification to + detect adversarial queries. No summary is + returned if the search query is classified as an + adversarial query. For example, a user might ask + a question regarding negative comments about the + company or submit a query designed to generate + unsafe, policy-violating output. If this field + is set to ``true``, we skip generating summaries + for adversarial queries and return fallback + messages instead. ignore_non_summary_seeking_query (bool): - Specifies whether to filter out queries that are not - summary-seeking. The default value is ``false``. - - Google employs search-query classification to detect - summary-seeking queries. No summary is returned if the - search query is classified as a non-summary seeking query. - For example, ``why is the sky blue`` and - ``Who is the best soccer player in the world?`` are - summary-seeking queries, but ``SFO airport`` and - ``world cup 2026`` are not. They are most likely - navigational queries. If this field is set to ``true``, we - skip generating summaries for non-summary seeking queries - and return fallback messages instead. + Specifies whether to filter out queries that are + not summary-seeking. The default value is + ``false``. + + Google employs search-query classification to + detect summary-seeking queries. No summary is + returned if the search query is classified as a + non-summary seeking query. For example, ``why is + the sky blue`` and ``Who is the best soccer + player in the world?`` are summary-seeking + queries, but ``SFO airport`` and ``world cup + 2026`` are not. They are most likely + navigational queries. If this field is set to + ``true``, we skip generating summaries for + non-summary seeking queries and return fallback + messages instead. ignore_low_relevant_content (bool): - Specifies whether to filter out queries that have low - relevance. The default value is ``false``. - - If this field is set to ``false``, all search results are - used regardless of relevance to generate answers. If set to - ``true``, only queries with high relevance search results - will generate answers. + Specifies whether to filter out queries that + have low relevance. The default value is + ``false``. + + If this field is set to ``false``, all search + results are used regardless of relevance to + generate answers. If set to ``true``, only + queries with high relevance search results will + generate answers. model_prompt_spec (google.cloud.discoveryengine_v1alpha.types.SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec): If specified, the spec will be used to modify the prompt provided to the LLM. language_code (str): - Language code for Summary. Use language tags defined by - `BCP47 `__. + Language code for Summary. Use language tags + defined by `BCP47 + `__. Note: This is an experimental feature. model_spec (google.cloud.discoveryengine_v1alpha.types.SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec): If specified, the spec will be used to modify @@ -1162,15 +1213,19 @@ class ModelSpec(proto.Message): Supported values are: - - ``stable``: string. Default value when no value is - specified. Uses a generally available, fine-tuned model. - For more information, see `Answer generation model - versions and - lifecycle `__. - - ``preview``: string. (Public preview) Uses a preview - model. For more information, see `Answer generation model - versions and - lifecycle `__. + * ``stable``: string. Default value when no + value is specified. Uses a generally + available, fine-tuned model. For more + information, see `Answer generation model + versions and + lifecycle + `__. + + * ``preview``: string. (Public preview) Uses a + preview model. For more information, see + `Answer generation model versions and + lifecycle + `__. """ version: str = proto.Field( @@ -1225,53 +1280,63 @@ class ExtractiveContentSpec(proto.Message): Attributes: max_extractive_answer_count (int): - The maximum number of extractive answers returned in each - search result. + The maximum number of extractive answers + returned in each search result. - An extractive answer is a verbatim answer extracted from the - original document, which provides a precise and contextually - relevant answer to the search query. + An extractive answer is a verbatim answer + extracted from the original document, which + provides a precise and contextually relevant + answer to the search query. - If the number of matching answers is less than the - ``max_extractive_answer_count``, return all of the answers. - Otherwise, return the ``max_extractive_answer_count``. + If the number of matching answers is less than + the ``max_extractive_answer_count``, return all + of the answers. Otherwise, return the + ``max_extractive_answer_count``. At most five answers are returned for each - [SearchResult][google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult]. + `SearchResult + `__. max_extractive_segment_count (int): - The max number of extractive segments returned in each - search result. Only applied if the - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] + The max number of extractive segments returned + in each search result. Only applied if the + `DataStore + `__ is set to - [DataStore.ContentConfig.CONTENT_REQUIRED][google.cloud.discoveryengine.v1alpha.DataStore.ContentConfig.CONTENT_REQUIRED] + `DataStore.ContentConfig.CONTENT_REQUIRED + `__ or - [DataStore.solution_types][google.cloud.discoveryengine.v1alpha.DataStore.solution_types] + `DataStore.solution_types + `__ is - [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT]. + `SOLUTION_TYPE_CHAT + `__. - An extractive segment is a text segment extracted from the - original document that is relevant to the search query, and, - in general, more verbose than an extractive answer. The - segment could then be used as input for LLMs to generate - summaries and answers. + An extractive segment is a text segment + extracted from the original document that is + relevant to the search query, and, in general, + more verbose than an extractive answer. The + segment could then be used as input for LLMs to + generate summaries and answers. If the number of matching segments is less than - ``max_extractive_segment_count``, return all of the - segments. Otherwise, return the + ``max_extractive_segment_count``, return all of + the segments. Otherwise, return the ``max_extractive_segment_count``. return_extractive_segment_score (bool): - Specifies whether to return the confidence score from the - extractive segments in each search result. This feature is - available only for new or allowlisted data stores. To - allowlist your data store, contact your Customer Engineer. - The default value is ``false``. + Specifies whether to return the confidence score + from the extractive segments in each search + result. This feature is available only for new + or allowlisted data stores. To allowlist your + data store, contact your Customer Engineer. The + default value is ``false``. num_previous_segments (int): - Specifies whether to also include the adjacent from each - selected segments. Return at most ``num_previous_segments`` + Specifies whether to also include the adjacent + from each selected segments. + Return at most ``num_previous_segments`` segments before each selected segments. num_next_segments (int): - Return at most ``num_next_segments`` segments after each - selected segments. + Return at most ``num_next_segments`` segments + after each selected segments. """ max_extractive_answer_count: int = proto.Field( @@ -1296,11 +1361,13 @@ class ExtractiveContentSpec(proto.Message): ) class ChunkSpec(proto.Message): - r"""Specifies the chunk spec to be returned from the search response. - Only available if the - [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.search_result_mode] + r"""Specifies the chunk spec to be returned from the search + response. Only available if the + `SearchRequest.ContentSearchSpec.search_result_mode + `__ is set to - [CHUNKS][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS] + `CHUNKS + `__ Attributes: num_previous_chunks (int): @@ -1395,16 +1462,19 @@ class NaturalLanguageQueryUnderstandingSpec(proto.Message): Attributes: filter_extraction_condition (google.cloud.discoveryengine_v1alpha.types.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition): - The condition under which filter extraction should occur. - Default to [Condition.DISABLED][]. + The condition under which filter extraction + should occur. Default to [Condition.DISABLED][]. geo_search_query_detection_field_names (MutableSequence[str]): - Field names used for location-based filtering, where - geolocation filters are detected in natural language search - queries. Only valid when the FilterExtractionCondition is - set to ``ENABLED``. - - If this field is set, it overrides the field names set in - [ServingConfig.geo_search_query_detection_field_names][google.cloud.discoveryengine.v1alpha.ServingConfig.geo_search_query_detection_field_names]. + Field names used for location-based filtering, + where geolocation filters are detected in + natural language search queries. Only valid when + the FilterExtractionCondition is set to + ``ENABLED``. + + If this field is set, it overrides the field + names set in + `ServingConfig.geo_search_query_detection_field_names + `__. """ class FilterExtractionCondition(proto.Enum): @@ -1413,7 +1483,8 @@ class FilterExtractionCondition(proto.Enum): Values: CONDITION_UNSPECIFIED (0): - Server behavior defaults to [Condition.DISABLED][]. + Server behavior defaults to + [Condition.DISABLED][]. DISABLED (1): Disables NL filter extraction. ENABLED (2): @@ -1440,9 +1511,10 @@ class SearchAsYouTypeSpec(proto.Message): Attributes: condition (google.cloud.discoveryengine_v1alpha.types.SearchRequest.SearchAsYouTypeSpec.Condition): - The condition under which search as you type should occur. - Default to - [Condition.DISABLED][google.cloud.discoveryengine.v1alpha.SearchRequest.SearchAsYouTypeSpec.Condition.DISABLED]. + The condition under which search as you type + should occur. Default to + `Condition.DISABLED + `__. """ class Condition(proto.Enum): @@ -1452,7 +1524,8 @@ class Condition(proto.Enum): Values: CONDITION_UNSPECIFIED (0): Server behavior defaults to - [Condition.DISABLED][google.cloud.discoveryengine.v1alpha.SearchRequest.SearchAsYouTypeSpec.Condition.DISABLED]. + `Condition.DISABLED + `__. DISABLED (1): Disables Search As You Type. ENABLED (2): @@ -1481,38 +1554,48 @@ class SessionSpec(proto.Message): Attributes: query_id (str): - If set, the search result gets stored to the "turn" - specified by this query ID. + If set, the search result gets stored to the + "turn" specified by this query ID. - Example: Let's say the session looks like this: session { - name: ".../sessions/xxx" turns { query { text: "What is - foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } - turns { query { text: "How about bar then?" query_id: - ".../questions/zzz" } } } + Example: Let's say the session looks like this: - The user can call /search API with a request like this: + session { + name: ".../sessions/xxx" + turns { + query { text: "What is foo?" query_id: + ".../questions/yyy" } answer: "Foo is ..." + } + turns { + query { text: "How about bar then?" + query_id: ".../questions/zzz" } } + } - :: + The user can call /search API with a request + like this: session: ".../sessions/xxx" - session_spec { query_id: ".../questions/zzz" } - - Then, the API stores the search result, associated with the - last turn. The stored search result can be used by a - subsequent /answer API call (with the session ID and the - query ID specified). Also, it is possible to call /search - and /answer in parallel with the same session ID & query ID. + session_spec { query_id: ".../questions/zzz" + } + + Then, the API stores the search result, + associated with the last turn. The stored search + result can be used by a subsequent /answer API + call (with the session ID and the query ID + specified). Also, it is possible to call /search + and /answer in parallel with the same session ID + & query ID. search_result_persistence_count (int): - The number of top search results to persist. The persisted - search results can be used for the subsequent /answer api - call. + The number of top search results to persist. The + persisted search results can be used for the + subsequent /answer api call. - This field is simliar to the ``summary_result_count`` field - in - [SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count]. + This field is simliar to the + ``summary_result_count`` field in + `SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count + `__. - At most 10 results for documents mode, or 50 for chunks - mode. + At most 10 results for documents mode, or 50 for + chunks mode. This field is a member of `oneof`_ ``_search_result_persistence_count``. """ @@ -1679,7 +1762,8 @@ class SessionSpec(proto.Message): class SearchResponse(proto.Message): r"""Response message for - [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search] + `SearchService.Search + `__ method. Attributes: @@ -1691,39 +1775,47 @@ class SearchResponse(proto.Message): guided_search_result (google.cloud.discoveryengine_v1alpha.types.SearchResponse.GuidedSearchResult): Guided search result. total_size (int): - The estimated total count of matched items irrespective of - pagination. The count of - [results][google.cloud.discoveryengine.v1alpha.SearchResponse.results] + The estimated total count of matched items + irrespective of pagination. The count of + `results + `__ returned by pagination may be less than the - [total_size][google.cloud.discoveryengine.v1alpha.SearchResponse.total_size] + `total_size + `__ that matches. attribution_token (str): - A unique search token. This should be included in the - [UserEvent][google.cloud.discoveryengine.v1alpha.UserEvent] - logs resulting from this search, which enables accurate - attribution of search model performance. This also helps to - identify a request during the customer support scenarios. + A unique search token. This should be included + in the `UserEvent + `__ + logs resulting from this search, which enables + accurate attribution of search model + performance. This also helps to identify a + request during the customer support scenarios. redirect_uri (str): - The URI of a customer-defined redirect page. If redirect - action is triggered, no search is performed, and only - [redirect_uri][google.cloud.discoveryengine.v1alpha.SearchResponse.redirect_uri] + The URI of a customer-defined redirect page. If + redirect action is triggered, no search is + performed, and only `redirect_uri + `__ and - [attribution_token][google.cloud.discoveryengine.v1alpha.SearchResponse.attribution_token] + `attribution_token + `__ are set in the response. next_page_token (str): A token that can be sent as - [SearchRequest.page_token][google.cloud.discoveryengine.v1alpha.SearchRequest.page_token] - to retrieve the next page. If this field is omitted, there - are no subsequent pages. + `SearchRequest.page_token + `__ + to retrieve the next page. If this field is + omitted, there are no subsequent pages. corrected_query (str): - Contains the spell corrected query, if found. If the spell - correction type is AUTOMATIC, then the search results are - based on corrected_query. Otherwise the original query is - used for search. + Contains the spell corrected query, if found. If + the spell correction type is AUTOMATIC, then the + search results are based on corrected_query. + Otherwise the original query is used for search. summary (google.cloud.discoveryengine_v1alpha.types.SearchResponse.Summary): - A summary as part of the search results. This field is only - returned if - [SearchRequest.ContentSearchSpec.summary_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.summary_spec] + A summary as part of the search results. + This field is only returned if + `SearchRequest.ContentSearchSpec.summary_spec + `__ is set. applied_controls (MutableSequence[str]): Controls applied as part of the Control @@ -1740,8 +1832,10 @@ class SearchResponse(proto.Message): Session information. Only set if - [SearchRequest.session][google.cloud.discoveryengine.v1alpha.SearchRequest.session] - is provided. See its description for more details. + `SearchRequest.session + `__ + is provided. See its description for more + details. one_box_results (MutableSequence[google.cloud.discoveryengine_v1alpha.types.SearchResponse.OneBoxResult]): A list of One Box results. There can be multiple One Box results of different types. @@ -1752,17 +1846,21 @@ class SearchResult(proto.Message): Attributes: id (str): - [Document.id][google.cloud.discoveryengine.v1alpha.Document.id] - of the searched - [Document][google.cloud.discoveryengine.v1alpha.Document]. + `Document.id + `__ + of the searched `Document + `__. document (google.cloud.discoveryengine_v1alpha.types.Document): - The document data snippet in the search response. Only - fields that are marked as ``retrievable`` are populated. + The document data snippet in the search + response. Only fields that are marked as + ``retrievable`` are populated. chunk (google.cloud.discoveryengine_v1alpha.types.Chunk): The chunk data in the search response if the - [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.search_result_mode] + `SearchRequest.ContentSearchSpec.search_result_mode + `__ is set to - [CHUNKS][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]. + `CHUNKS + `__. model_scores (MutableMapping[str, google.cloud.discoveryengine_v1alpha.types.DoubleList]): Google provided available scores. rank_signals (google.cloud.discoveryengine_v1alpha.types.SearchResponse.SearchResult.RankSignals): @@ -1909,9 +2007,10 @@ class Facet(proto.Message): Attributes: key (str): - The key for this facet. For example, ``"colors"`` or - ``"price"``. It matches - [SearchRequest.FacetSpec.FacetKey.key][google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey.key]. + The key for this facet. For example, + ``"colors"`` or ``"price"``. It matches + `SearchRequest.FacetSpec.FacetKey.key + `__. values (MutableSequence[google.cloud.discoveryengine_v1alpha.types.SearchResponse.Facet.FacetValue]): The facet values for this field. dynamic_facet (bool): @@ -1935,9 +2034,10 @@ class FacetValue(proto.Message): This field is a member of `oneof`_ ``facet_value``. interval (google.cloud.discoveryengine_v1alpha.types.Interval): - Interval value for a facet, such as [10, 20) for facet - "price". It matches - [SearchRequest.FacetSpec.FacetKey.intervals][google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey.intervals]. + Interval value for a facet, such as `10, 20) for + facet "price". It matches + [SearchRequest.FacetSpec.FacetKey.intervals + `__. This field is a member of `oneof`_ ``facet_value``. count (int): @@ -1993,11 +2093,11 @@ class RefinementAttribute(proto.Message): Attributes: attribute_key (str): - Attribute key used to refine the results. For example, - ``"movie_type"``. + Attribute key used to refine the results. For + example, ``"movie_type"``. attribute_value (str): - Attribute value used to refine the results. For example, - ``"drama"``. + Attribute value used to refine the results. For + example, ``"drama"``. """ attribute_key: str = proto.Field( @@ -2050,13 +2150,15 @@ class SummarySkippedReason(proto.Enum): The adversarial query ignored case. Only used when - [SummarySpec.ignore_adversarial_query][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.ignore_adversarial_query] + `SummarySpec.ignore_adversarial_query + `__ is set to ``true``. NON_SUMMARY_SEEKING_QUERY_IGNORED (2): The non-summary seeking query ignored case. Only used when - [SummarySpec.ignore_non_summary_seeking_query][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_summary_seeking_query] + `SummarySpec.ignore_non_summary_seeking_query + `__ is set to ``true``. OUT_OF_DOMAIN_QUERY_IGNORED (3): The out-of-domain query ignored case. @@ -2085,8 +2187,8 @@ class SummarySkippedReason(proto.Enum): JAIL_BREAKING_QUERY_IGNORED (7): The jail-breaking query ignored case. - For example, "Reply in the tone of a competing company's - CEO". Only used when + For example, "Reply in the tone of a competing + company's CEO". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to ``true``. CUSTOMER_POLICY_VIOLATION (8): @@ -2188,9 +2290,9 @@ class CitationSource(proto.Message): Attributes: reference_index (int): Document reference index from - SummaryWithMetadata.references. It is 0-indexed and the - value will be zero if the reference_index is not set - explicitly. + SummaryWithMetadata.references. It is 0-indexed + and the value will be zero if the + reference_index is not set explicitly. """ reference_index: int = proto.Field( @@ -2206,9 +2308,10 @@ class Reference(proto.Message): Title of the document. document (str): Required. - [Document.name][google.cloud.discoveryengine.v1alpha.Document.name] - of the document. Full resource name of the referenced - document, in the format + `Document.name + `__ + of the document. Full resource name of the + referenced document, in the format ``projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*``. uri (str): Cloud Storage or HTTP uri for the document. @@ -2339,9 +2442,10 @@ class QueryExpansionInfo(proto.Message): Bool describing whether query expansion has occurred. pinned_result_count (int): - Number of pinned results. This field will only be set when - expansion happens and - [SearchRequest.QueryExpansionSpec.pin_unexpanded_results][google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec.pin_unexpanded_results] + Number of pinned results. This field will only + be set when expansion happens and + `SearchRequest.QueryExpansionSpec.pin_unexpanded_results + `__ is set to true. """ @@ -2447,7 +2551,8 @@ class Comparison(proto.Enum): LESS_THAN (3): Denotes less than ``<`` operator. GREATER_THAN_EQUALS (4): - Denotes greater than or equal to ``>=`` operator. + Denotes greater than or equal to ``>=`` + operator. GREATER_THAN (5): Denotes greater than ``>`` operator. """ @@ -2646,10 +2751,12 @@ class SessionInfo(proto.Message): Attributes: name (str): - Name of the session. If the auto-session mode is used (when - [SearchRequest.session][google.cloud.discoveryengine.v1alpha.SearchRequest.session] - ends with "-"), this field holds the newly generated session - name. + Name of the session. + If the auto-session mode is used (when + `SearchRequest.session + `__ + ends with "-"), this field holds the newly + generated session name. query_id (str): Query ID that corresponds to this search API call. One session can have multiple turns, each diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/search_tuning_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/search_tuning_service.py index 2134c54c126e..7beafc9fe1a5 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/search_tuning_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/search_tuning_service.py @@ -40,16 +40,17 @@ class ListCustomModelsRequest(proto.Message): r"""Request message for - [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1alpha.SearchTuningService.ListCustomModels] + `SearchTuningService.ListCustomModels + `__ method. Attributes: data_store (str): - Required. The resource name of the parent Data Store, such - as + Required. The resource name of the parent Data + Store, such as ``projects/*/locations/global/collections/default_collection/dataStores/default_data_store``. - This field is used to identify the data store where to fetch - the models from. + This field is used to identify the data store + where to fetch the models from. """ data_store: str = proto.Field( @@ -60,7 +61,8 @@ class ListCustomModelsRequest(proto.Message): class ListCustomModelsResponse(proto.Message): r"""Response message for - [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1alpha.SearchTuningService.ListCustomModels] + `SearchTuningService.ListCustomModels + `__ method. Attributes: @@ -79,7 +81,8 @@ class ListCustomModelsResponse(proto.Message): class TrainCustomModelRequest(proto.Message): r"""Request message for - [SearchTuningService.TrainCustomModel][google.cloud.discoveryengine.v1alpha.SearchTuningService.TrainCustomModel] + `SearchTuningService.TrainCustomModel + `__ method. @@ -91,15 +94,16 @@ class TrainCustomModelRequest(proto.Message): This field is a member of `oneof`_ ``training_input``. data_store (str): - Required. The resource name of the Data Store, such as + Required. The resource name of the Data Store, + such as ``projects/*/locations/global/collections/default_collection/dataStores/default_data_store``. - This field is used to identify the data store where to train - the models. + This field is used to identify the data store + where to train the models. model_type (str): Model to be trained. Supported values are: - - **search-tuning**: Fine tuning the search system based on - data provided. + * **search-tuning**: Fine tuning the search + system based on data provided. error_config (google.cloud.discoveryengine_v1alpha.types.ImportErrorConfig): The desired location of errors incurred during the data ingestion and training. @@ -112,39 +116,45 @@ class GcsTrainingInput(proto.Message): Attributes: corpus_data_path (str): - The Cloud Storage corpus data which could be associated in - train data. The data path format is - ``gs:///``. A newline - delimited jsonl/ndjson file. + The Cloud Storage corpus data which could be + associated in train data. The data path format + is ``gs:///``. + A newline delimited jsonl/ndjson file. + + For search-tuning model, each line should have + the _id, title and text. Example: - For search-tuning model, each line should have the \_id, - title and text. Example: - ``{"_id": "doc1", title: "relevant doc", "text": "relevant text"}`` + ``{"_id": "doc1", title: "relevant doc", "text": + "relevant text"}`` query_data_path (str): - The gcs query data which could be associated in train data. - The data path format is - ``gs:///``. A newline - delimited jsonl/ndjson file. + The gcs query data which could be associated in + train data. The data path format is + ``gs:///``. A + newline delimited jsonl/ndjson file. - For search-tuning model, each line should have the \_id and - text. Example: {"\_id": "query1", "text": "example query"} + For search-tuning model, each line should have + the _id and text. Example: {"_id": "query1", + "text": "example query"} train_data_path (str): - Cloud Storage training data path whose format should be - ``gs:///``. The file should - be in tsv format. Each line should have the doc_id and - query_id and score (number). - - For search-tuning model, it should have the query-id - corpus-id score as tsv file header. The score should be a - number in ``[0, inf+)``. The larger the number is, the more - relevant the pair is. Example: - - - ``query-id\tcorpus-id\tscore`` - - ``query1\tdoc1\t1`` + Cloud Storage training data path whose format + should be + ``gs:///``. The + file should be in tsv format. Each line should + have the doc_id and query_id and score (number). + + For search-tuning model, it should have the + query-id corpus-id score as tsv file header. The + score should be a number in ``[0, inf+)``. The + larger the number is, the more relevant the pair + is. Example: + + * ``query-id\tcorpus-id\tscore`` + * ``query1\tdoc1\t1`` test_data_path (str): - Cloud Storage test data. Same format as train_data_path. If - not provided, a random 80/20 train/test split will be - performed on train_data_path. + Cloud Storage test data. Same format as + train_data_path. If not provided, a random 80/20 + train/test split will be performed on + train_data_path. """ corpus_data_path: str = proto.Field( @@ -191,7 +201,8 @@ class GcsTrainingInput(proto.Message): class TrainCustomModelResponse(proto.Message): r"""Response of the - [TrainCustomModelRequest][google.cloud.discoveryengine.v1alpha.TrainCustomModelRequest]. + `TrainCustomModelRequest + `__. This message is returned by the google.longrunning.Operations.response field. @@ -205,15 +216,20 @@ class TrainCustomModelResponse(proto.Message): model_status (str): The trained model status. Possible values are: - - **bad-data**: The training data quality is bad. - - **no-improvement**: Tuning didn't improve performance. - Won't deploy. - - **in-progress**: Model training job creation is in - progress. - - **training**: Model is actively training. - - **evaluating**: The model is evaluating trained metrics. - - **indexing**: The model trained metrics are indexing. - - **ready**: The model is ready for serving. + * **bad-data**: The training data quality is + bad. + + * **no-improvement**: Tuning didn't improve + performance. Won't deploy. * **in-progress**: + Model training job creation is in progress. + + * **training**: Model is actively training. + * **evaluating**: The model is evaluating + trained metrics. + + * **indexing**: The model trained metrics are + indexing. * **ready**: The model is ready for + serving. metrics (MutableMapping[str, float]): The metrics of the trained model. model_name (str): diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/serving_config.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/serving_config.py index b375e48b8ce0..71a4991120f2 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/serving_config.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/serving_config.py @@ -57,95 +57,115 @@ class ServingConfig(proto.Message): Immutable. Fully qualified name ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`` display_name (str): - Required. The human readable serving config display name. - Used in Discovery UI. + Required. The human readable serving config + display name. Used in Discovery UI. - This field must be a UTF-8 encoded string with a length - limit of 128 characters. Otherwise, an INVALID_ARGUMENT - error is returned. + This field must be a UTF-8 encoded string with a + length limit of 128 characters. Otherwise, an + INVALID_ARGUMENT error is returned. solution_type (google.cloud.discoveryengine_v1alpha.types.SolutionType): Required. Immutable. Specifies the solution type that a serving config can be associated with. model_id (str): - The id of the model to use at serving time. Currently only - RecommendationModels are supported. Can be changed but only - to a compatible model (e.g. others-you-may-like CTR to - others-you-may-like CVR). + The id of the model to use at serving time. + Currently only RecommendationModels are + supported. Can be changed but only to a + compatible model (e.g. others-you-may-like CTR + to others-you-may-like CVR). Required when - [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + `SolutionType + `__ + is `SOLUTION_TYPE_RECOMMENDATION + `__. diversity_level (str): - How much diversity to use in recommendation model results - e.g. ``medium-diversity`` or ``high-diversity``. Currently - supported values: + How much diversity to use in recommendation + model results e.g. ``medium-diversity`` or + ``high-diversity``. Currently supported values: - - ``no-diversity`` - - ``low-diversity`` - - ``medium-diversity`` - - ``high-diversity`` - - ``auto-diversity`` + * ``no-diversity`` + * ``low-diversity`` - If not specified, we choose default based on recommendation - model type. Default value: ``no-diversity``. + * ``medium-diversity`` + * ``high-diversity`` + + * ``auto-diversity`` + + If not specified, we choose default based on + recommendation model type. Default value: + ``no-diversity``. Can only be set if - [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + `SolutionType + `__ + is `SOLUTION_TYPE_RECOMMENDATION + `__. embedding_config (google.cloud.discoveryengine_v1alpha.types.EmbeddingConfig): - Bring your own embedding config. The config is used for - search semantic retrieval. The retrieval is based on the dot - product of - [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.vector] - and the document embeddings that are provided by this - EmbeddingConfig. If - [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.vector] + Bring your own embedding config. The config is + used for search semantic retrieval. The + retrieval is based on the dot product of + `SearchRequest.EmbeddingSpec.EmbeddingVector.vector + `__ + and the document embeddings that are provided by + this EmbeddingConfig. If + `SearchRequest.EmbeddingSpec.EmbeddingVector.vector + `__ is provided, it overrides this - [ServingConfig.embedding_config][google.cloud.discoveryengine.v1alpha.ServingConfig.embedding_config]. + `ServingConfig.embedding_config + `__. ranking_expression (str): - The ranking expression controls the customized ranking on - retrieval documents. To leverage this, document embedding is - required. The ranking expression setting in ServingConfig - applies to all search requests served by the serving config. - However, if - [SearchRequest.ranking_expression][google.cloud.discoveryengine.v1alpha.SearchRequest.ranking_expression] - is specified, it overrides the ServingConfig ranking - expression. - - The ranking expression is a single function or multiple - functions that are joined by "+". - - - ranking_expression = function, { " + ", function }; + The ranking expression controls the customized + ranking on retrieval documents. To leverage + this, document embedding is required. The + ranking expression setting in ServingConfig + applies to all search requests served by the + serving config. However, if + `SearchRequest.ranking_expression + `__ + is specified, it overrides the ServingConfig + ranking expression. + + The ranking expression is a single function or + multiple functions that are joined by "+". + + * ranking_expression = function, { " + ", + function }; Supported functions: - - double \* relevance_score - - double \* dotProduct(embedding_field_path) + * double * relevance_score + * double * dotProduct(embedding_field_path) Function variables: - - ``relevance_score``: pre-defined keywords, used for - measure relevance between query and document. - - ``embedding_field_path``: the document embedding field - used with query embedding vector. - - ``dotProduct``: embedding function between - embedding_field_path and query embedding vector. + * ``relevance_score``: pre-defined keywords, + used for measure relevance between query and + document. + + * ``embedding_field_path``: the document + embedding field used with query embedding + vector. - Example ranking expression: + * ``dotProduct``: embedding function between + embedding_field_path and query embedding + vector. - :: + Example ranking expression: - If document has an embedding field doc_embedding, the ranking expression - could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. + If document has an embedding field + doc_embedding, the ranking expression could + be ``0.5 * relevance_score + 0.3 * + dotProduct(doc_embedding)``. guided_search_spec (google.cloud.discoveryengine_v1alpha.types.GuidedSearchSpec): Guided search configs. custom_fine_tuning_spec (google.cloud.discoveryengine_v1alpha.types.CustomFineTuningSpec): - Custom fine tuning configs. If - [SearchRequest.custom_fine_tuning_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.custom_fine_tuning_spec] - is set, it has higher priority than the configs set here. + Custom fine tuning configs. + If + `SearchRequest.custom_fine_tuning_spec + `__ + is set, it has higher priority than the configs + set here. create_time (google.protobuf.timestamp_pb2.Timestamp): Output only. ServingConfig created timestamp. update_time (google.protobuf.timestamp_pb2.Timestamp): @@ -163,52 +183,64 @@ class ServingConfig(proto.Message): the serving config. Maximum of 20 boost controls. redirect_control_ids (MutableSequence[str]): - IDs of the redirect controls. Only the first triggered - redirect action is applied, even if multiple apply. Maximum - number of specifications is 100. + IDs of the redirect controls. Only the first + triggered redirect action is applied, even if + multiple apply. Maximum number of specifications + is 100. Can only be set if - [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] - is - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH]. + `SolutionType + `__ + is `SOLUTION_TYPE_SEARCH + `__. synonyms_control_ids (MutableSequence[str]): - Condition synonyms specifications. If multiple synonyms - conditions match, all matching synonyms controls in the list - will execute. Maximum number of specifications is 100. + Condition synonyms specifications. If multiple + synonyms conditions match, all matching synonyms + controls in the list will execute. Maximum + number of specifications is 100. Can only be set if - [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] - is - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH]. + `SolutionType + `__ + is `SOLUTION_TYPE_SEARCH + `__. oneway_synonyms_control_ids (MutableSequence[str]): - Condition oneway synonyms specifications. If multiple oneway - synonyms conditions match, all matching oneway synonyms - controls in the list will execute. Maximum number of - specifications is 100. + Condition oneway synonyms specifications. If + multiple oneway synonyms conditions match, all + matching oneway synonyms controls in the list + will execute. Maximum number of specifications + is 100. Can only be set if - [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] - is - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH]. + `SolutionType + `__ + is `SOLUTION_TYPE_SEARCH + `__. dissociate_control_ids (MutableSequence[str]): - Condition do not associate specifications. If multiple do - not associate conditions match, all matching do not - associate controls in the list will execute. Order does not - matter. Maximum number of specifications is 100. + Condition do not associate specifications. If + multiple do not associate conditions match, all + matching do not associate controls in the list + will execute. + Order does not matter. + Maximum number of specifications is 100. Can only be set if - [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] - is - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH]. + `SolutionType + `__ + is `SOLUTION_TYPE_SEARCH + `__. replacement_control_ids (MutableSequence[str]): - Condition replacement specifications. Applied according to - the order in the list. A previously replaced term can not be - re-replaced. Maximum number of specifications is 100. + Condition replacement specifications. + Applied according to the order in the list. + A previously replaced term can not be + re-replaced. Maximum number of specifications is + 100. Can only be set if - [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] - is - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH]. + `SolutionType + `__ + is `SOLUTION_TYPE_SEARCH + `__. ignore_control_ids (MutableSequence[str]): Condition ignore specifications. If multiple ignore conditions match, all matching ignore @@ -218,23 +250,25 @@ class ServingConfig(proto.Message): """ class MediaConfig(proto.Message): - r"""Specifies the configurations needed for Media Discovery. Currently - we support: - - - ``demote_content_watched``: Threshold for watched content - demotion. Customers can specify if using watched content demotion - or use viewed detail page. Using the content watched demotion, - customers need to specify the watched minutes or percentage - exceeds the threshold, the content will be demoted in the - recommendation result. - - ``promote_fresh_content``: cutoff days for fresh content - promotion. Customers can specify if using content freshness - promotion. If the content was published within the cutoff days, - the content will be promoted in the recommendation result. Can - only be set if - [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + r"""Specifies the configurations needed for Media Discovery. + Currently we support: + + * ``demote_content_watched``: Threshold for watched content + demotion. Customers can specify if using watched content + demotion or use viewed detail page. Using the content watched + demotion, customers need to specify the watched minutes or + percentage exceeds the threshold, the content will be demoted in + the recommendation result. + + * ``promote_fresh_content``: cutoff days for fresh content + promotion. Customers can specify if using content freshness + promotion. If the content was published within the cutoff days, + the content will be promoted in the recommendation result. + Can only be set if + `SolutionType + `__ is + `SOLUTION_TYPE_RECOMMENDATION + `__. This message has `oneof`_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. @@ -245,9 +279,9 @@ class MediaConfig(proto.Message): Attributes: content_watched_percentage_threshold (float): - Specifies the content watched percentage threshold for - demotion. Threshold value must be between [0, 1.0] - inclusive. + Specifies the content watched percentage + threshold for demotion. Threshold value must be + between [0, 1.0] inclusive. This field is a member of `oneof`_ ``demote_content_watched``. content_watched_seconds_threshold (float): @@ -256,17 +290,20 @@ class MediaConfig(proto.Message): This field is a member of `oneof`_ ``demote_content_watched``. demotion_event_type (str): - Specifies the event type used for demoting recommendation - result. Currently supported values: + Specifies the event type used for demoting + recommendation result. Currently supported + values: + + * ``view-item``: Item viewed. + * ``media-play``: Start/resume watching a video, + playing a song, etc. - - ``view-item``: Item viewed. - - ``media-play``: Start/resume watching a video, playing a - song, etc. - - ``media-complete``: Finished or stopped midway through a - video, song, etc. + * ``media-complete``: Finished or stopped midway + through a video, song, etc. - If unset, watch history demotion will not be applied. - Content freshness demotion will still be applied. + If unset, watch history demotion will not be + applied. Content freshness demotion will still + be applied. content_freshness_cutoff_days (int): Specifies the content freshness used for recommendation result. Contents will be demoted @@ -294,10 +331,11 @@ class MediaConfig(proto.Message): ) class GenericConfig(proto.Message): - r"""Specifies the configurations needed for Generic Discovery.Currently - we support: + r"""Specifies the configurations needed for Generic + Discovery.Currently we support: - - ``content_search_spec``: configuration for generic content search. + * ``content_search_spec``: configuration for generic content + search. Attributes: content_search_spec (google.cloud.discoveryengine_v1alpha.types.SearchRequest.ContentSearchSpec): diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/serving_config_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/serving_config_service.py index 40b86435dce1..2c08ed12b5f7 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/serving_config_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/serving_config_service.py @@ -43,10 +43,12 @@ class UpdateServingConfigRequest(proto.Message): Required. The ServingConfig to update. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig] + `ServingConfig + `__ to update. The following are NOT supported: - - [ServingConfig.name][google.cloud.discoveryengine.v1alpha.ServingConfig.name] + * `ServingConfig.name + `__ If not set, all supported fields are updated. """ @@ -68,8 +70,8 @@ class GetServingConfigRequest(proto.Message): Attributes: name (str): - Required. The resource name of the ServingConfig to get. - Format: + Required. The resource name of the ServingConfig + to get. Format: ``projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`` """ @@ -84,7 +86,8 @@ class ListServingConfigsRequest(proto.Message): Attributes: parent (str): - Required. Full resource name of the parent resource. Format: + Required. Full resource name of the parent + resource. Format: ``projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`` page_size (int): Optional. Maximum number of results to @@ -93,8 +96,8 @@ class ListServingConfigsRequest(proto.Message): results are returned. page_token (str): Optional. A page token, received from a previous - ``ListServingConfigs`` call. Provide this to retrieve the - subsequent page. + ``ListServingConfigs`` call. Provide this to + retrieve the subsequent page. """ parent: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/session.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/session.py index a4ebfbde229b..dfc3b3ae5a2d 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/session.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/session.py @@ -123,11 +123,13 @@ class Turn(proto.Message): call) happened in this turn. detailed_answer (google.cloud.discoveryengine_v1alpha.types.Answer): Output only. In - [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.GetSession] + `ConversationalSearchService.GetSession + `__ API, if - [GetSessionRequest.include_answer_details][google.cloud.discoveryengine.v1alpha.GetSessionRequest.include_answer_details] - is set to true, this field will be populated when getting - answer query session. + `GetSessionRequest.include_answer_details + `__ + is set to true, this field will be populated + when getting answer query session. query_config (MutableMapping[str, str]): Optional. Represents metadata related to the query config, for example LLM model and version @@ -486,21 +488,26 @@ class FileMetadata(proto.Message): used. download_uri (str): Output only. The - [AssistantService.DownloadSessionFile][google.cloud.discoveryengine.v1alpha.AssistantService.DownloadSessionFile] - URL to download the file. This URL will need the same - credentials as - [AssistantService.ListSessionFileMetadata][google.cloud.discoveryengine.v1alpha.AssistantService.ListSessionFileMetadata] + `AssistantService.DownloadSessionFile + `__ + URL to download the file. This URL will need the + same credentials as + `AssistantService.ListSessionFileMetadata + `__ method and will provide the resource. file_origin_type (google.cloud.discoveryengine_v1alpha.types.FileOriginType): Optional. The origin of the file. views (MutableMapping[str, google.cloud.discoveryengine_v1alpha.types.FileView]): - Output only. Alternate views of this file object. Each file - view is attached to a specific role. Possible example keys: + Output only. Alternate views of this file + object. Each file view is attached to a specific + role. Possible example keys: - "thumbnail" - - "mobile_thumbnail" + - "mobile_thumbnail" + - "clip" - - "summary" + - "summary" + - "translation". """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/session_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/session_service.py index 30f221be13d0..2e2285805418 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/session_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/session_service.py @@ -32,49 +32,60 @@ class ListFilesRequest(proto.Message): r"""Request message for - [SessionService.ListFiles][google.cloud.discoveryengine.v1alpha.SessionService.ListFiles] + `SessionService.ListFiles + `__ method. Attributes: parent (str): - Required. The resource name of the Session. Format: + Required. The resource name of the Session. + Format: + ``projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`` - Name of the session resource to which the file belong. + Name of the session resource to which the file + belong. filter (str): - Optional. The filter syntax consists of an expression - language for constructing a predicate from one or more - fields of the files being filtered. Filter expression is - case-sensitive. Currently supported field names are: + Optional. The filter syntax consists of an + expression language for constructing a predicate + from one or more fields of the files being + filtered. Filter expression is case-sensitive. + Currently supported field names are: + + * upload_time + * last_add_time - - upload_time - - last_add_time - - last_use_time - - file_name - - mime_type + * last_use_time + * file_name + + * mime_type Some examples of filters would be: - - "file_name = 'file_1'" - - "file_name = 'file_1' AND mime_type = 'text/plain'" - - "last_use_time > '2025-06-14T12:00:00Z'" + * "file_name = 'file_1'" + * "file_name = 'file_1' AND mime_type = + 'text/plain'" + + * "last_use_time > '2025-06-14T12:00:00Z'" - For a full description of the filter format, please see - https://google.aip.dev/160. + For a full description of the filter format, + please see https://google.aip.dev/160. page_size (int): - Optional. The maximum number of files to return. The service - may return fewer than this value. If unspecified, at most - 100 files will be returned. The maximum value is 1000; - values above 1000 will be coerced to 1000. If user specifies - a value less than or equal to 0 - the request will be - rejected with an INVALID_ARGUMENT error. + Optional. The maximum number of files to return. + The service may return fewer than this value. If + unspecified, at most 100 files will be returned. + The maximum value is 1000; values above 1000 + will be coerced to 1000. If user specifies a + value less than or equal to 0 - the request will + be rejected with an INVALID_ARGUMENT error. page_token (str): Optional. A page token received from a previous - ``ListFiles`` call. Provide this to retrieve the subsequent - page. + ``ListFiles`` call. Provide this to retrieve the + subsequent page. - When paginating, all other parameters provided to - ``ListFiles`` must match the call that provided the page - token (except ``page_size``, which may differ). + When paginating, all other parameters provided + to ``ListFiles`` must match the call that + provided the page token (except ``page_size``, + which may differ). """ parent: str = proto.Field( @@ -97,19 +108,21 @@ class ListFilesRequest(proto.Message): class ListFilesResponse(proto.Message): r"""Response message for - [SessionService.ListFiles][google.cloud.discoveryengine.v1alpha.SessionService.ListFiles] + `SessionService.ListFiles + `__ method. Attributes: files (MutableSequence[google.cloud.discoveryengine_v1alpha.types.FileMetadata]): - The - [FileMetadata][google.cloud.discoveryengine.v1alpha.FileMetadata]s. + The `FileMetadata + `__s. next_page_token (str): - A token to retrieve next page of results. Pass this value in - the - [ListFilesRequest.page_token][google.cloud.discoveryengine.v1main.ListFilesRequest.page_token] - field in the subsequent call to ``ListFiles`` method to - retrieve the next page of results. + A token to retrieve next page of results. + Pass this value in the + `ListFilesRequest.page_token + `__ + field in the subsequent call to ``ListFiles`` + method to retrieve the next page of results. """ @property diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/site_search_engine.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/site_search_engine.py index 166338513ae6..8c459a291b31 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/site_search_engine.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/site_search_engine.py @@ -37,8 +37,8 @@ class SiteSearchEngine(proto.Message): Attributes: name (str): - The fully qualified resource name of the site search engine. - Format: + The fully qualified resource name of the site + search engine. Format: ``projects/*/locations/*/dataStores/*/siteSearchEngine`` """ @@ -53,30 +53,34 @@ class TargetSite(proto.Message): Attributes: name (str): - Output only. The fully qualified resource name of the target - site. + Output only. The fully qualified resource name + of the target site. ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`` The ``target_site_id`` is system-generated. provided_uri_pattern (str): - Required. Input only. The user provided URI pattern from - which the ``generated_uri_pattern`` is generated. + Required. Input only. The user provided URI + pattern from which the ``generated_uri_pattern`` + is generated. type_ (google.cloud.discoveryengine_v1alpha.types.TargetSite.Type): The type of the target site, e.g., whether the site is to be included or excluded. exact_match (bool): - Input only. If set to false, a uri_pattern is generated to - include all pages whose address contains the - provided_uri_pattern. If set to true, an uri_pattern is - generated to try to be an exact match of the - provided_uri_pattern or just the specific page if the - provided_uri_pattern is a specific one. provided_uri_pattern - is always normalized to generate the URI pattern to be used - by the search engine. + Input only. If set to false, a uri_pattern is + generated to include all pages whose address + contains the provided_uri_pattern. If set to + true, an uri_pattern is generated to try to be + an exact match of the provided_uri_pattern or + just the specific page if the + provided_uri_pattern is a specific one. + provided_uri_pattern is always normalized to + generate the URI pattern to be used by the + search engine. generated_uri_pattern (str): - Output only. This is system-generated based on the - provided_uri_pattern. + Output only. This is system-generated based on + the provided_uri_pattern. root_domain_uri (str): - Output only. Root domain of the provided_uri_pattern. + Output only. Root domain of the + provided_uri_pattern. site_verification_info (google.cloud.discoveryengine_v1alpha.types.SiteVerificationInfo): Output only. Site ownership and validity verification status. @@ -94,9 +98,9 @@ class Type(proto.Enum): Values: TYPE_UNSPECIFIED (0): - This value is unused. In this case, server behavior defaults - to - [Type.INCLUDE][google.cloud.discoveryengine.v1alpha.TargetSite.Type.INCLUDE]. + This value is unused. In this case, server + behavior defaults to `Type.INCLUDE + `__. INCLUDE (1): Include the target site. EXCLUDE (2): diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/site_search_engine_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/site_search_engine_service.py index a54f73fddbfc..c1778ba6cb1a 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/site_search_engine_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/site_search_engine_service.py @@ -66,19 +66,22 @@ class GetSiteSearchEngineRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.GetSiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetSiteSearchEngine] + `SiteSearchEngineService.GetSiteSearchEngine + `__ method. Attributes: name (str): Required. Resource name of - [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. - If the caller does not have permission to access the - [SiteSearchEngine], regardless of whether or not it exists, - a PERMISSION_DENIED error is returned. + If the caller does not have permission to access + the [SiteSearchEngine], regardless of whether or + not it exists, a PERMISSION_DENIED error is + returned. """ name: str = proto.Field( @@ -89,18 +92,20 @@ class GetSiteSearchEngineRequest(proto.Message): class CreateTargetSiteRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.CreateTargetSite] + `SiteSearchEngineService.CreateTargetSite + `__ method. Attributes: parent (str): Required. Parent resource name of - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. target_site (google.cloud.discoveryengine_v1alpha.types.TargetSite): - Required. The - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] + Required. The `TargetSite + `__ to create. """ @@ -117,7 +122,8 @@ class CreateTargetSiteRequest(proto.Message): class CreateTargetSiteMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.CreateTargetSite] + `SiteSearchEngineService.CreateTargetSite + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -143,16 +149,18 @@ class CreateTargetSiteMetadata(proto.Message): class BatchCreateTargetSitesRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchCreateTargetSites] + `SiteSearchEngineService.BatchCreateTargetSites + `__ method. Attributes: parent (str): - Required. The parent resource shared by all TargetSites - being created. + Required. The parent resource shared by all + TargetSites being created. ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. - The parent field in the CreateBookRequest messages must - either be empty or match this field. + The parent field in the CreateBookRequest + messages must either be empty or match this + field. requests (MutableSequence[google.cloud.discoveryengine_v1alpha.types.CreateTargetSiteRequest]): Required. The request message specifying the resources to create. A maximum of 20 TargetSites @@ -172,23 +180,27 @@ class BatchCreateTargetSitesRequest(proto.Message): class GetTargetSiteRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.GetTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetTargetSite] + `SiteSearchEngineService.GetTargetSite + `__ method. Attributes: name (str): Required. Full resource name of - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}``. - If the caller does not have permission to access the - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. + If the caller does not have permission to access + the `TargetSite + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. If the requested - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] + `TargetSite + `__ does not exist, a NOT_FOUND error is returned. """ @@ -200,20 +212,23 @@ class GetTargetSiteRequest(proto.Message): class UpdateTargetSiteRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.UpdateTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.UpdateTargetSite] + `SiteSearchEngineService.UpdateTargetSite + `__ method. Attributes: target_site (google.cloud.discoveryengine_v1alpha.types.TargetSite): - Required. The target site to update. If the caller does not - have permission to update the - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. - - If the - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] - to update does not exist, a NOT_FOUND error is returned. + Required. The target site to update. + If the caller does not have permission to update + the `TargetSite + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. + + If the `TargetSite + `__ + to update does not exist, a NOT_FOUND error is + returned. """ target_site: gcd_site_search_engine.TargetSite = proto.Field( @@ -225,7 +240,8 @@ class UpdateTargetSiteRequest(proto.Message): class UpdateTargetSiteMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.UpdateTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.UpdateTargetSite] + `SiteSearchEngineService.UpdateTargetSite + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -251,23 +267,27 @@ class UpdateTargetSiteMetadata(proto.Message): class DeleteTargetSiteRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DeleteTargetSite] + `SiteSearchEngineService.DeleteTargetSite + `__ method. Attributes: name (str): Required. Full resource name of - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}``. - If the caller does not have permission to access the - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. + If the caller does not have permission to access + the `TargetSite + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. If the requested - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] + `TargetSite + `__ does not exist, a NOT_FOUND error is returned. """ @@ -279,7 +299,8 @@ class DeleteTargetSiteRequest(proto.Message): class DeleteTargetSiteMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DeleteTargetSite] + `SiteSearchEngineService.DeleteTargetSite + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -305,34 +326,39 @@ class DeleteTargetSiteMetadata(proto.Message): class ListTargetSitesRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.ListTargetSites] + `SiteSearchEngineService.ListTargetSites + `__ method. Attributes: parent (str): - Required. The parent site search engine resource name, such - as + Required. The parent site search engine resource + name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. If the caller does not have permission to list - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]s - under this site search engine, regardless of whether or not - this branch exists, a PERMISSION_DENIED error is returned. + `TargetSite + `__s + under this site search engine, regardless of + whether or not this branch exists, a + PERMISSION_DENIED error is returned. page_size (int): - Requested page size. Server may return fewer items than - requested. If unspecified, server will pick an appropriate - default. The maximum value is 1000; values above 1000 will - be coerced to 1000. + Requested page size. Server may return fewer + items than requested. If unspecified, server + will pick an appropriate default. The maximum + value is 1000; values above 1000 will be coerced + to 1000. - If this field is negative, an INVALID_ARGUMENT error is - returned. + If this field is negative, an INVALID_ARGUMENT + error is returned. page_token (str): - A page token, received from a previous ``ListTargetSites`` - call. Provide this to retrieve the subsequent page. + A page token, received from a previous + ``ListTargetSites`` call. Provide this to + retrieve the subsequent page. - When paginating, all other parameters provided to - ``ListTargetSites`` must match the call that provided the - page token. + When paginating, all other parameters provided + to ``ListTargetSites`` must match the call that + provided the page token. """ parent: str = proto.Field( @@ -351,16 +377,17 @@ class ListTargetSitesRequest(proto.Message): class ListTargetSitesResponse(proto.Message): r"""Response message for - [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.ListTargetSites] + `SiteSearchEngineService.ListTargetSites + `__ method. Attributes: target_sites (MutableSequence[google.cloud.discoveryengine_v1alpha.types.TargetSite]): List of TargetSites. next_page_token (str): - A token that can be sent as ``page_token`` to retrieve the - next page. If this field is omitted, there are no subsequent - pages. + A token that can be sent as ``page_token`` to + retrieve the next page. If this field is + omitted, there are no subsequent pages. total_size (int): The total number of items matching the request. This will always be populated in the @@ -390,7 +417,8 @@ def raw_page(self): class BatchCreateTargetSiteMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchCreateTargetSites] + `SiteSearchEngineService.BatchCreateTargetSites + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -416,7 +444,8 @@ class BatchCreateTargetSiteMetadata(proto.Message): class BatchCreateTargetSitesResponse(proto.Message): r"""Response message for - [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchCreateTargetSites] + `SiteSearchEngineService.BatchCreateTargetSites + `__ method. Attributes: @@ -435,13 +464,15 @@ class BatchCreateTargetSitesResponse(proto.Message): class EnableAdvancedSiteSearchRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.EnableAdvancedSiteSearch] + `SiteSearchEngineService.EnableAdvancedSiteSearch + `__ method. Attributes: site_search_engine (str): Required. Full resource name of the - [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine``. """ @@ -454,7 +485,8 @@ class EnableAdvancedSiteSearchRequest(proto.Message): class EnableAdvancedSiteSearchResponse(proto.Message): r"""Response message for - [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.EnableAdvancedSiteSearch] + `SiteSearchEngineService.EnableAdvancedSiteSearch + `__ method. """ @@ -462,7 +494,8 @@ class EnableAdvancedSiteSearchResponse(proto.Message): class EnableAdvancedSiteSearchMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.EnableAdvancedSiteSearch] + `SiteSearchEngineService.EnableAdvancedSiteSearch + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -488,13 +521,15 @@ class EnableAdvancedSiteSearchMetadata(proto.Message): class DisableAdvancedSiteSearchRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DisableAdvancedSiteSearch] + `SiteSearchEngineService.DisableAdvancedSiteSearch + `__ method. Attributes: site_search_engine (str): Required. Full resource name of the - [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine``. """ @@ -507,7 +542,8 @@ class DisableAdvancedSiteSearchRequest(proto.Message): class DisableAdvancedSiteSearchResponse(proto.Message): r"""Response message for - [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DisableAdvancedSiteSearch] + `SiteSearchEngineService.DisableAdvancedSiteSearch + `__ method. """ @@ -515,7 +551,8 @@ class DisableAdvancedSiteSearchResponse(proto.Message): class DisableAdvancedSiteSearchMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DisableAdvancedSiteSearch] + `SiteSearchEngineService.DisableAdvancedSiteSearch + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -541,20 +578,23 @@ class DisableAdvancedSiteSearchMetadata(proto.Message): class RecrawlUrisRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.RecrawlUris] + `SiteSearchEngineService.RecrawlUris + `__ method. Attributes: site_search_engine (str): Required. Full resource name of the - [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine``. uris (MutableSequence[str]): - Required. List of URIs to crawl. At most 10K URIs are - supported, otherwise an INVALID_ARGUMENT error is thrown. - Each URI should match at least one - [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] + Required. List of URIs to crawl. At most 10K + URIs are supported, otherwise an + INVALID_ARGUMENT error is thrown. Each URI + should match at least one `TargetSite + `__ in ``site_search_engine``. """ @@ -570,12 +610,14 @@ class RecrawlUrisRequest(proto.Message): class RecrawlUrisResponse(proto.Message): r"""Response message for - [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.RecrawlUris] + `SiteSearchEngineService.RecrawlUris + `__ method. Attributes: failure_samples (MutableSequence[google.cloud.discoveryengine_v1alpha.types.RecrawlUrisResponse.FailureInfo]): - Details for a sample of up to 10 ``failed_uris``. + Details for a sample of up to 10 + ``failed_uris``. failed_uris (MutableSequence[str]): URIs that were not crawled before the LRO terminated. @@ -659,7 +701,8 @@ class CorpusType(proto.Enum): class RecrawlUrisMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.RecrawlUris] + `SiteSearchEngineService.RecrawlUris + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -675,8 +718,8 @@ class RecrawlUrisMetadata(proto.Message): TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE. valid_uris_count (int): - Total number of unique URIs in the request that are not in - invalid_uris. + Total number of unique URIs in the request that + are not in invalid_uris. success_count (int): Total number of URIs that have been crawled so far. @@ -722,13 +765,14 @@ class RecrawlUrisMetadata(proto.Message): class BatchVerifyTargetSitesRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchVerifyTargetSites] + `SiteSearchEngineService.BatchVerifyTargetSites + `__ method. Attributes: parent (str): - Required. The parent resource shared by all TargetSites - being verified. + Required. The parent resource shared by all + TargetSites being verified. ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. """ @@ -740,7 +784,8 @@ class BatchVerifyTargetSitesRequest(proto.Message): class BatchVerifyTargetSitesResponse(proto.Message): r"""Response message for - [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchVerifyTargetSites] + `SiteSearchEngineService.BatchVerifyTargetSites + `__ method. """ @@ -748,7 +793,8 @@ class BatchVerifyTargetSitesResponse(proto.Message): class BatchVerifyTargetSitesMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchVerifyTargetSites] + `SiteSearchEngineService.BatchVerifyTargetSites + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -774,30 +820,33 @@ class BatchVerifyTargetSitesMetadata(proto.Message): class FetchDomainVerificationStatusRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.FetchDomainVerificationStatus] + `SiteSearchEngineService.FetchDomainVerificationStatus + `__ method. Attributes: site_search_engine (str): - Required. The site search engine resource under which we - fetch all the domain verification status. + Required. The site search engine resource under + which we fetch all the domain verification + status. ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. page_size (int): - Requested page size. Server may return fewer items than - requested. If unspecified, server will pick an appropriate - default. The maximum value is 1000; values above 1000 will - be coerced to 1000. + Requested page size. Server may return fewer + items than requested. If unspecified, server + will pick an appropriate default. The maximum + value is 1000; values above 1000 will be coerced + to 1000. - If this field is negative, an INVALID_ARGUMENT error is - returned. + If this field is negative, an INVALID_ARGUMENT + error is returned. page_token (str): A page token, received from a previous - ``FetchDomainVerificationStatus`` call. Provide this to - retrieve the subsequent page. + ``FetchDomainVerificationStatus`` call. Provide + this to retrieve the subsequent page. - When paginating, all other parameters provided to - ``FetchDomainVerificationStatus`` must match the call that - provided the page token. + When paginating, all other parameters provided + to ``FetchDomainVerificationStatus`` must match + the call that provided the page token. """ site_search_engine: str = proto.Field( @@ -816,7 +865,8 @@ class FetchDomainVerificationStatusRequest(proto.Message): class FetchDomainVerificationStatusResponse(proto.Message): r"""Response message for - [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.FetchDomainVerificationStatus] + `SiteSearchEngineService.FetchDomainVerificationStatus + `__ method. Attributes: @@ -824,9 +874,9 @@ class FetchDomainVerificationStatusResponse(proto.Message): List of TargetSites containing the site verification status. next_page_token (str): - A token that can be sent as ``page_token`` to retrieve the - next page. If this field is omitted, there are no subsequent - pages. + A token that can be sent as ``page_token`` to + retrieve the next page. If this field is + omitted, there are no subsequent pages. total_size (int): The total number of items matching the request. This will always be populated in the @@ -856,38 +906,57 @@ def raw_page(self): class SetUriPatternDocumentDataRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.SetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData] + `SiteSearchEngineService.SetUriPatternDocumentData + `__ method. Attributes: site_search_engine (str): Required. Full resource name of the - [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine``. document_data_map (MutableMapping[str, google.protobuf.struct_pb2.Struct]): - Document data keyed by URI pattern. Each entry must be - consistent with the - [Schema][google.cloud.discoveryengine.v1alpha.Schema]. For - example: - [Schema][google.cloud.discoveryengine.v1alpha.Schema] = { - "type": "object", "properties": { "Categories": { "type": - "array", "items": { "retrievable": true, "type": "string" } - } } - - document_data_map = { "www.url1.com/*": { "Categories": - ["category1", "category2"] }, "www.url2.com/*": { - "Categories": ["category3"] } } + Document data keyed by URI pattern. Each entry + must be consistent with the `Schema + `__. + For example: + + `Schema + `__ + = { "type": "object", + "properties": { + "Categories": { + "type": "array", + "items": { + "retrievable": true, + "type": "string" + } + } + } + + document_data_map = { + "www.url1.com/*": { + "Categories": ["category1", "category2"] + }, + "www.url2.com/*": { + "Categories": ["category3"] + } + } empty_document_data_map (bool): If true, clears the document data map. If true, - [SetUriPatternDocumentDataRequest.document_data_map][google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataRequest.document_data_map] + `SetUriPatternDocumentDataRequest.document_data_map + `__ must be empty. schema (google.protobuf.struct_pb2.Struct): Optional. If not provided, the current - [Schema][google.cloud.discoveryengine.v1alpha.Schema] is - used. If provided, validates and updates the - [Schema][google.cloud.discoveryengine.v1alpha.Schema]. If - validation fails, an error is returned. + `Schema + `__ + is used. If provided, validates and updates the + `Schema + `__. + If validation fails, an error is returned. """ site_search_engine: str = proto.Field( @@ -913,7 +982,8 @@ class SetUriPatternDocumentDataRequest(proto.Message): class SetUriPatternDocumentDataResponse(proto.Message): r"""Response message for - [SiteSearchEngineService.SetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData] + `SiteSearchEngineService.SetUriPatternDocumentData + `__ method. """ @@ -921,7 +991,8 @@ class SetUriPatternDocumentDataResponse(proto.Message): class SetUriPatternDocumentDataMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.SetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData] + `SiteSearchEngineService.SetUriPatternDocumentData + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -947,13 +1018,15 @@ class SetUriPatternDocumentDataMetadata(proto.Message): class GetUriPatternDocumentDataRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.GetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetUriPatternDocumentData] + `SiteSearchEngineService.GetUriPatternDocumentData + `__ method. Attributes: site_search_engine (str): Required. Full resource name of the - [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine``. """ @@ -966,15 +1039,21 @@ class GetUriPatternDocumentDataRequest(proto.Message): class GetUriPatternDocumentDataResponse(proto.Message): r"""Response message for - [SiteSearchEngineService.GetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetUriPatternDocumentData] + `SiteSearchEngineService.GetUriPatternDocumentData + `__ method. Attributes: document_data_map (MutableMapping[str, google.protobuf.struct_pb2.Struct]): Document data keyed by URI pattern. For example: - document_data_map = { "www.url1.com/*": { "Categories": - ["category1", "category2"] }, "www.url2.com/*": { - "Categories": ["category3"] } } + document_data_map = { + "www.url1.com/*": { + "Categories": ["category1", "category2"] + }, + "www.url2.com/*": { + "Categories": ["category3"] + } + } """ document_data_map: MutableMapping[str, struct_pb2.Struct] = proto.MapField( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/user_event.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/user_event.py index 8b04f0b4a5ba..34394c51629d 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/user_event.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/user_event.py @@ -49,189 +49,226 @@ class UserEvent(proto.Message): Generic values: - - ``search``: Search for Documents. - - ``view-item``: Detailed page view of a Document. - - ``view-item-list``: View of a panel or ordered list of - Documents. - - ``view-home-page``: View of the home page. - - ``view-category-page``: View of a category page, e.g. Home - > Men > Jeans + * ``search``: Search for Documents. + * ``view-item``: Detailed page view of a + Document. + + * ``view-item-list``: View of a panel or ordered + list of Documents. * ``view-home-page``: View of + the home page. + + * ``view-category-page``: View of a category + page, e.g. Home > Men > Jeans Retail-related values: - - ``add-to-cart``: Add an item(s) to cart, e.g. in Retail - online shopping - - ``purchase``: Purchase an item(s) + * ``add-to-cart``: Add an item(s) to cart, e.g. + in Retail online shopping * ``purchase``: + Purchase an item(s) Media-related values: - - ``media-play``: Start/resume watching a video, playing a - song, etc. - - ``media-complete``: Finished or stopped midway through a - video, song, etc. + * ``media-play``: Start/resume watching a video, + playing a song, etc. * ``media-complete``: + Finished or stopped midway through a video, + song, etc. user_pseudo_id (str): - Required. A unique identifier for tracking visitors. - - For example, this could be implemented with an HTTP cookie, - which should be able to uniquely identify a visitor on a - single device. This unique identifier should not change if - the visitor log in/out of the website. - - Do not set the field to the same fixed ID for different - users. This mixes the event history of those users together, - which results in degraded model quality. - - The field must be a UTF-8 encoded string with a length limit - of 128 characters. Otherwise, an ``INVALID_ARGUMENT`` error - is returned. + Required. A unique identifier for tracking + visitors. + For example, this could be implemented with an + HTTP cookie, which should be able to uniquely + identify a visitor on a single device. This + unique identifier should not change if the + visitor log in/out of the website. + + Do not set the field to the same fixed ID for + different users. This mixes the event history of + those users together, which results in degraded + model quality. + + The field must be a UTF-8 encoded string with a + length limit of 128 characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. - The field should not contain PII or user-data. We recommend - to use Google Analytics `Client - ID `__ + The field should not contain PII or user-data. + We recommend to use Google Analytics `Client + ID + `__ for this field. engine (str): - The [Engine][google.cloud.discoveryengine.v1alpha.Engine] + The `Engine + `__ resource name, in the form of ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. Optional. Only required for - [Engine][google.cloud.discoveryengine.v1alpha.Engine] - produced user events. For example, user events from blended - search. + `Engine + `__ + produced user events. For example, user events + from blended search. data_store (str): - The - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] + The `DataStore + `__ resource full name, of the form ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. - Optional. Only required for user events whose data store - can't by determined by - [UserEvent.engine][google.cloud.discoveryengine.v1alpha.UserEvent.engine] + Optional. Only required for user events whose + data store can't by determined by + `UserEvent.engine + `__ or - [UserEvent.documents][google.cloud.discoveryengine.v1alpha.UserEvent.documents]. - If data store is set in the parent of write/import/collect - user event requests, this field can be omitted. + `UserEvent.documents + `__. + If data store is set in the parent of + write/import/collect user event requests, this + field can be omitted. event_time (google.protobuf.timestamp_pb2.Timestamp): Only required for - [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvents] - method. Timestamp of when the user event happened. + `UserEventService.ImportUserEvents + `__ + method. Timestamp of when the user event + happened. user_info (google.cloud.discoveryengine_v1alpha.types.UserInfo): Information about the end user. direct_user_request (bool): - Should set to true if the request is made directly from the - end user, in which case the - [UserEvent.user_info.user_agent][google.cloud.discoveryengine.v1alpha.UserInfo.user_agent] + Should set to true if the request is made + directly from the end user, in which case the + `UserEvent.user_info.user_agent + `__ can be populated from the HTTP request. - This flag should be set only if the API request is made - directly from the end user such as a mobile app (and not if - a gateway or a server is processing and pushing the user - events). + This flag should be set only if the API request + is made directly from the end user such as a + mobile app (and not if a gateway or a server is + processing and pushing the user events). - This should not be set when using the JavaScript tag in - [UserEventService.CollectUserEvent][google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent]. + This should not be set when using the JavaScript + tag in `UserEventService.CollectUserEvent + `__. session_id (str): - A unique identifier for tracking a visitor session with a - length limit of 128 bytes. A session is an aggregation of an - end user behavior in a time span. + A unique identifier for tracking a visitor + session with a length limit of 128 bytes. A + session is an aggregation of an end user + behavior in a time span. A general guideline to populate the session_id: - 1. If user has no activity for 30 min, a new session_id - should be assigned. - 2. The session_id should be unique across users, suggest use - uuid or add - [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1alpha.UserEvent.user_pseudo_id] - as prefix. + 1. If user has no activity for 30 min, a new + session_id should be assigned. + 2. The session_id should be unique across users, + suggest use uuid or add + `UserEvent.user_pseudo_id + `__ + as prefix. page_info (google.cloud.discoveryengine_v1alpha.types.PageInfo): - Page metadata such as categories and other critical - information for certain event types such as - ``view-category-page``. + Page metadata such as categories and other + critical information for certain event types + such as ``view-category-page``. attribution_token (str): - Token to attribute an API response to user action(s) to - trigger the event. - - Highly recommended for user events that are the result of - [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend]. - This field enables accurate attribution of recommendation - model performance. + Token to attribute an API response to user + action(s) to trigger the event. + Highly recommended for user events that are the + result of `RecommendationService.Recommend + `__. + This field enables accurate attribution of + recommendation model performance. The value must be one of: - - [RecommendResponse.attribution_token][google.cloud.discoveryengine.v1alpha.RecommendResponse.attribution_token] - for events that are the result of - [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend]. - - [SearchResponse.attribution_token][google.cloud.discoveryengine.v1alpha.SearchResponse.attribution_token] - for events that are the result of - [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search]. - - This token enables us to accurately attribute page view or - conversion completion back to the event and the particular - predict response containing this clicked/purchased product. - If user clicks on product K in the recommendation results, - pass - [RecommendResponse.attribution_token][google.cloud.discoveryengine.v1alpha.RecommendResponse.attribution_token] - as a URL parameter to product K's page. When recording - events on product K's page, log the - [RecommendResponse.attribution_token][google.cloud.discoveryengine.v1alpha.RecommendResponse.attribution_token] + * `RecommendResponse.attribution_token + `__ + for events that are the result of + `RecommendationService.Recommend + `__. + + * `SearchResponse.attribution_token + `__ + for events that are the result of + `SearchService.Search + `__. + + This token enables us to accurately attribute + page view or conversion completion back to the + event and the particular predict response + containing this clicked/purchased product. If + user clicks on product K in the recommendation + results, pass + `RecommendResponse.attribution_token + `__ + as a URL parameter to product K's page. When + recording events on product K's page, log the + `RecommendResponse.attribution_token + `__ to this field. filter (str): - The filter syntax consists of an expression language for - constructing a predicate from one or more fields of the - documents being filtered. + The filter syntax consists of an expression + language for constructing a predicate from one + or more fields of the documents being filtered. - One example is for ``search`` events, the associated - [SearchRequest][google.cloud.discoveryengine.v1alpha.SearchRequest] + One example is for ``search`` events, the + associated `SearchRequest + `__ may contain a filter expression in - [SearchRequest.filter][google.cloud.discoveryengine.v1alpha.SearchRequest.filter] - conforming to https://google.aip.dev/160#filtering. - - Similarly, for ``view-item-list`` events that are generated - from a - [RecommendRequest][google.cloud.discoveryengine.v1alpha.RecommendRequest], + `SearchRequest.filter + `__ + conforming to + https://google.aip.dev/160#filtering. + + Similarly, for ``view-item-list`` events that + are generated from a `RecommendRequest + `__, this field may be populated directly from - [RecommendRequest.filter][google.cloud.discoveryengine.v1alpha.RecommendRequest.filter] - conforming to https://google.aip.dev/160#filtering. + `RecommendRequest.filter + `__ + conforming to + https://google.aip.dev/160#filtering. - The value must be a UTF-8 encoded string with a length limit - of 1,000 characters. Otherwise, an ``INVALID_ARGUMENT`` - error is returned. + The value must be a UTF-8 encoded string with a + length limit of 1,000 characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. documents (MutableSequence[google.cloud.discoveryengine_v1alpha.types.DocumentInfo]): - List of - [Document][google.cloud.discoveryengine.v1alpha.Document]s + List of `Document + `__s associated with this user event. - This field is optional except for the following event types: - - - ``view-item`` - - ``add-to-cart`` - - ``purchase`` - - ``media-play`` - - ``media-complete`` - - In a ``search`` event, this field represents the documents - returned to the end user on the current page (the end user - may have not finished browsing the whole page yet). When a - new page is returned to the end user, after - pagination/filtering/ordering even for the same query, a new - ``search`` event with different - [UserEvent.documents][google.cloud.discoveryengine.v1alpha.UserEvent.documents] + This field is optional except for the following + event types: + + * ``view-item`` + * ``add-to-cart`` + + * ``purchase`` + * ``media-play`` + + * ``media-complete`` + + In a ``search`` event, this field represents the + documents returned to the end user on the + current page (the end user may have not finished + browsing the whole page yet). When a new page is + returned to the end user, after + pagination/filtering/ordering even for the same + query, a new ``search`` event with different + `UserEvent.documents + `__ is desired. panel (google.cloud.discoveryengine_v1alpha.types.PanelInfo): Panel metadata associated with this user event. search_info (google.cloud.discoveryengine_v1alpha.types.SearchInfo): - [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search] + `SearchService.Search + `__ details related to the event. This field should be set for ``search`` event. completion_info (google.cloud.discoveryengine_v1alpha.types.CompletionInfo): - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery] + `CompletionService.CompleteQuery + `__ details related to the event. - This field should be set for ``search`` event when - autocomplete function is enabled and the user clicks a - suggestion for search. + This field should be set for ``search`` event + when autocomplete function is enabled and the + user clicks a suggestion for search. transaction_info (google.cloud.discoveryengine_v1alpha.types.TransactionInfo): The transaction metadata (if any) associated with this user event. @@ -245,34 +282,42 @@ class UserEvent(proto.Message): associated with promotions. Currently, this field is restricted to at most one ID. attributes (MutableMapping[str, google.cloud.discoveryengine_v1alpha.types.CustomAttribute]): - Extra user event features to include in the recommendation - model. These attributes must NOT contain data that needs to - be parsed or processed further, e.g. JSON or other - encodings. - - If you provide custom attributes for ingested user events, - also include them in the user events that you associate with - prediction requests. Custom attribute formatting must be - consistent between imported events and events provided with - prediction requests. This lets the Discovery Engine API use - those custom attributes when training models and serving - predictions, which helps improve recommendation quality. - - This field needs to pass all below criteria, otherwise an - ``INVALID_ARGUMENT`` error is returned: - - - The key must be a UTF-8 encoded string with a length limit - of 5,000 characters. - - For text attributes, at most 400 values are allowed. Empty - values are not allowed. Each value must be a UTF-8 encoded - string with a length limit of 256 characters. - - For number attributes, at most 400 values are allowed. - - For product recommendations, an example of extra user - information is ``traffic_channel``, which is how a user - arrives at the site. Users can arrive at the site by coming - to the site directly, coming through Google search, or in - other ways. + Extra user event features to include in the + recommendation model. These attributes must NOT + contain data that needs to be parsed or + processed further, e.g. JSON or other encodings. + + If you provide custom attributes for ingested + user events, also include them in the user + events that you associate with prediction + requests. Custom attribute formatting must be + consistent between imported events and events + provided with prediction requests. This lets the + Discovery Engine API use those custom attributes + when training models and serving predictions, + which helps improve recommendation quality. + + This field needs to pass all below criteria, + otherwise an ``INVALID_ARGUMENT`` error is + returned: + + * The key must be a UTF-8 encoded string with a + length limit of 5,000 characters. + + * For text attributes, at most 400 values are + allowed. Empty values are not allowed. Each + value must be a UTF-8 encoded string with a + length limit of 256 characters. + + * For number attributes, at most 400 values are + allowed. + + For product recommendations, an example of extra + user information is ``traffic_channel``, which + is how a user arrives at the site. Users can + arrive + at the site by coming to the site directly, + coming through Google search, or in other ways. media_info (google.cloud.discoveryengine_v1alpha.types.MediaInfo): Media-specific info. """ @@ -377,31 +422,36 @@ class PageInfo(proto.Message): pageview_id (str): A unique ID of a web page view. - This should be kept the same for all user events triggered - from the same pageview. For example, an item detail page - view could trigger multiple events as the user is browsing - the page. The ``pageview_id`` property should be kept the - same for all these events so that they can be grouped + This should be kept the same for all user events + triggered from the same pageview. For example, + an item detail page view could trigger multiple + events as the user is browsing the page. The + ``pageview_id`` property should be kept the same + for all these events so that they can be grouped together properly. - When using the client side event reporting with JavaScript - pixel and Google Tag Manager, this value is filled in - automatically. + When using the client side event reporting with + JavaScript pixel and Google Tag Manager, this + value is filled in automatically. page_category (str): - The most specific category associated with a category page. - - To represent full path of category, use '>' sign to separate - different hierarchies. If '>' is part of the category name, - replace it with other character(s). - - Category pages include special pages such as sales or - promotions. For instance, a special sale page may have the - category hierarchy: - ``"pageCategory" : "Sales > 2017 Black Friday Deals"``. - - Required for ``view-category-page`` events. Other event - types should not set this field. Otherwise, an - ``INVALID_ARGUMENT`` error is returned. + The most specific category associated with a + category page. + To represent full path of category, use '>' sign + to separate different hierarchies. If '>' is + part of the category name, replace it with other + character(s). + + Category pages include special pages such as + sales or promotions. For instance, a special + sale page may have the category hierarchy: + + ``"pageCategory" : "Sales > 2017 Black Friday + Deals"``. + + Required for ``view-category-page`` events. + Other event types should not set this field. + Otherwise, an ``INVALID_ARGUMENT`` error is + returned. uri (str): Complete URL (window.location.href) of the user's current page. @@ -447,49 +497,57 @@ class SearchInfo(proto.Message): The user's search query. See - [SearchRequest.query][google.cloud.discoveryengine.v1alpha.SearchRequest.query] + `SearchRequest.query + `__ for definition. - The value must be a UTF-8 encoded string with a length limit - of 5,000 characters. Otherwise, an ``INVALID_ARGUMENT`` - error is returned. + The value must be a UTF-8 encoded string with a + length limit of 5,000 characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. At least one of - [search_query][google.cloud.discoveryengine.v1alpha.SearchInfo.search_query] + `search_query + `__ or - [PageInfo.page_category][google.cloud.discoveryengine.v1alpha.PageInfo.page_category] - is required for ``search`` events. Other event types should - not set this field. Otherwise, an ``INVALID_ARGUMENT`` error - is returned. + `PageInfo.page_category + `__ + is required for ``search`` events. Other event + types should not set this field. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. order_by (str): - The order in which products are returned, if applicable. - + The order in which products are returned, if + applicable. See - [SearchRequest.order_by][google.cloud.discoveryengine.v1alpha.SearchRequest.order_by] + `SearchRequest.order_by + `__ for definition and syntax. - The value must be a UTF-8 encoded string with a length limit - of 1,000 characters. Otherwise, an ``INVALID_ARGUMENT`` - error is returned. - - This can only be set for ``search`` events. Other event - types should not set this field. Otherwise, an + The value must be a UTF-8 encoded string with a + length limit of 1,000 characters. Otherwise, an ``INVALID_ARGUMENT`` error is returned. + + This can only be set for ``search`` events. + Other event types should not set this field. + Otherwise, an ``INVALID_ARGUMENT`` error is + returned. offset (int): - An integer that specifies the current offset for pagination - (the 0-indexed starting location, amongst the products - deemed by the API as relevant). + An integer that specifies the current offset for + pagination (the 0-indexed starting location, + amongst the products deemed by the API as + relevant). See - [SearchRequest.offset][google.cloud.discoveryengine.v1alpha.SearchRequest.offset] + `SearchRequest.offset + `__ for definition. - If this field is negative, an ``INVALID_ARGUMENT`` is - returned. + If this field is negative, an + ``INVALID_ARGUMENT`` is returned. - This can only be set for ``search`` events. Other event - types should not set this field. Otherwise, an - ``INVALID_ARGUMENT`` error is returned. + This can only be set for ``search`` events. + Other event types should not set this field. + Otherwise, an ``INVALID_ARGUMENT`` error is + returned. This field is a member of `oneof`_ ``_offset``. """ @@ -516,10 +574,12 @@ class CompletionInfo(proto.Message): Attributes: selected_suggestion (str): End user selected - [CompleteQueryResponse.QuerySuggestion.suggestion][google.cloud.discoveryengine.v1alpha.CompleteQueryResponse.QuerySuggestion.suggestion]. + `CompleteQueryResponse.QuerySuggestion.suggestion + `__. selected_position (int): End user selected - [CompleteQueryResponse.QuerySuggestion.suggestion][google.cloud.discoveryengine.v1alpha.CompleteQueryResponse.QuerySuggestion.suggestion] + `CompleteQueryResponse.QuerySuggestion.suggestion + `__ position, starting from 0. """ @@ -558,43 +618,51 @@ class TransactionInfo(proto.Message): This field is a member of `oneof`_ ``_tax``. cost (float): - All the costs associated with the products. These can be - manufacturing costs, shipping expenses not borne by the end - user, or any other costs, such that: - - - Profit = - [value][google.cloud.discoveryengine.v1alpha.TransactionInfo.value] - - - [tax][google.cloud.discoveryengine.v1alpha.TransactionInfo.tax] - - - [cost][google.cloud.discoveryengine.v1alpha.TransactionInfo.cost] + All the costs associated with the products. + These can be manufacturing costs, shipping + expenses not borne by the end user, or any other + costs, such that: + + * Profit = + `value + `__ + - `tax + `__ + - `cost + `__ This field is a member of `oneof`_ ``_cost``. discount_value (float): - The total discount(s) value applied to this transaction. - This figure should be excluded from - [TransactionInfo.value][google.cloud.discoveryengine.v1alpha.TransactionInfo.value] + The total discount(s) value applied to this + transaction. This figure should be excluded from + `TransactionInfo.value + `__ For example, if a user paid - [TransactionInfo.value][google.cloud.discoveryengine.v1alpha.TransactionInfo.value] - amount, then nominal (pre-discount) value of the transaction - is the sum of - [TransactionInfo.value][google.cloud.discoveryengine.v1alpha.TransactionInfo.value] + `TransactionInfo.value + `__ + amount, then nominal (pre-discount) value of the + transaction is the sum of `TransactionInfo.value + `__ and - [TransactionInfo.discount_value][google.cloud.discoveryengine.v1alpha.TransactionInfo.discount_value] + `TransactionInfo.discount_value + `__ - This means that profit is calculated the same way, - regardless of the discount value, and that - [TransactionInfo.discount_value][google.cloud.discoveryengine.v1alpha.TransactionInfo.discount_value] + This means that profit is calculated the same + way, regardless of the discount value, and that + `TransactionInfo.discount_value + `__ can be larger than - [TransactionInfo.value][google.cloud.discoveryengine.v1alpha.TransactionInfo.value]: + `TransactionInfo.value + `__: - - Profit = - [value][google.cloud.discoveryengine.v1alpha.TransactionInfo.value] - - - [tax][google.cloud.discoveryengine.v1alpha.TransactionInfo.tax] - - - [cost][google.cloud.discoveryengine.v1alpha.TransactionInfo.cost] + * Profit = + `value + `__ + - `tax + `__ + - `cost + `__ This field is a member of `oneof`_ ``_discount_value``. """ @@ -641,35 +709,37 @@ class DocumentInfo(proto.Message): Attributes: id (str): - The - [Document][google.cloud.discoveryengine.v1alpha.Document] + The `Document + `__ resource ID. This field is a member of `oneof`_ ``document_descriptor``. name (str): - The - [Document][google.cloud.discoveryengine.v1alpha.Document] + The `Document + `__ resource full name, of the form: + ``projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`` This field is a member of `oneof`_ ``document_descriptor``. uri (str): - The - [Document][google.cloud.discoveryengine.v1alpha.Document] + The `Document + `__ URI - only allowed for website data stores. This field is a member of `oneof`_ ``document_descriptor``. quantity (int): - Quantity of the Document associated with the user event. - Defaults to 1. - - For example, this field is 2 if two quantities of the same - Document are involved in a ``add-to-cart`` event. + Quantity of the Document associated with the + user event. Defaults to 1. + For example, this field is 2 if two quantities + of the same Document are involved in a + ``add-to-cart`` event. - Required for events of the following event types: + Required for events of the following event + types: - - ``add-to-cart`` - - ``purchase`` + * ``add-to-cart`` + * ``purchase`` This field is a member of `oneof`_ ``_quantity``. promotion_ids (MutableSequence[str]): @@ -722,16 +792,18 @@ class PanelInfo(proto.Message): display_name (str): The display name of the panel. panel_position (int): - The ordered position of the panel, if shown to the user with - other panels. If set, then - [total_panels][google.cloud.discoveryengine.v1alpha.PanelInfo.total_panels] + The ordered position of the panel, if shown to + the user with other panels. If set, then + `total_panels + `__ must also be set. This field is a member of `oneof`_ ``_panel_position``. total_panels (int): - The total number of panels, including this one, shown to the - user. Must be set if - [panel_position][google.cloud.discoveryengine.v1alpha.PanelInfo.panel_position] + The total number of panels, including this one, + shown to the user. Must be set if + `panel_position + `__ is set. This field is a member of `oneof`_ ``_total_panels``. @@ -764,20 +836,24 @@ class MediaInfo(proto.Message): Attributes: media_progress_duration (google.protobuf.duration_pb2.Duration): - The media progress time in seconds, if applicable. For - example, if the end user has finished 90 seconds of a - playback video, then - [MediaInfo.media_progress_duration.seconds][google.protobuf.Duration.seconds] - should be set to 90. + The media progress time in seconds, if + applicable. For example, if the end user has + finished 90 seconds of a playback video, then + `MediaInfo.media_progress_duration.seconds + `__ should be + set to 90. media_progress_percentage (float): Media progress should be computed using only the - [media_progress_duration][google.cloud.discoveryengine.v1alpha.MediaInfo.media_progress_duration] + `media_progress_duration + `__ relative to the media total length. - This value must be between ``[0, 1.0]`` inclusive. + This value must be between ``[0, 1.0]`` + inclusive. - If this is not a playback or the progress cannot be computed - (e.g. ongoing livestream), this field should be unset. + If this is not a playback or the progress cannot + be computed (e.g. ongoing livestream), this + field should be unset. This field is a member of `oneof`_ ``_media_progress_percentage``. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/user_event_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/user_event_service.py index 41c480fb642d..45b7f1b3f846 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/user_event_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1alpha/types/user_event_service.py @@ -37,17 +37,22 @@ class WriteUserEventRequest(proto.Message): Attributes: parent (str): - Required. The parent resource name. If the write user event - action is applied in - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore] + Required. The parent resource name. + If the write user event action is applied in + `DataStore + `__ level, the format is: + ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}``. - If the write user event action is applied in [Location][] - level, for example, the event with - [Document][google.cloud.discoveryengine.v1alpha.Document] - across multiple - [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], - the format is: ``projects/{project}/locations/{location}``. + If the write user event action is applied in + [Location][] level, for example, the event with + `Document + `__ + across multiple `DataStore + `__, + the format is: + + ``projects/{project}/locations/{location}``. user_event (google.cloud.discoveryengine_v1alpha.types.UserEvent): Required. User event to write. @@ -81,7 +86,8 @@ class CollectUserEventRequest(proto.Message): Attributes: parent (str): - Required. The parent DataStore resource name, such as + Required. The parent DataStore resource name, + such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}``. user_event (str): Required. URL encoded UserEvent proto with a diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/gapic_version.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/gapic_version.py index 6b356a66811e..fd79d4e761b7 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/gapic_version.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "0.15.0" # {x-release-please-version} +__version__ = "0.4.0" # {x-release-please-version} diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/completion_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/completion_service/async_client.py index 696b788ee215..e697fd23b9a4 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/completion_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/completion_service/async_client.py @@ -348,7 +348,8 @@ async def sample_complete_query(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.CompleteQueryRequest, dict]]): The request object. Request message for - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] + `CompletionService.CompleteQuery + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -361,8 +362,9 @@ async def sample_complete_query(): Returns: google.cloud.discoveryengine_v1beta.types.CompleteQueryResponse: Response message for - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] - method. + `CompletionService.CompleteQuery + `__ + method. """ # Create or coerce a protobuf request object. @@ -442,8 +444,10 @@ async def sample_advanced_complete_query(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.AdvancedCompleteQueryRequest, dict]]): The request object. Request message for - [CompletionService.AdvancedCompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.AdvancedCompleteQuery] - method. . + `CompletionService.AdvancedCompleteQuery + `__ + method. + . retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -455,8 +459,9 @@ async def sample_advanced_complete_query(): Returns: google.cloud.discoveryengine_v1beta.types.AdvancedCompleteQueryResponse: Response message for - [CompletionService.AdvancedCompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.AdvancedCompleteQuery] - method. + `CompletionService.AdvancedCompleteQuery + `__ + method. """ # Create or coerce a protobuf request object. @@ -504,7 +509,8 @@ async def import_suggestion_deny_list_entries( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: r"""Imports all - [SuggestionDenyListEntry][google.cloud.discoveryengine.v1beta.SuggestionDenyListEntry] + `SuggestionDenyListEntry + `__ for a DataStore. .. code-block:: python @@ -545,7 +551,8 @@ async def sample_import_suggestion_deny_list_entries(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.ImportSuggestionDenyListEntriesRequest, dict]]): The request object. Request message for - [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1beta.CompletionService.ImportSuggestionDenyListEntries] + `CompletionService.ImportSuggestionDenyListEntries + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -557,11 +564,15 @@ async def sample_import_suggestion_deny_list_entries(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.ImportSuggestionDenyListEntriesResponse` Response message for - [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1beta.CompletionService.ImportSuggestionDenyListEntries] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.ImportSuggestionDenyListEntriesResponse` + Response message for + `CompletionService.ImportSuggestionDenyListEntries + `__ + method. """ # Create or coerce a protobuf request object. @@ -617,7 +628,8 @@ async def purge_suggestion_deny_list_entries( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: r"""Permanently deletes all - [SuggestionDenyListEntry][google.cloud.discoveryengine.v1beta.SuggestionDenyListEntry] + `SuggestionDenyListEntry + `__ for a DataStore. .. code-block:: python @@ -653,7 +665,8 @@ async def sample_purge_suggestion_deny_list_entries(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.PurgeSuggestionDenyListEntriesRequest, dict]]): The request object. Request message for - [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1beta.CompletionService.PurgeSuggestionDenyListEntries] + `CompletionService.PurgeSuggestionDenyListEntries + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -665,11 +678,15 @@ async def sample_purge_suggestion_deny_list_entries(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.PurgeSuggestionDenyListEntriesResponse` Response message for - [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1beta.CompletionService.PurgeSuggestionDenyListEntries] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.PurgeSuggestionDenyListEntriesResponse` + Response message for + `CompletionService.PurgeSuggestionDenyListEntries + `__ + method. """ # Create or coerce a protobuf request object. @@ -723,7 +740,8 @@ async def import_completion_suggestions( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: r"""Imports - [CompletionSuggestion][google.cloud.discoveryengine.v1beta.CompletionSuggestion]s + `CompletionSuggestion + `__s for a DataStore. .. code-block:: python @@ -764,7 +782,8 @@ async def sample_import_completion_suggestions(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.ImportCompletionSuggestionsRequest, dict]]): The request object. Request message for - [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1beta.CompletionService.ImportCompletionSuggestions] + `CompletionService.ImportCompletionSuggestions + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -776,14 +795,18 @@ async def sample_import_completion_suggestions(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.ImportCompletionSuggestionsResponse` Response of the - [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1beta.CompletionService.ImportCompletionSuggestions] - method. If the long running operation is done, this - message is returned by the - google.longrunning.Operations.response field if the - operation is successful. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.ImportCompletionSuggestionsResponse` + Response of the + `CompletionService.ImportCompletionSuggestions + `__ + method. If the long running operation is + done, this message is returned by the + google.longrunning.Operations.response + field if the operation is successful. """ # Create or coerce a protobuf request object. @@ -837,7 +860,8 @@ async def purge_completion_suggestions( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: r"""Permanently deletes all - [CompletionSuggestion][google.cloud.discoveryengine.v1beta.CompletionSuggestion]s + `CompletionSuggestion + `__s for a DataStore. .. code-block:: python @@ -873,7 +897,8 @@ async def sample_purge_completion_suggestions(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.PurgeCompletionSuggestionsRequest, dict]]): The request object. Request message for - [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1beta.CompletionService.PurgeCompletionSuggestions] + `CompletionService.PurgeCompletionSuggestions + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -885,11 +910,15 @@ async def sample_purge_completion_suggestions(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.PurgeCompletionSuggestionsResponse` Response message for - [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1beta.CompletionService.PurgeCompletionSuggestions] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.PurgeCompletionSuggestionsResponse` + Response message for + `CompletionService.PurgeCompletionSuggestions + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/completion_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/completion_service/client.py index a586e8d99e41..80d3f02d44f6 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/completion_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/completion_service/client.py @@ -812,7 +812,8 @@ def sample_complete_query(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.CompleteQueryRequest, dict]): The request object. Request message for - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] + `CompletionService.CompleteQuery + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -825,8 +826,9 @@ def sample_complete_query(): Returns: google.cloud.discoveryengine_v1beta.types.CompleteQueryResponse: Response message for - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] - method. + `CompletionService.CompleteQuery + `__ + method. """ # Create or coerce a protobuf request object. @@ -904,8 +906,10 @@ def sample_advanced_complete_query(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.AdvancedCompleteQueryRequest, dict]): The request object. Request message for - [CompletionService.AdvancedCompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.AdvancedCompleteQuery] - method. . + `CompletionService.AdvancedCompleteQuery + `__ + method. + . retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -917,8 +921,9 @@ def sample_advanced_complete_query(): Returns: google.cloud.discoveryengine_v1beta.types.AdvancedCompleteQueryResponse: Response message for - [CompletionService.AdvancedCompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.AdvancedCompleteQuery] - method. + `CompletionService.AdvancedCompleteQuery + `__ + method. """ # Create or coerce a protobuf request object. @@ -964,7 +969,8 @@ def import_suggestion_deny_list_entries( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: r"""Imports all - [SuggestionDenyListEntry][google.cloud.discoveryengine.v1beta.SuggestionDenyListEntry] + `SuggestionDenyListEntry + `__ for a DataStore. .. code-block:: python @@ -1005,7 +1011,8 @@ def sample_import_suggestion_deny_list_entries(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.ImportSuggestionDenyListEntriesRequest, dict]): The request object. Request message for - [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1beta.CompletionService.ImportSuggestionDenyListEntries] + `CompletionService.ImportSuggestionDenyListEntries + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1017,11 +1024,15 @@ def sample_import_suggestion_deny_list_entries(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.ImportSuggestionDenyListEntriesResponse` Response message for - [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1beta.CompletionService.ImportSuggestionDenyListEntries] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.ImportSuggestionDenyListEntriesResponse` + Response message for + `CompletionService.ImportSuggestionDenyListEntries + `__ + method. """ # Create or coerce a protobuf request object. @@ -1077,7 +1088,8 @@ def purge_suggestion_deny_list_entries( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: r"""Permanently deletes all - [SuggestionDenyListEntry][google.cloud.discoveryengine.v1beta.SuggestionDenyListEntry] + `SuggestionDenyListEntry + `__ for a DataStore. .. code-block:: python @@ -1113,7 +1125,8 @@ def sample_purge_suggestion_deny_list_entries(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.PurgeSuggestionDenyListEntriesRequest, dict]): The request object. Request message for - [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1beta.CompletionService.PurgeSuggestionDenyListEntries] + `CompletionService.PurgeSuggestionDenyListEntries + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1125,11 +1138,15 @@ def sample_purge_suggestion_deny_list_entries(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.PurgeSuggestionDenyListEntriesResponse` Response message for - [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1beta.CompletionService.PurgeSuggestionDenyListEntries] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.PurgeSuggestionDenyListEntriesResponse` + Response message for + `CompletionService.PurgeSuggestionDenyListEntries + `__ + method. """ # Create or coerce a protobuf request object. @@ -1183,7 +1200,8 @@ def import_completion_suggestions( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: r"""Imports - [CompletionSuggestion][google.cloud.discoveryengine.v1beta.CompletionSuggestion]s + `CompletionSuggestion + `__s for a DataStore. .. code-block:: python @@ -1224,7 +1242,8 @@ def sample_import_completion_suggestions(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.ImportCompletionSuggestionsRequest, dict]): The request object. Request message for - [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1beta.CompletionService.ImportCompletionSuggestions] + `CompletionService.ImportCompletionSuggestions + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1236,14 +1255,18 @@ def sample_import_completion_suggestions(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.ImportCompletionSuggestionsResponse` Response of the - [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1beta.CompletionService.ImportCompletionSuggestions] - method. If the long running operation is done, this - message is returned by the - google.longrunning.Operations.response field if the - operation is successful. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.ImportCompletionSuggestionsResponse` + Response of the + `CompletionService.ImportCompletionSuggestions + `__ + method. If the long running operation is + done, this message is returned by the + google.longrunning.Operations.response + field if the operation is successful. """ # Create or coerce a protobuf request object. @@ -1297,7 +1320,8 @@ def purge_completion_suggestions( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: r"""Permanently deletes all - [CompletionSuggestion][google.cloud.discoveryengine.v1beta.CompletionSuggestion]s + `CompletionSuggestion + `__s for a DataStore. .. code-block:: python @@ -1333,7 +1357,8 @@ def sample_purge_completion_suggestions(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.PurgeCompletionSuggestionsRequest, dict]): The request object. Request message for - [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1beta.CompletionService.PurgeCompletionSuggestions] + `CompletionService.PurgeCompletionSuggestions + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1345,11 +1370,15 @@ def sample_purge_completion_suggestions(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.PurgeCompletionSuggestionsResponse` Response message for - [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1beta.CompletionService.PurgeCompletionSuggestions] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.PurgeCompletionSuggestionsResponse` + Response message for + `CompletionService.PurgeCompletionSuggestions + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/completion_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/completion_service/transports/grpc.py index 6ba36c174ca5..4beffc2a1f6e 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/completion_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/completion_service/transports/grpc.py @@ -414,7 +414,8 @@ def import_suggestion_deny_list_entries( entries method over gRPC. Imports all - [SuggestionDenyListEntry][google.cloud.discoveryengine.v1beta.SuggestionDenyListEntry] + `SuggestionDenyListEntry + `__ for a DataStore. Returns: @@ -447,7 +448,8 @@ def purge_suggestion_deny_list_entries( entries method over gRPC. Permanently deletes all - [SuggestionDenyListEntry][google.cloud.discoveryengine.v1beta.SuggestionDenyListEntry] + `SuggestionDenyListEntry + `__ for a DataStore. Returns: @@ -479,7 +481,8 @@ def import_completion_suggestions( r"""Return a callable for the import completion suggestions method over gRPC. Imports - [CompletionSuggestion][google.cloud.discoveryengine.v1beta.CompletionSuggestion]s + `CompletionSuggestion + `__s for a DataStore. Returns: @@ -511,7 +514,8 @@ def purge_completion_suggestions( r"""Return a callable for the purge completion suggestions method over gRPC. Permanently deletes all - [CompletionSuggestion][google.cloud.discoveryengine.v1beta.CompletionSuggestion]s + `CompletionSuggestion + `__s for a DataStore. Returns: diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/completion_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/completion_service/transports/grpc_asyncio.py index 026a65da5aa3..de3b89d371dc 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/completion_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/completion_service/transports/grpc_asyncio.py @@ -423,7 +423,8 @@ def import_suggestion_deny_list_entries( entries method over gRPC. Imports all - [SuggestionDenyListEntry][google.cloud.discoveryengine.v1beta.SuggestionDenyListEntry] + `SuggestionDenyListEntry + `__ for a DataStore. Returns: @@ -457,7 +458,8 @@ def purge_suggestion_deny_list_entries( entries method over gRPC. Permanently deletes all - [SuggestionDenyListEntry][google.cloud.discoveryengine.v1beta.SuggestionDenyListEntry] + `SuggestionDenyListEntry + `__ for a DataStore. Returns: @@ -490,7 +492,8 @@ def import_completion_suggestions( r"""Return a callable for the import completion suggestions method over gRPC. Imports - [CompletionSuggestion][google.cloud.discoveryengine.v1beta.CompletionSuggestion]s + `CompletionSuggestion + `__s for a DataStore. Returns: @@ -523,7 +526,8 @@ def purge_completion_suggestions( r"""Return a callable for the purge completion suggestions method over gRPC. Permanently deletes all - [CompletionSuggestion][google.cloud.discoveryengine.v1beta.CompletionSuggestion]s + `CompletionSuggestion + `__s for a DataStore. Returns: diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/completion_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/completion_service/transports/rest.py index 595318f8a1df..db5ff2df0fe8 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/completion_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/completion_service/transports/rest.py @@ -800,8 +800,10 @@ def __call__( Args: request (~.completion_service.AdvancedCompleteQueryRequest): The request object. Request message for - [CompletionService.AdvancedCompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.AdvancedCompleteQuery] - method. . + `CompletionService.AdvancedCompleteQuery + `__ + method. + . retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -813,7 +815,8 @@ def __call__( Returns: ~.completion_service.AdvancedCompleteQueryResponse: Response message for - [CompletionService.AdvancedCompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.AdvancedCompleteQuery] + `CompletionService.AdvancedCompleteQuery + `__ method. """ @@ -963,7 +966,8 @@ def __call__( Args: request (~.completion_service.CompleteQueryRequest): The request object. Request message for - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] + `CompletionService.CompleteQuery + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -976,7 +980,8 @@ def __call__( Returns: ~.completion_service.CompleteQueryResponse: Response message for - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] + `CompletionService.CompleteQuery + `__ method. """ @@ -1117,7 +1122,8 @@ def __call__( Args: request (~.import_config.ImportCompletionSuggestionsRequest): The request object. Request message for - [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1beta.CompletionService.ImportCompletionSuggestions] + `CompletionService.ImportCompletionSuggestions + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1279,7 +1285,8 @@ def __call__( Args: request (~.import_config.ImportSuggestionDenyListEntriesRequest): The request object. Request message for - [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1beta.CompletionService.ImportSuggestionDenyListEntries] + `CompletionService.ImportSuggestionDenyListEntries + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1442,7 +1449,8 @@ def __call__( Args: request (~.purge_config.PurgeCompletionSuggestionsRequest): The request object. Request message for - [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1beta.CompletionService.PurgeCompletionSuggestions] + `CompletionService.PurgeCompletionSuggestions + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1599,7 +1607,8 @@ def __call__( Args: request (~.purge_config.PurgeSuggestionDenyListEntriesRequest): The request object. Request message for - [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1beta.CompletionService.PurgeSuggestionDenyListEntries] + `CompletionService.PurgeSuggestionDenyListEntries + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/control_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/control_service/async_client.py index 3888df9f0ba6..f614ea5ec6f8 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/control_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/control_service/async_client.py @@ -313,10 +313,12 @@ async def create_control( ) -> gcd_control.Control: r"""Creates a Control. - By default 1000 controls are allowed for a data store. A request - can be submitted to adjust this limit. If the - [Control][google.cloud.discoveryengine.v1beta.Control] to create - already exists, an ALREADY_EXISTS error is returned. + By default 1000 controls are allowed for a data store. A + request can be submitted to adjust this limit. If the + `Control + `__ to + create already exists, an ALREADY_EXISTS error is + returned. .. code-block:: python @@ -357,8 +359,8 @@ async def sample_create_control(): request (Optional[Union[google.cloud.discoveryengine_v1beta.types.CreateControlRequest, dict]]): The request object. Request for CreateControl method. parent (:class:`str`): - Required. Full resource name of parent data store. - Format: + Required. Full resource name of parent + data store. Format: ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`` or ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. @@ -372,12 +374,13 @@ async def sample_create_control(): on the ``request`` instance; if ``request`` is provided, this should not be set. control_id (:class:`str`): - Required. The ID to use for the Control, which will - become the final component of the Control's resource - name. + Required. The ID to use for the Control, + which will become the final component of + the Control's resource name. - This value must be within 1-63 characters. Valid - characters are /[a-z][0-9]-\_/. + This value must be within 1-63 + characters. Valid characters are /`a-z + <0-9>`__-_/. This corresponds to the ``control_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -392,11 +395,13 @@ async def sample_create_control(): Returns: google.cloud.discoveryengine_v1beta.types.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] - to be considered at serving time. Permitted actions - dependent on SolutionType. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ # Create or coerce a protobuf request object. @@ -463,7 +468,8 @@ async def delete_control( ) -> None: r"""Deletes a Control. - If the [Control][google.cloud.discoveryengine.v1beta.Control] to + If the `Control + `__ to delete does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -493,8 +499,8 @@ async def sample_delete_control(): request (Optional[Union[google.cloud.discoveryengine_v1beta.types.DeleteControlRequest, dict]]): The request object. Request for DeleteControl method. name (:class:`str`): - Required. The resource name of the Control to delete. - Format: + Required. The resource name of the + Control to delete. Format: ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`` This corresponds to the ``name`` field @@ -566,10 +572,11 @@ async def update_control( ) -> gcd_control.Control: r"""Updates a Control. - [Control][google.cloud.discoveryengine.v1beta.Control] action - type cannot be changed. If the - [Control][google.cloud.discoveryengine.v1beta.Control] to update - does not exist, a NOT_FOUND error is returned. + `Control + `__ action + type cannot be changed. If the `Control + `__ to + update does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -613,14 +620,19 @@ async def sample_update_control(): on the ``request`` instance; if ``request`` is provided, this should not be set. update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - Optional. Indicates which fields in the provided - [Control][google.cloud.discoveryengine.v1beta.Control] - to update. The following are NOT supported: + Optional. Indicates which fields in the + provided `Control + `__ + to update. The following are NOT + supported: - - [Control.name][google.cloud.discoveryengine.v1beta.Control.name] - - [Control.solution_type][google.cloud.discoveryengine.v1beta.Control.solution_type] + * `Control.name + `__ + * `Control.solution_type + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported + fields are updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -635,11 +647,13 @@ async def sample_update_control(): Returns: google.cloud.discoveryengine_v1beta.types.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] - to be considered at serving time. Permitted actions - dependent on SolutionType. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ # Create or coerce a protobuf request object. @@ -736,8 +750,8 @@ async def sample_get_control(): request (Optional[Union[google.cloud.discoveryengine_v1beta.types.GetControlRequest, dict]]): The request object. Request for GetControl method. name (:class:`str`): - Required. The resource name of the Control to get. - Format: + Required. The resource name of the + Control to get. Format: ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`` This corresponds to the ``name`` field @@ -753,11 +767,13 @@ async def sample_get_control(): Returns: google.cloud.discoveryengine_v1beta.types.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] - to be considered at serving time. Permitted actions - dependent on SolutionType. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ # Create or coerce a protobuf request object. @@ -819,7 +835,8 @@ async def list_controls( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListControlsAsyncPager: r"""Lists all Controls by their parent - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + `DataStore + `__. .. code-block:: python @@ -852,7 +869,8 @@ async def sample_list_controls(): request (Optional[Union[google.cloud.discoveryengine_v1beta.types.ListControlsRequest, dict]]): The request object. Request for ListControls method. parent (:class:`str`): - Required. The data store resource name. Format: + Required. The data store resource name. + Format: ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`` or ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/control_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/control_service/client.py index da915517635c..c70d9042128f 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/control_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/control_service/client.py @@ -758,10 +758,12 @@ def create_control( ) -> gcd_control.Control: r"""Creates a Control. - By default 1000 controls are allowed for a data store. A request - can be submitted to adjust this limit. If the - [Control][google.cloud.discoveryengine.v1beta.Control] to create - already exists, an ALREADY_EXISTS error is returned. + By default 1000 controls are allowed for a data store. A + request can be submitted to adjust this limit. If the + `Control + `__ to + create already exists, an ALREADY_EXISTS error is + returned. .. code-block:: python @@ -802,8 +804,8 @@ def sample_create_control(): request (Union[google.cloud.discoveryengine_v1beta.types.CreateControlRequest, dict]): The request object. Request for CreateControl method. parent (str): - Required. Full resource name of parent data store. - Format: + Required. Full resource name of parent + data store. Format: ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`` or ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. @@ -817,12 +819,13 @@ def sample_create_control(): on the ``request`` instance; if ``request`` is provided, this should not be set. control_id (str): - Required. The ID to use for the Control, which will - become the final component of the Control's resource - name. + Required. The ID to use for the Control, + which will become the final component of + the Control's resource name. - This value must be within 1-63 characters. Valid - characters are /[a-z][0-9]-\_/. + This value must be within 1-63 + characters. Valid characters are /`a-z + <0-9>`__-_/. This corresponds to the ``control_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -837,11 +840,13 @@ def sample_create_control(): Returns: google.cloud.discoveryengine_v1beta.types.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] - to be considered at serving time. Permitted actions - dependent on SolutionType. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ # Create or coerce a protobuf request object. @@ -905,7 +910,8 @@ def delete_control( ) -> None: r"""Deletes a Control. - If the [Control][google.cloud.discoveryengine.v1beta.Control] to + If the `Control + `__ to delete does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -935,8 +941,8 @@ def sample_delete_control(): request (Union[google.cloud.discoveryengine_v1beta.types.DeleteControlRequest, dict]): The request object. Request for DeleteControl method. name (str): - Required. The resource name of the Control to delete. - Format: + Required. The resource name of the + Control to delete. Format: ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`` This corresponds to the ``name`` field @@ -1005,10 +1011,11 @@ def update_control( ) -> gcd_control.Control: r"""Updates a Control. - [Control][google.cloud.discoveryengine.v1beta.Control] action - type cannot be changed. If the - [Control][google.cloud.discoveryengine.v1beta.Control] to update - does not exist, a NOT_FOUND error is returned. + `Control + `__ action + type cannot be changed. If the `Control + `__ to + update does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -1052,14 +1059,19 @@ def sample_update_control(): on the ``request`` instance; if ``request`` is provided, this should not be set. update_mask (google.protobuf.field_mask_pb2.FieldMask): - Optional. Indicates which fields in the provided - [Control][google.cloud.discoveryengine.v1beta.Control] - to update. The following are NOT supported: + Optional. Indicates which fields in the + provided `Control + `__ + to update. The following are NOT + supported: - - [Control.name][google.cloud.discoveryengine.v1beta.Control.name] - - [Control.solution_type][google.cloud.discoveryengine.v1beta.Control.solution_type] + * `Control.name + `__ + * `Control.solution_type + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported + fields are updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -1074,11 +1086,13 @@ def sample_update_control(): Returns: google.cloud.discoveryengine_v1beta.types.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] - to be considered at serving time. Permitted actions - dependent on SolutionType. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ # Create or coerce a protobuf request object. @@ -1172,8 +1186,8 @@ def sample_get_control(): request (Union[google.cloud.discoveryengine_v1beta.types.GetControlRequest, dict]): The request object. Request for GetControl method. name (str): - Required. The resource name of the Control to get. - Format: + Required. The resource name of the + Control to get. Format: ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`` This corresponds to the ``name`` field @@ -1189,11 +1203,13 @@ def sample_get_control(): Returns: google.cloud.discoveryengine_v1beta.types.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] - to be considered at serving time. Permitted actions - dependent on SolutionType. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ # Create or coerce a protobuf request object. @@ -1252,7 +1268,8 @@ def list_controls( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListControlsPager: r"""Lists all Controls by their parent - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + `DataStore + `__. .. code-block:: python @@ -1285,7 +1302,8 @@ def sample_list_controls(): request (Union[google.cloud.discoveryengine_v1beta.types.ListControlsRequest, dict]): The request object. Request for ListControls method. parent (str): - Required. The data store resource name. Format: + Required. The data store resource name. + Format: ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`` or ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/control_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/control_service/transports/grpc.py index 565c95b76904..3742b4fa6635 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/control_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/control_service/transports/grpc.py @@ -337,10 +337,12 @@ def create_control( Creates a Control. - By default 1000 controls are allowed for a data store. A request - can be submitted to adjust this limit. If the - [Control][google.cloud.discoveryengine.v1beta.Control] to create - already exists, an ALREADY_EXISTS error is returned. + By default 1000 controls are allowed for a data store. A + request can be submitted to adjust this limit. If the + `Control + `__ to + create already exists, an ALREADY_EXISTS error is + returned. Returns: Callable[[~.CreateControlRequest], @@ -368,7 +370,8 @@ def delete_control( Deletes a Control. - If the [Control][google.cloud.discoveryengine.v1beta.Control] to + If the `Control + `__ to delete does not exist, a NOT_FOUND error is returned. Returns: @@ -397,10 +400,11 @@ def update_control( Updates a Control. - [Control][google.cloud.discoveryengine.v1beta.Control] action - type cannot be changed. If the - [Control][google.cloud.discoveryengine.v1beta.Control] to update - does not exist, a NOT_FOUND error is returned. + `Control + `__ action + type cannot be changed. If the `Control + `__ to + update does not exist, a NOT_FOUND error is returned. Returns: Callable[[~.UpdateControlRequest], @@ -455,7 +459,8 @@ def list_controls( r"""Return a callable for the list controls method over gRPC. Lists all Controls by their parent - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + `DataStore + `__. Returns: Callable[[~.ListControlsRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/control_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/control_service/transports/grpc_asyncio.py index 3c7f3db9fd36..9fc670552162 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/control_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/control_service/transports/grpc_asyncio.py @@ -347,10 +347,12 @@ def create_control( Creates a Control. - By default 1000 controls are allowed for a data store. A request - can be submitted to adjust this limit. If the - [Control][google.cloud.discoveryengine.v1beta.Control] to create - already exists, an ALREADY_EXISTS error is returned. + By default 1000 controls are allowed for a data store. A + request can be submitted to adjust this limit. If the + `Control + `__ to + create already exists, an ALREADY_EXISTS error is + returned. Returns: Callable[[~.CreateControlRequest], @@ -378,7 +380,8 @@ def delete_control( Deletes a Control. - If the [Control][google.cloud.discoveryengine.v1beta.Control] to + If the `Control + `__ to delete does not exist, a NOT_FOUND error is returned. Returns: @@ -409,10 +412,11 @@ def update_control( Updates a Control. - [Control][google.cloud.discoveryengine.v1beta.Control] action - type cannot be changed. If the - [Control][google.cloud.discoveryengine.v1beta.Control] to update - does not exist, a NOT_FOUND error is returned. + `Control + `__ action + type cannot be changed. If the `Control + `__ to + update does not exist, a NOT_FOUND error is returned. Returns: Callable[[~.UpdateControlRequest], @@ -468,7 +472,8 @@ def list_controls( r"""Return a callable for the list controls method over gRPC. Lists all Controls by their parent - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + `DataStore + `__. Returns: Callable[[~.ListControlsRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/control_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/control_service/transports/rest.py index 0a6dac3c2688..82a73251ed7b 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/control_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/control_service/transports/rest.py @@ -537,11 +537,13 @@ def __call__( Returns: ~.gcd_control.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] - to be considered at serving time. Permitted actions - dependent on ``SolutionType``. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ @@ -797,11 +799,13 @@ def __call__( Returns: ~.control.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] - to be considered at serving time. Permitted actions - dependent on ``SolutionType``. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ @@ -1095,11 +1099,13 @@ def __call__( Returns: ~.gcd_control.Control: - Defines a conditioned behavior to employ during serving. - Must be attached to a - [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] - to be considered at serving time. Permitted actions - dependent on ``SolutionType``. + Defines a conditioned behavior to employ + during serving. Must be attached to a + `ServingConfig + `__ + to be considered at serving time. + Permitted actions dependent on + ``SolutionType``. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/conversational_search_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/conversational_search_service/async_client.py index 8cb819a55752..250d17c96fe8 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/conversational_search_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/conversational_search_service/async_client.py @@ -385,17 +385,18 @@ async def sample_converse_conversation(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.ConverseConversationRequest, dict]]): The request object. Request message for - [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1beta.ConversationalSearchService.ConverseConversation] + `ConversationalSearchService.ConverseConversation + `__ method. name (:class:`str`): - Required. The resource name of the Conversation to get. - Format: + Required. The resource name of the + Conversation to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}``. Use ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-`` - to activate auto session mode, which automatically - creates a new conversation inside a ConverseConversation - session. + to activate auto session mode, which + automatically creates a new conversation + inside a ConverseConversation session. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -416,8 +417,9 @@ async def sample_converse_conversation(): Returns: google.cloud.discoveryengine_v1beta.types.ConverseConversationResponse: Response message for - [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1beta.ConversationalSearchService.ConverseConversation] - method. + `ConversationalSearchService.ConverseConversation + `__ + method. """ # Create or coerce a protobuf request object. @@ -487,9 +489,10 @@ async def create_conversation( ) -> gcd_conversation.Conversation: r"""Creates a Conversation. - If the - [Conversation][google.cloud.discoveryengine.v1beta.Conversation] - to create already exists, an ALREADY_EXISTS error is returned. + If the `Conversation + `__ to + create already exists, an ALREADY_EXISTS error is + returned. .. code-block:: python @@ -522,8 +525,8 @@ async def sample_create_conversation(): The request object. Request for CreateConversation method. parent (:class:`str`): - Required. Full resource name of parent data store. - Format: + Required. Full resource name of parent + data store. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field @@ -614,9 +617,9 @@ async def delete_conversation( ) -> None: r"""Deletes a Conversation. - If the - [Conversation][google.cloud.discoveryengine.v1beta.Conversation] - to delete does not exist, a NOT_FOUND error is returned. + If the `Conversation + `__ to + delete does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -646,8 +649,8 @@ async def sample_delete_conversation(): The request object. Request for DeleteConversation method. name (:class:`str`): - Required. The resource name of the Conversation to - delete. Format: + Required. The resource name of the + Conversation to delete. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`` This corresponds to the ``name`` field @@ -723,10 +726,12 @@ async def update_conversation( ) -> gcd_conversation.Conversation: r"""Updates a Conversation. - [Conversation][google.cloud.discoveryengine.v1beta.Conversation] + `Conversation + `__ action type cannot be changed. If the - [Conversation][google.cloud.discoveryengine.v1beta.Conversation] - to update does not exist, a NOT_FOUND error is returned. + `Conversation + `__ to + update does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -764,12 +769,16 @@ async def sample_update_conversation(): should not be set. update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): Indicates which fields in the provided - [Conversation][google.cloud.discoveryengine.v1beta.Conversation] - to update. The following are NOT supported: + `Conversation + `__ + to update. The following are NOT + supported: - - [Conversation.name][google.cloud.discoveryengine.v1beta.Conversation.name] + * `Conversation.name + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported + fields are updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -886,8 +895,8 @@ async def sample_get_conversation(): request (Optional[Union[google.cloud.discoveryengine_v1beta.types.GetConversationRequest, dict]]): The request object. Request for GetConversation method. name (:class:`str`): - Required. The resource name of the Conversation to get. - Format: + Required. The resource name of the + Conversation to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`` This corresponds to the ``name`` field @@ -970,7 +979,8 @@ async def list_conversations( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListConversationsAsyncPager: r"""Lists all Conversations by their parent - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + `DataStore + `__. .. code-block:: python @@ -1003,7 +1013,8 @@ async def sample_list_conversations(): request (Optional[Union[google.cloud.discoveryengine_v1beta.types.ListConversationsRequest, dict]]): The request object. Request for ListConversations method. parent (:class:`str`): - Required. The data store resource name. Format: + Required. The data store resource name. + Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field @@ -1133,7 +1144,8 @@ async def sample_answer_query(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.AnswerQueryRequest, dict]]): The request object. Request message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1beta.ConversationalSearchService.AnswerQuery] + `ConversationalSearchService.AnswerQuery + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -1146,8 +1158,9 @@ async def sample_answer_query(): Returns: google.cloud.discoveryengine_v1beta.types.AnswerQueryResponse: Response message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1beta.ConversationalSearchService.AnswerQuery] - method. + `ConversationalSearchService.AnswerQuery + `__ + method. """ # Create or coerce a protobuf request object. @@ -1227,8 +1240,8 @@ async def sample_get_answer(): request (Optional[Union[google.cloud.discoveryengine_v1beta.types.GetAnswerRequest, dict]]): The request object. Request for GetAnswer method. name (:class:`str`): - Required. The resource name of the Answer to get. - Format: + Required. The resource name of the + Answer to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`` This corresponds to the ``name`` field @@ -1309,8 +1322,10 @@ async def create_session( ) -> gcd_session.Session: r"""Creates a Session. - If the [Session][google.cloud.discoveryengine.v1beta.Session] to - create already exists, an ALREADY_EXISTS error is returned. + If the `Session + `__ to + create already exists, an ALREADY_EXISTS error is + returned. .. code-block:: python @@ -1342,8 +1357,8 @@ async def sample_create_session(): request (Optional[Union[google.cloud.discoveryengine_v1beta.types.CreateSessionRequest, dict]]): The request object. Request for CreateSession method. parent (:class:`str`): - Required. Full resource name of parent data store. - Format: + Required. Full resource name of parent + data store. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field @@ -1430,7 +1445,8 @@ async def delete_session( ) -> None: r"""Deletes a Session. - If the [Session][google.cloud.discoveryengine.v1beta.Session] to + If the `Session + `__ to delete does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -1460,8 +1476,8 @@ async def sample_delete_session(): request (Optional[Union[google.cloud.discoveryengine_v1beta.types.DeleteSessionRequest, dict]]): The request object. Request for DeleteSession method. name (:class:`str`): - Required. The resource name of the Session to delete. - Format: + Required. The resource name of the + Session to delete. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` This corresponds to the ``name`` field @@ -1535,10 +1551,11 @@ async def update_session( ) -> gcd_session.Session: r"""Updates a Session. - [Session][google.cloud.discoveryengine.v1beta.Session] action - type cannot be changed. If the - [Session][google.cloud.discoveryengine.v1beta.Session] to update - does not exist, a NOT_FOUND error is returned. + `Session + `__ action + type cannot be changed. If the `Session + `__ to + update does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -1575,12 +1592,16 @@ async def sample_update_session(): should not be set. update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): Indicates which fields in the provided - [Session][google.cloud.discoveryengine.v1beta.Session] - to update. The following are NOT supported: + `Session + `__ + to update. The following are NOT + supported: - - [Session.name][google.cloud.discoveryengine.v1beta.Session.name] + * `Session.name + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported + fields are updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -1693,8 +1714,8 @@ async def sample_get_session(): request (Optional[Union[google.cloud.discoveryengine_v1beta.types.GetSessionRequest, dict]]): The request object. Request for GetSession method. name (:class:`str`): - Required. The resource name of the Session to get. - Format: + Required. The resource name of the + Session to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` This corresponds to the ``name`` field @@ -1773,7 +1794,8 @@ async def list_sessions( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListSessionsAsyncPager: r"""Lists all Sessions by their parent - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + `DataStore + `__. .. code-block:: python @@ -1806,7 +1828,8 @@ async def sample_list_sessions(): request (Optional[Union[google.cloud.discoveryengine_v1beta.types.ListSessionsRequest, dict]]): The request object. Request for ListSessions method. parent (:class:`str`): - Required. The data store resource name. Format: + Required. The data store resource name. + Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/conversational_search_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/conversational_search_service/client.py index 91e14d343429..f1d6e2c21e3b 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/conversational_search_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/conversational_search_service/client.py @@ -935,17 +935,18 @@ def sample_converse_conversation(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.ConverseConversationRequest, dict]): The request object. Request message for - [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1beta.ConversationalSearchService.ConverseConversation] + `ConversationalSearchService.ConverseConversation + `__ method. name (str): - Required. The resource name of the Conversation to get. - Format: + Required. The resource name of the + Conversation to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}``. Use ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-`` - to activate auto session mode, which automatically - creates a new conversation inside a ConverseConversation - session. + to activate auto session mode, which + automatically creates a new conversation + inside a ConverseConversation session. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -966,8 +967,9 @@ def sample_converse_conversation(): Returns: google.cloud.discoveryengine_v1beta.types.ConverseConversationResponse: Response message for - [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1beta.ConversationalSearchService.ConverseConversation] - method. + `ConversationalSearchService.ConverseConversation + `__ + method. """ # Create or coerce a protobuf request object. @@ -1034,9 +1036,10 @@ def create_conversation( ) -> gcd_conversation.Conversation: r"""Creates a Conversation. - If the - [Conversation][google.cloud.discoveryengine.v1beta.Conversation] - to create already exists, an ALREADY_EXISTS error is returned. + If the `Conversation + `__ to + create already exists, an ALREADY_EXISTS error is + returned. .. code-block:: python @@ -1069,8 +1072,8 @@ def sample_create_conversation(): The request object. Request for CreateConversation method. parent (str): - Required. Full resource name of parent data store. - Format: + Required. Full resource name of parent + data store. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field @@ -1158,9 +1161,9 @@ def delete_conversation( ) -> None: r"""Deletes a Conversation. - If the - [Conversation][google.cloud.discoveryengine.v1beta.Conversation] - to delete does not exist, a NOT_FOUND error is returned. + If the `Conversation + `__ to + delete does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -1190,8 +1193,8 @@ def sample_delete_conversation(): The request object. Request for DeleteConversation method. name (str): - Required. The resource name of the Conversation to - delete. Format: + Required. The resource name of the + Conversation to delete. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`` This corresponds to the ``name`` field @@ -1264,10 +1267,12 @@ def update_conversation( ) -> gcd_conversation.Conversation: r"""Updates a Conversation. - [Conversation][google.cloud.discoveryengine.v1beta.Conversation] + `Conversation + `__ action type cannot be changed. If the - [Conversation][google.cloud.discoveryengine.v1beta.Conversation] - to update does not exist, a NOT_FOUND error is returned. + `Conversation + `__ to + update does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -1305,12 +1310,16 @@ def sample_update_conversation(): should not be set. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [Conversation][google.cloud.discoveryengine.v1beta.Conversation] - to update. The following are NOT supported: + `Conversation + `__ + to update. The following are NOT + supported: - - [Conversation.name][google.cloud.discoveryengine.v1beta.Conversation.name] + * `Conversation.name + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported + fields are updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -1424,8 +1433,8 @@ def sample_get_conversation(): request (Union[google.cloud.discoveryengine_v1beta.types.GetConversationRequest, dict]): The request object. Request for GetConversation method. name (str): - Required. The resource name of the Conversation to get. - Format: + Required. The resource name of the + Conversation to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`` This corresponds to the ``name`` field @@ -1505,7 +1514,8 @@ def list_conversations( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListConversationsPager: r"""Lists all Conversations by their parent - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + `DataStore + `__. .. code-block:: python @@ -1538,7 +1548,8 @@ def sample_list_conversations(): request (Union[google.cloud.discoveryengine_v1beta.types.ListConversationsRequest, dict]): The request object. Request for ListConversations method. parent (str): - Required. The data store resource name. Format: + Required. The data store resource name. + Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field @@ -1665,7 +1676,8 @@ def sample_answer_query(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.AnswerQueryRequest, dict]): The request object. Request message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1beta.ConversationalSearchService.AnswerQuery] + `ConversationalSearchService.AnswerQuery + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1678,8 +1690,9 @@ def sample_answer_query(): Returns: google.cloud.discoveryengine_v1beta.types.AnswerQueryResponse: Response message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1beta.ConversationalSearchService.AnswerQuery] - method. + `ConversationalSearchService.AnswerQuery + `__ + method. """ # Create or coerce a protobuf request object. @@ -1757,8 +1770,8 @@ def sample_get_answer(): request (Union[google.cloud.discoveryengine_v1beta.types.GetAnswerRequest, dict]): The request object. Request for GetAnswer method. name (str): - Required. The resource name of the Answer to get. - Format: + Required. The resource name of the + Answer to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`` This corresponds to the ``name`` field @@ -1836,8 +1849,10 @@ def create_session( ) -> gcd_session.Session: r"""Creates a Session. - If the [Session][google.cloud.discoveryengine.v1beta.Session] to - create already exists, an ALREADY_EXISTS error is returned. + If the `Session + `__ to + create already exists, an ALREADY_EXISTS error is + returned. .. code-block:: python @@ -1869,8 +1884,8 @@ def sample_create_session(): request (Union[google.cloud.discoveryengine_v1beta.types.CreateSessionRequest, dict]): The request object. Request for CreateSession method. parent (str): - Required. Full resource name of parent data store. - Format: + Required. Full resource name of parent + data store. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field @@ -1954,7 +1969,8 @@ def delete_session( ) -> None: r"""Deletes a Session. - If the [Session][google.cloud.discoveryengine.v1beta.Session] to + If the `Session + `__ to delete does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -1984,8 +2000,8 @@ def sample_delete_session(): request (Union[google.cloud.discoveryengine_v1beta.types.DeleteSessionRequest, dict]): The request object. Request for DeleteSession method. name (str): - Required. The resource name of the Session to delete. - Format: + Required. The resource name of the + Session to delete. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` This corresponds to the ``name`` field @@ -2056,10 +2072,11 @@ def update_session( ) -> gcd_session.Session: r"""Updates a Session. - [Session][google.cloud.discoveryengine.v1beta.Session] action - type cannot be changed. If the - [Session][google.cloud.discoveryengine.v1beta.Session] to update - does not exist, a NOT_FOUND error is returned. + `Session + `__ action + type cannot be changed. If the `Session + `__ to + update does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -2096,12 +2113,16 @@ def sample_update_session(): should not be set. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [Session][google.cloud.discoveryengine.v1beta.Session] - to update. The following are NOT supported: + `Session + `__ + to update. The following are NOT + supported: - - [Session.name][google.cloud.discoveryengine.v1beta.Session.name] + * `Session.name + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported + fields are updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -2211,8 +2232,8 @@ def sample_get_session(): request (Union[google.cloud.discoveryengine_v1beta.types.GetSessionRequest, dict]): The request object. Request for GetSession method. name (str): - Required. The resource name of the Session to get. - Format: + Required. The resource name of the + Session to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` This corresponds to the ``name`` field @@ -2288,7 +2309,8 @@ def list_sessions( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListSessionsPager: r"""Lists all Sessions by their parent - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + `DataStore + `__. .. code-block:: python @@ -2321,7 +2343,8 @@ def sample_list_sessions(): request (Union[google.cloud.discoveryengine_v1beta.types.ListSessionsRequest, dict]): The request object. Request for ListSessions method. parent (str): - Required. The data store resource name. Format: + Required. The data store resource name. + Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/conversational_search_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/conversational_search_service/transports/grpc.py index 131a37cfd5bd..cc17f5851183 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/conversational_search_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/conversational_search_service/transports/grpc.py @@ -369,9 +369,10 @@ def create_conversation( Creates a Conversation. - If the - [Conversation][google.cloud.discoveryengine.v1beta.Conversation] - to create already exists, an ALREADY_EXISTS error is returned. + If the `Conversation + `__ to + create already exists, an ALREADY_EXISTS error is + returned. Returns: Callable[[~.CreateConversationRequest], @@ -401,9 +402,9 @@ def delete_conversation( Deletes a Conversation. - If the - [Conversation][google.cloud.discoveryengine.v1beta.Conversation] - to delete does not exist, a NOT_FOUND error is returned. + If the `Conversation + `__ to + delete does not exist, a NOT_FOUND error is returned. Returns: Callable[[~.DeleteConversationRequest], @@ -434,10 +435,12 @@ def update_conversation( Updates a Conversation. - [Conversation][google.cloud.discoveryengine.v1beta.Conversation] + `Conversation + `__ action type cannot be changed. If the - [Conversation][google.cloud.discoveryengine.v1beta.Conversation] - to update does not exist, a NOT_FOUND error is returned. + `Conversation + `__ to + update does not exist, a NOT_FOUND error is returned. Returns: Callable[[~.UpdateConversationRequest], @@ -496,7 +499,8 @@ def list_conversations( r"""Return a callable for the list conversations method over gRPC. Lists all Conversations by their parent - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + `DataStore + `__. Returns: Callable[[~.ListConversationsRequest], @@ -581,8 +585,10 @@ def create_session( Creates a Session. - If the [Session][google.cloud.discoveryengine.v1beta.Session] to - create already exists, an ALREADY_EXISTS error is returned. + If the `Session + `__ to + create already exists, an ALREADY_EXISTS error is + returned. Returns: Callable[[~.CreateSessionRequest], @@ -612,7 +618,8 @@ def delete_session( Deletes a Session. - If the [Session][google.cloud.discoveryengine.v1beta.Session] to + If the `Session + `__ to delete does not exist, a NOT_FOUND error is returned. Returns: @@ -643,10 +650,11 @@ def update_session( Updates a Session. - [Session][google.cloud.discoveryengine.v1beta.Session] action - type cannot be changed. If the - [Session][google.cloud.discoveryengine.v1beta.Session] to update - does not exist, a NOT_FOUND error is returned. + `Session + `__ action + type cannot be changed. If the `Session + `__ to + update does not exist, a NOT_FOUND error is returned. Returns: Callable[[~.UpdateSessionRequest], @@ -702,7 +710,8 @@ def list_sessions( r"""Return a callable for the list sessions method over gRPC. Lists all Sessions by their parent - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + `DataStore + `__. Returns: Callable[[~.ListSessionsRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/conversational_search_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/conversational_search_service/transports/grpc_asyncio.py index 45e9effbe00b..1b59703957f2 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/conversational_search_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/conversational_search_service/transports/grpc_asyncio.py @@ -379,9 +379,10 @@ def create_conversation( Creates a Conversation. - If the - [Conversation][google.cloud.discoveryengine.v1beta.Conversation] - to create already exists, an ALREADY_EXISTS error is returned. + If the `Conversation + `__ to + create already exists, an ALREADY_EXISTS error is + returned. Returns: Callable[[~.CreateConversationRequest], @@ -412,9 +413,9 @@ def delete_conversation( Deletes a Conversation. - If the - [Conversation][google.cloud.discoveryengine.v1beta.Conversation] - to delete does not exist, a NOT_FOUND error is returned. + If the `Conversation + `__ to + delete does not exist, a NOT_FOUND error is returned. Returns: Callable[[~.DeleteConversationRequest], @@ -445,10 +446,12 @@ def update_conversation( Updates a Conversation. - [Conversation][google.cloud.discoveryengine.v1beta.Conversation] + `Conversation + `__ action type cannot be changed. If the - [Conversation][google.cloud.discoveryengine.v1beta.Conversation] - to update does not exist, a NOT_FOUND error is returned. + `Conversation + `__ to + update does not exist, a NOT_FOUND error is returned. Returns: Callable[[~.UpdateConversationRequest], @@ -507,7 +510,8 @@ def list_conversations( r"""Return a callable for the list conversations method over gRPC. Lists all Conversations by their parent - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + `DataStore + `__. Returns: Callable[[~.ListConversationsRequest], @@ -595,8 +599,10 @@ def create_session( Creates a Session. - If the [Session][google.cloud.discoveryengine.v1beta.Session] to - create already exists, an ALREADY_EXISTS error is returned. + If the `Session + `__ to + create already exists, an ALREADY_EXISTS error is + returned. Returns: Callable[[~.CreateSessionRequest], @@ -626,7 +632,8 @@ def delete_session( Deletes a Session. - If the [Session][google.cloud.discoveryengine.v1beta.Session] to + If the `Session + `__ to delete does not exist, a NOT_FOUND error is returned. Returns: @@ -658,10 +665,11 @@ def update_session( Updates a Session. - [Session][google.cloud.discoveryengine.v1beta.Session] action - type cannot be changed. If the - [Session][google.cloud.discoveryengine.v1beta.Session] to update - does not exist, a NOT_FOUND error is returned. + `Session + `__ action + type cannot be changed. If the `Session + `__ to + update does not exist, a NOT_FOUND error is returned. Returns: Callable[[~.UpdateSessionRequest], @@ -719,7 +727,8 @@ def list_sessions( r"""Return a callable for the list sessions method over gRPC. Lists all Sessions by their parent - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + `DataStore + `__. Returns: Callable[[~.ListSessionsRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/conversational_search_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/conversational_search_service/transports/rest.py index 2087c6d7b598..fa253b64fcf1 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/conversational_search_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/conversational_search_service/transports/rest.py @@ -959,7 +959,8 @@ def __call__( Args: request (~.conversational_search_service.AnswerQueryRequest): The request object. Request message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1beta.ConversationalSearchService.AnswerQuery] + `ConversationalSearchService.AnswerQuery + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -972,7 +973,8 @@ def __call__( Returns: ~.conversational_search_service.AnswerQueryResponse: Response message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1beta.ConversationalSearchService.AnswerQuery] + `ConversationalSearchService.AnswerQuery + `__ method. """ @@ -1121,7 +1123,8 @@ def __call__( Args: request (~.conversational_search_service.ConverseConversationRequest): The request object. Request message for - [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1beta.ConversationalSearchService.ConverseConversation] + `ConversationalSearchService.ConverseConversation + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1134,7 +1137,8 @@ def __call__( Returns: ~.conversational_search_service.ConverseConversationResponse: Response message for - [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1beta.ConversationalSearchService.ConverseConversation] + `ConversationalSearchService.ConverseConversation + `__ method. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/data_store_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/data_store_service/async_client.py index 07a111abc18e..ccd133b3f8fa 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/data_store_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/data_store_service/async_client.py @@ -78,7 +78,7 @@ class DataStoreServiceAsyncClient: """Service for managing - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] + `DataStore `__ configuration. """ @@ -330,14 +330,15 @@ async def create_data_store( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Creates a - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. - + r"""Creates a `DataStore + `__. DataStore is for storing - [Documents][google.cloud.discoveryengine.v1beta.Document]. To - serve these documents for Search, or Recommendation use case, an - [Engine][google.cloud.discoveryengine.v1beta.Engine] needs to be - created separately. + `Documents + `__. To + serve these documents for Search, or Recommendation use + case, an `Engine + `__ needs to + be created separately. .. code-block:: python @@ -377,18 +378,20 @@ async def sample_create_data_store(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.CreateDataStoreRequest, dict]]): The request object. Request for - [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.CreateDataStore] + `DataStoreService.CreateDataStore + `__ method. parent (:class:`str`): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. data_store (:class:`google.cloud.discoveryengine_v1beta.types.DataStore`): - Required. The - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] + Required. The `DataStore + `__ to create. This corresponds to the ``data_store`` field @@ -396,15 +399,19 @@ async def sample_create_data_store(): should not be set. data_store_id (:class:`str`): Required. The ID to use for the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore], - which will become the final component of the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]'s + `DataStore + `__, + which will become the final component of + the + `DataStore + `__'s resource name. - This field must conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. - Otherwise, an INVALID_ARGUMENT error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 + characters. Otherwise, an + INVALID_ARGUMENT error is returned. This corresponds to the ``data_store_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -419,12 +426,13 @@ async def sample_create_data_store(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1beta.types.DataStore` - DataStore captures global settings and configs at the - DataStore level. + DataStore captures global settings and + configs at the DataStore level. """ # Create or coerce a protobuf request object. @@ -497,8 +505,8 @@ async def get_data_store( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> data_store.DataStore: - r"""Gets a - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + r"""Gets a `DataStore + `__. .. code-block:: python @@ -529,22 +537,26 @@ async def sample_get_data_store(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.GetDataStoreRequest, dict]]): The request object. Request message for - [DataStoreService.GetDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.GetDataStore] + `DataStoreService.GetDataStore + `__ method. name (:class:`str`): Required. Full resource name of - [DataStore][google.cloud.discoveryengine.v1beta.DataStore], + `DataStore + `__, such as ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. - If the caller does not have permission to access the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `DataStore + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the requested - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] - does not exist, a NOT_FOUND error is returned. + If the requested `DataStore + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -621,8 +633,8 @@ async def list_data_stores( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListDataStoresAsyncPager: - r"""Lists all the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s + r"""Lists all the `DataStore + `__s associated with the project. .. code-block:: python @@ -655,17 +667,20 @@ async def sample_list_data_stores(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.ListDataStoresRequest, dict]]): The request object. Request message for - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores] + `DataStoreService.ListDataStores + `__ method. parent (:class:`str`): - Required. The parent branch resource name, such as + Required. The parent branch resource + name, such as ``projects/{project}/locations/{location}/collections/{collection_id}``. - If the caller does not have permission to list - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s - under this location, regardless of whether or not this - data store exists, a PERMISSION_DENIED error is - returned. + If the caller does not have permission + to list `DataStore + `__s + under this location, regardless of + whether or not this data store exists, a + PERMISSION_DENIED error is returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -681,11 +696,13 @@ async def sample_list_data_stores(): Returns: google.cloud.discoveryengine_v1beta.services.data_store_service.pagers.ListDataStoresAsyncPager: Response message for - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores] - method. + `DataStoreService.ListDataStores + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -759,8 +776,8 @@ async def delete_data_store( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Deletes a - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + r"""Deletes a `DataStore + `__. .. code-block:: python @@ -795,22 +812,26 @@ async def sample_delete_data_store(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.DeleteDataStoreRequest, dict]]): The request object. Request message for - [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.DeleteDataStore] + `DataStoreService.DeleteDataStore + `__ method. name (:class:`str`): Required. Full resource name of - [DataStore][google.cloud.discoveryengine.v1beta.DataStore], + `DataStore + `__, such as ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. - If the caller does not have permission to delete the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to delete the `DataStore + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] - to delete does not exist, a NOT_FOUND error is returned. + If the `DataStore + `__ + to delete does not exist, a NOT_FOUND + error is returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -825,18 +846,21 @@ async def sample_delete_data_store(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. @@ -908,8 +932,8 @@ async def update_data_store( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_data_store.DataStore: - r"""Updates a - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] + r"""Updates a `DataStore + `__ .. code-block:: python @@ -943,32 +967,37 @@ async def sample_update_data_store(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.UpdateDataStoreRequest, dict]]): The request object. Request message for - [DataStoreService.UpdateDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.UpdateDataStore] + `DataStoreService.UpdateDataStore + `__ method. data_store (:class:`google.cloud.discoveryengine_v1beta.types.DataStore`): - Required. The - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] + Required. The `DataStore + `__ to update. - If the caller does not have permission to update the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to update the `DataStore + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] - to update does not exist, a NOT_FOUND error is returned. + If the `DataStore + `__ + to update does not exist, a NOT_FOUND + error is returned. This corresponds to the ``data_store`` field on the ``request`` instance; if ``request`` is provided, this should not be set. update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): Indicates which fields in the provided - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] + `DataStore + `__ to update. - If an unsupported or unknown field is provided, an - INVALID_ARGUMENT error is returned. + If an unsupported or unknown field is + provided, an INVALID_ARGUMENT error is + returned. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/data_store_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/data_store_service/client.py index 6af99614c6d8..80d921966f03 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/data_store_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/data_store_service/client.py @@ -124,7 +124,7 @@ def get_transport_class( class DataStoreServiceClient(metaclass=DataStoreServiceClientMeta): """Service for managing - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] + `DataStore `__ configuration. """ @@ -814,14 +814,15 @@ def create_data_store( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Creates a - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. - + r"""Creates a `DataStore + `__. DataStore is for storing - [Documents][google.cloud.discoveryengine.v1beta.Document]. To - serve these documents for Search, or Recommendation use case, an - [Engine][google.cloud.discoveryengine.v1beta.Engine] needs to be - created separately. + `Documents + `__. To + serve these documents for Search, or Recommendation use + case, an `Engine + `__ needs to + be created separately. .. code-block:: python @@ -861,18 +862,20 @@ def sample_create_data_store(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.CreateDataStoreRequest, dict]): The request object. Request for - [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.CreateDataStore] + `DataStoreService.CreateDataStore + `__ method. parent (str): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. data_store (google.cloud.discoveryengine_v1beta.types.DataStore): - Required. The - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] + Required. The `DataStore + `__ to create. This corresponds to the ``data_store`` field @@ -880,15 +883,19 @@ def sample_create_data_store(): should not be set. data_store_id (str): Required. The ID to use for the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore], - which will become the final component of the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]'s + `DataStore + `__, + which will become the final component of + the + `DataStore + `__'s resource name. - This field must conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. - Otherwise, an INVALID_ARGUMENT error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 + characters. Otherwise, an + INVALID_ARGUMENT error is returned. This corresponds to the ``data_store_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -903,12 +910,13 @@ def sample_create_data_store(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1beta.types.DataStore` - DataStore captures global settings and configs at the - DataStore level. + DataStore captures global settings and + configs at the DataStore level. """ # Create or coerce a protobuf request object. @@ -978,8 +986,8 @@ def get_data_store( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> data_store.DataStore: - r"""Gets a - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + r"""Gets a `DataStore + `__. .. code-block:: python @@ -1010,22 +1018,26 @@ def sample_get_data_store(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.GetDataStoreRequest, dict]): The request object. Request message for - [DataStoreService.GetDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.GetDataStore] + `DataStoreService.GetDataStore + `__ method. name (str): Required. Full resource name of - [DataStore][google.cloud.discoveryengine.v1beta.DataStore], + `DataStore + `__, such as ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. - If the caller does not have permission to access the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `DataStore + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the requested - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] - does not exist, a NOT_FOUND error is returned. + If the requested `DataStore + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -1099,8 +1111,8 @@ def list_data_stores( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListDataStoresPager: - r"""Lists all the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s + r"""Lists all the `DataStore + `__s associated with the project. .. code-block:: python @@ -1133,17 +1145,20 @@ def sample_list_data_stores(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.ListDataStoresRequest, dict]): The request object. Request message for - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores] + `DataStoreService.ListDataStores + `__ method. parent (str): - Required. The parent branch resource name, such as + Required. The parent branch resource + name, such as ``projects/{project}/locations/{location}/collections/{collection_id}``. - If the caller does not have permission to list - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s - under this location, regardless of whether or not this - data store exists, a PERMISSION_DENIED error is - returned. + If the caller does not have permission + to list `DataStore + `__s + under this location, regardless of + whether or not this data store exists, a + PERMISSION_DENIED error is returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -1159,11 +1174,13 @@ def sample_list_data_stores(): Returns: google.cloud.discoveryengine_v1beta.services.data_store_service.pagers.ListDataStoresPager: Response message for - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores] - method. + `DataStoreService.ListDataStores + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -1234,8 +1251,8 @@ def delete_data_store( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Deletes a - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + r"""Deletes a `DataStore + `__. .. code-block:: python @@ -1270,22 +1287,26 @@ def sample_delete_data_store(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.DeleteDataStoreRequest, dict]): The request object. Request message for - [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.DeleteDataStore] + `DataStoreService.DeleteDataStore + `__ method. name (str): Required. Full resource name of - [DataStore][google.cloud.discoveryengine.v1beta.DataStore], + `DataStore + `__, such as ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. - If the caller does not have permission to delete the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to delete the `DataStore + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] - to delete does not exist, a NOT_FOUND error is returned. + If the `DataStore + `__ + to delete does not exist, a NOT_FOUND + error is returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -1300,18 +1321,21 @@ def sample_delete_data_store(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. @@ -1380,8 +1404,8 @@ def update_data_store( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_data_store.DataStore: - r"""Updates a - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] + r"""Updates a `DataStore + `__ .. code-block:: python @@ -1415,32 +1439,37 @@ def sample_update_data_store(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.UpdateDataStoreRequest, dict]): The request object. Request message for - [DataStoreService.UpdateDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.UpdateDataStore] + `DataStoreService.UpdateDataStore + `__ method. data_store (google.cloud.discoveryengine_v1beta.types.DataStore): - Required. The - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] + Required. The `DataStore + `__ to update. - If the caller does not have permission to update the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to update the `DataStore + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] - to update does not exist, a NOT_FOUND error is returned. + If the `DataStore + `__ + to update does not exist, a NOT_FOUND + error is returned. This corresponds to the ``data_store`` field on the ``request`` instance; if ``request`` is provided, this should not be set. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] + `DataStore + `__ to update. - If an unsupported or unknown field is provided, an - INVALID_ARGUMENT error is returned. + If an unsupported or unknown field is + provided, an INVALID_ARGUMENT error is + returned. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/data_store_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/data_store_service/transports/grpc.py index 34171a829227..397b9c3e01b9 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/data_store_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/data_store_service/transports/grpc.py @@ -115,7 +115,7 @@ class DataStoreServiceGrpcTransport(DataStoreServiceTransport): """gRPC backend transport for DataStoreService. Service for managing - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] + `DataStore `__ configuration. This class defines the same methods as the primary client, so the @@ -352,14 +352,15 @@ def create_data_store( ]: r"""Return a callable for the create data store method over gRPC. - Creates a - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. - + Creates a `DataStore + `__. DataStore is for storing - [Documents][google.cloud.discoveryengine.v1beta.Document]. To - serve these documents for Search, or Recommendation use case, an - [Engine][google.cloud.discoveryengine.v1beta.Engine] needs to be - created separately. + `Documents + `__. To + serve these documents for Search, or Recommendation use + case, an `Engine + `__ needs to + be created separately. Returns: Callable[[~.CreateDataStoreRequest], @@ -385,8 +386,8 @@ def get_data_store( ) -> Callable[[data_store_service.GetDataStoreRequest], data_store.DataStore]: r"""Return a callable for the get data store method over gRPC. - Gets a - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + Gets a `DataStore + `__. Returns: Callable[[~.GetDataStoreRequest], @@ -415,8 +416,8 @@ def list_data_stores( ]: r"""Return a callable for the list data stores method over gRPC. - Lists all the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s + Lists all the `DataStore + `__s associated with the project. Returns: @@ -445,8 +446,8 @@ def delete_data_store( ]: r"""Return a callable for the delete data store method over gRPC. - Deletes a - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + Deletes a `DataStore + `__. Returns: Callable[[~.DeleteDataStoreRequest], @@ -474,8 +475,8 @@ def update_data_store( ]: r"""Return a callable for the update data store method over gRPC. - Updates a - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] + Updates a `DataStore + `__ Returns: Callable[[~.UpdateDataStoreRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/data_store_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/data_store_service/transports/grpc_asyncio.py index 0230fe0f5c31..5c05850a93fb 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/data_store_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/data_store_service/transports/grpc_asyncio.py @@ -121,7 +121,7 @@ class DataStoreServiceGrpcAsyncIOTransport(DataStoreServiceTransport): """gRPC AsyncIO backend transport for DataStoreService. Service for managing - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] + `DataStore `__ configuration. This class defines the same methods as the primary client, so the @@ -360,14 +360,15 @@ def create_data_store( ]: r"""Return a callable for the create data store method over gRPC. - Creates a - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. - + Creates a `DataStore + `__. DataStore is for storing - [Documents][google.cloud.discoveryengine.v1beta.Document]. To - serve these documents for Search, or Recommendation use case, an - [Engine][google.cloud.discoveryengine.v1beta.Engine] needs to be - created separately. + `Documents + `__. To + serve these documents for Search, or Recommendation use + case, an `Engine + `__ needs to + be created separately. Returns: Callable[[~.CreateDataStoreRequest], @@ -395,8 +396,8 @@ def get_data_store( ]: r"""Return a callable for the get data store method over gRPC. - Gets a - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + Gets a `DataStore + `__. Returns: Callable[[~.GetDataStoreRequest], @@ -425,8 +426,8 @@ def list_data_stores( ]: r"""Return a callable for the list data stores method over gRPC. - Lists all the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s + Lists all the `DataStore + `__s associated with the project. Returns: @@ -455,8 +456,8 @@ def delete_data_store( ]: r"""Return a callable for the delete data store method over gRPC. - Deletes a - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + Deletes a `DataStore + `__. Returns: Callable[[~.DeleteDataStoreRequest], @@ -484,8 +485,8 @@ def update_data_store( ]: r"""Return a callable for the update data store method over gRPC. - Updates a - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] + Updates a `DataStore + `__ Returns: Callable[[~.UpdateDataStoreRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/data_store_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/data_store_service/transports/rest.py index 4801b5d48cac..c743bb8e5675 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/data_store_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/data_store_service/transports/rest.py @@ -454,7 +454,7 @@ class DataStoreServiceRestTransport(_BaseDataStoreServiceRestTransport): """REST backend synchronous transport for DataStoreService. Service for managing - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] + `DataStore `__ configuration. This class defines the same methods as the primary client, so the @@ -740,7 +740,8 @@ def __call__( Args: request (~.data_store_service.CreateDataStoreRequest): The request object. Request for - [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.CreateDataStore] + `DataStoreService.CreateDataStore + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -895,7 +896,8 @@ def __call__( Args: request (~.data_store_service.DeleteDataStoreRequest): The request object. Request message for - [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.DeleteDataStore] + `DataStoreService.DeleteDataStore + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1044,7 +1046,8 @@ def __call__( Args: request (~.data_store_service.GetDataStoreRequest): The request object. Request message for - [DataStoreService.GetDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.GetDataStore] + `DataStoreService.GetDataStore + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1192,7 +1195,8 @@ def __call__( Args: request (~.data_store_service.ListDataStoresRequest): The request object. Request message for - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores] + `DataStoreService.ListDataStores + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1205,7 +1209,8 @@ def __call__( Returns: ~.data_store_service.ListDataStoresResponse: Response message for - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores] + `DataStoreService.ListDataStores + `__ method. """ @@ -1347,7 +1352,8 @@ def __call__( Args: request (~.data_store_service.UpdateDataStoreRequest): The request object. Request message for - [DataStoreService.UpdateDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.UpdateDataStore] + `DataStoreService.UpdateDataStore + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/document_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/document_service/async_client.py index fe146fc67c62..771c910ec591 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/document_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/document_service/async_client.py @@ -77,8 +77,8 @@ class DocumentServiceAsyncClient: """Service for ingesting - [Document][google.cloud.discoveryengine.v1beta.Document] information - of the customer's website. + `Document `__ + information of the customer's website. """ _client: DocumentServiceClient @@ -323,7 +323,8 @@ async def get_document( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> document.Document: - r"""Gets a [Document][google.cloud.discoveryengine.v1beta.Document]. + r"""Gets a `Document + `__. .. code-block:: python @@ -354,22 +355,27 @@ async def sample_get_document(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.GetDocumentRequest, dict]]): The request object. Request message for - [DocumentService.GetDocument][google.cloud.discoveryengine.v1beta.DocumentService.GetDocument] + `DocumentService.GetDocument + `__ method. name (:class:`str`): Required. Full resource name of - [Document][google.cloud.discoveryengine.v1beta.Document], + `Document + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}``. - If the caller does not have permission to access the - [Document][google.cloud.discoveryengine.v1beta.Document], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + If the caller does not have permission + to access the `Document + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. - If the requested - [Document][google.cloud.discoveryengine.v1beta.Document] - does not exist, a ``NOT_FOUND`` error is returned. + If the requested `Document + `__ + does not exist, a ``NOT_FOUND`` error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -447,8 +453,8 @@ async def list_documents( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListDocumentsAsyncPager: - r"""Gets a list of - [Document][google.cloud.discoveryengine.v1beta.Document]s. + r"""Gets a list of `Document + `__s. .. code-block:: python @@ -480,19 +486,23 @@ async def sample_list_documents(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.ListDocumentsRequest, dict]]): The request object. Request message for - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments] + `DocumentService.ListDocuments + `__ method. parent (:class:`str`): - Required. The parent branch resource name, such as + Required. The parent branch resource + name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. - Use ``default_branch`` as the branch ID, to list - documents under the default branch. - - If the caller does not have permission to list - [Document][google.cloud.discoveryengine.v1beta.Document]s - under this branch, regardless of whether or not this - branch exists, a ``PERMISSION_DENIED`` error is - returned. + Use ``default_branch`` as the branch ID, + to list documents under the default + branch. + + If the caller does not have permission + to list `Document + `__s + under this branch, regardless of whether + or not this branch exists, a + ``PERMISSION_DENIED`` error is returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -508,11 +518,13 @@ async def sample_list_documents(): Returns: google.cloud.discoveryengine_v1beta.services.document_service.pagers.ListDocumentsAsyncPager: Response message for - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments] - method. + `DocumentService.ListDocuments + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -586,8 +598,8 @@ async def create_document( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_document.Document: - r"""Creates a - [Document][google.cloud.discoveryengine.v1beta.Document]. + r"""Creates a `Document + `__. .. code-block:: python @@ -619,18 +631,20 @@ async def sample_create_document(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.CreateDocumentRequest, dict]]): The request object. Request message for - [DocumentService.CreateDocument][google.cloud.discoveryengine.v1beta.DocumentService.CreateDocument] + `DocumentService.CreateDocument + `__ method. parent (:class:`str`): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. document (:class:`google.cloud.discoveryengine_v1beta.types.Document`): - Required. The - [Document][google.cloud.discoveryengine.v1beta.Document] + Required. The `Document + `__ to create. This corresponds to the ``document`` field @@ -638,25 +652,32 @@ async def sample_create_document(): should not be set. document_id (:class:`str`): Required. The ID to use for the - [Document][google.cloud.discoveryengine.v1beta.Document], + `Document + `__, which becomes the final component of the - [Document.name][google.cloud.discoveryengine.v1beta.Document.name]. - - If the caller does not have permission to create the - [Document][google.cloud.discoveryengine.v1beta.Document], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + `Document.name + `__. + + If the caller does not have permission + to create the `Document + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. This field must be unique among all - [Document][google.cloud.discoveryengine.v1beta.Document]s - with the same - [parent][google.cloud.discoveryengine.v1beta.CreateDocumentRequest.parent]. - Otherwise, an ``ALREADY_EXISTS`` error is returned. - - This field must conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. - Otherwise, an ``INVALID_ARGUMENT`` error is returned. + `Document + `__s + with the same `parent + `__. + Otherwise, an ``ALREADY_EXISTS`` error + is returned. + + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 + characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. This corresponds to the ``document_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -739,8 +760,8 @@ async def update_document( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_document.Document: - r"""Updates a - [Document][google.cloud.discoveryengine.v1beta.Document]. + r"""Updates a `Document + `__. .. code-block:: python @@ -770,21 +791,26 @@ async def sample_update_document(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.UpdateDocumentRequest, dict]]): The request object. Request message for - [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1beta.DocumentService.UpdateDocument] + `DocumentService.UpdateDocument + `__ method. document (:class:`google.cloud.discoveryengine_v1beta.types.Document`): Required. The document to update/create. - If the caller does not have permission to update the - [Document][google.cloud.discoveryengine.v1beta.Document], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + If the caller does not have permission + to update the `Document + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. - If the - [Document][google.cloud.discoveryengine.v1beta.Document] + If the `Document + `__ to update does not exist and - [allow_missing][google.cloud.discoveryengine.v1beta.UpdateDocumentRequest.allow_missing] - is not set, a ``NOT_FOUND`` error is returned. + `allow_missing + `__ + is not set, a ``NOT_FOUND`` error is + returned. This corresponds to the ``document`` field on the ``request`` instance; if ``request`` is provided, this @@ -875,8 +901,8 @@ async def delete_document( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> None: - r"""Deletes a - [Document][google.cloud.discoveryengine.v1beta.Document]. + r"""Deletes a `Document + `__. .. code-block:: python @@ -904,24 +930,28 @@ async def sample_delete_document(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.DeleteDocumentRequest, dict]]): The request object. Request message for - [DocumentService.DeleteDocument][google.cloud.discoveryengine.v1beta.DocumentService.DeleteDocument] + `DocumentService.DeleteDocument + `__ method. name (:class:`str`): Required. Full resource name of - [Document][google.cloud.discoveryengine.v1beta.Document], + `Document + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}``. - If the caller does not have permission to delete the - [Document][google.cloud.discoveryengine.v1beta.Document], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. - - If the - [Document][google.cloud.discoveryengine.v1beta.Document] - to delete does not exist, a ``NOT_FOUND`` error is + If the caller does not have permission + to delete the `Document + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is returned. + If the `Document + `__ + to delete does not exist, a + ``NOT_FOUND`` error is returned. + This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this should not be set. @@ -988,12 +1018,14 @@ async def import_documents( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: r"""Bulk import of multiple - [Document][google.cloud.discoveryengine.v1beta.Document]s. - Request processing may be synchronous. Non-existing items are - created. + `Document + `__s. + Request processing may be synchronous. Non-existing + items are created. Note: It is possible for a subset of the - [Document][google.cloud.discoveryengine.v1beta.Document]s to be + `Document + `__s to be successfully updated. .. code-block:: python @@ -1039,14 +1071,17 @@ async def sample_import_documents(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.ImportDocumentsResponse` Response of the - [ImportDocumentsRequest][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest]. - If the long running operation is done, then this - message is returned by the - google.longrunning.Operations.response field if the - operation was successful. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.ImportDocumentsResponse` + Response of the `ImportDocumentsRequest + `__. + If the long running operation is done, + then this message is returned by the + google.longrunning.Operations.response + field if the operation was successful. """ # Create or coerce a protobuf request object. @@ -1098,23 +1133,29 @@ async def purge_documents( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: r"""Permanently deletes all selected - [Document][google.cloud.discoveryengine.v1beta.Document]s in a + `Document + `__s in a branch. This process is asynchronous. Depending on the number of - [Document][google.cloud.discoveryengine.v1beta.Document]s to be - deleted, this operation can take hours to complete. Before the - delete operation completes, some - [Document][google.cloud.discoveryengine.v1beta.Document]s might + `Document + `__s to be + deleted, this operation can take hours to complete. + Before the delete operation completes, some `Document + `__s might still be returned by - [DocumentService.GetDocument][google.cloud.discoveryengine.v1beta.DocumentService.GetDocument] + `DocumentService.GetDocument + `__ or - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments]. + `DocumentService.ListDocuments + `__. To get a list of the - [Document][google.cloud.discoveryengine.v1beta.Document]s to be + `Document + `__s to be deleted, set - [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.force] + `PurgeDocumentsRequest.force + `__ to false. .. code-block:: python @@ -1155,7 +1196,8 @@ async def sample_purge_documents(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.PurgeDocumentsRequest, dict]]): The request object. Request message for - [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments] + `DocumentService.PurgeDocuments + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -1167,13 +1209,19 @@ async def sample_purge_documents(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.PurgeDocumentsResponse` Response message for - [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments] - method. If the long running operation is successfully - done, then this message is returned by the - google.longrunning.Operations.response field. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.PurgeDocumentsResponse` + Response message for + `DocumentService.PurgeDocuments + `__ + method. If the long running operation is + successfully done, then this message is + returned by the + google.longrunning.Operations.response + field. """ # Create or coerce a protobuf request object. @@ -1228,7 +1276,8 @@ async def batch_get_documents_metadata( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> document_service.BatchGetDocumentsMetadataResponse: r"""Gets index freshness metadata for - [Document][google.cloud.discoveryengine.v1beta.Document]s. + `Document + `__s. Supported for website search only. .. code-block:: python @@ -1260,10 +1309,12 @@ async def sample_batch_get_documents_metadata(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.BatchGetDocumentsMetadataRequest, dict]]): The request object. Request message for - [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1beta.DocumentService.BatchGetDocumentsMetadata] + `DocumentService.BatchGetDocumentsMetadata + `__ method. parent (:class:`str`): - Required. The parent branch resource name, such as + Required. The parent branch resource + name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. This corresponds to the ``parent`` field @@ -1280,8 +1331,9 @@ async def sample_batch_get_documents_metadata(): Returns: google.cloud.discoveryengine_v1beta.types.BatchGetDocumentsMetadataResponse: Response message for - [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1beta.DocumentService.BatchGetDocumentsMetadata] - method. + `DocumentService.BatchGetDocumentsMetadata + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/document_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/document_service/client.py index 251bd8fe92f0..805cc877acac 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/document_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/document_service/client.py @@ -123,8 +123,8 @@ def get_transport_class( class DocumentServiceClient(metaclass=DocumentServiceClientMeta): """Service for ingesting - [Document][google.cloud.discoveryengine.v1beta.Document] information - of the customer's website. + `Document `__ + information of the customer's website. """ @staticmethod @@ -818,7 +818,8 @@ def get_document( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> document.Document: - r"""Gets a [Document][google.cloud.discoveryengine.v1beta.Document]. + r"""Gets a `Document + `__. .. code-block:: python @@ -849,22 +850,27 @@ def sample_get_document(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.GetDocumentRequest, dict]): The request object. Request message for - [DocumentService.GetDocument][google.cloud.discoveryengine.v1beta.DocumentService.GetDocument] + `DocumentService.GetDocument + `__ method. name (str): Required. Full resource name of - [Document][google.cloud.discoveryengine.v1beta.Document], + `Document + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}``. - If the caller does not have permission to access the - [Document][google.cloud.discoveryengine.v1beta.Document], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + If the caller does not have permission + to access the `Document + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. - If the requested - [Document][google.cloud.discoveryengine.v1beta.Document] - does not exist, a ``NOT_FOUND`` error is returned. + If the requested `Document + `__ + does not exist, a ``NOT_FOUND`` error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -939,8 +945,8 @@ def list_documents( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListDocumentsPager: - r"""Gets a list of - [Document][google.cloud.discoveryengine.v1beta.Document]s. + r"""Gets a list of `Document + `__s. .. code-block:: python @@ -972,19 +978,23 @@ def sample_list_documents(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.ListDocumentsRequest, dict]): The request object. Request message for - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments] + `DocumentService.ListDocuments + `__ method. parent (str): - Required. The parent branch resource name, such as + Required. The parent branch resource + name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. - Use ``default_branch`` as the branch ID, to list - documents under the default branch. - - If the caller does not have permission to list - [Document][google.cloud.discoveryengine.v1beta.Document]s - under this branch, regardless of whether or not this - branch exists, a ``PERMISSION_DENIED`` error is - returned. + Use ``default_branch`` as the branch ID, + to list documents under the default + branch. + + If the caller does not have permission + to list `Document + `__s + under this branch, regardless of whether + or not this branch exists, a + ``PERMISSION_DENIED`` error is returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -1000,11 +1010,13 @@ def sample_list_documents(): Returns: google.cloud.discoveryengine_v1beta.services.document_service.pagers.ListDocumentsPager: Response message for - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments] - method. + `DocumentService.ListDocuments + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -1075,8 +1087,8 @@ def create_document( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_document.Document: - r"""Creates a - [Document][google.cloud.discoveryengine.v1beta.Document]. + r"""Creates a `Document + `__. .. code-block:: python @@ -1108,18 +1120,20 @@ def sample_create_document(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.CreateDocumentRequest, dict]): The request object. Request message for - [DocumentService.CreateDocument][google.cloud.discoveryengine.v1beta.DocumentService.CreateDocument] + `DocumentService.CreateDocument + `__ method. parent (str): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. document (google.cloud.discoveryengine_v1beta.types.Document): - Required. The - [Document][google.cloud.discoveryengine.v1beta.Document] + Required. The `Document + `__ to create. This corresponds to the ``document`` field @@ -1127,25 +1141,32 @@ def sample_create_document(): should not be set. document_id (str): Required. The ID to use for the - [Document][google.cloud.discoveryengine.v1beta.Document], + `Document + `__, which becomes the final component of the - [Document.name][google.cloud.discoveryengine.v1beta.Document.name]. - - If the caller does not have permission to create the - [Document][google.cloud.discoveryengine.v1beta.Document], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + `Document.name + `__. + + If the caller does not have permission + to create the `Document + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. This field must be unique among all - [Document][google.cloud.discoveryengine.v1beta.Document]s - with the same - [parent][google.cloud.discoveryengine.v1beta.CreateDocumentRequest.parent]. - Otherwise, an ``ALREADY_EXISTS`` error is returned. - - This field must conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. - Otherwise, an ``INVALID_ARGUMENT`` error is returned. + `Document + `__s + with the same `parent + `__. + Otherwise, an ``ALREADY_EXISTS`` error + is returned. + + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 + characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. This corresponds to the ``document_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -1225,8 +1246,8 @@ def update_document( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_document.Document: - r"""Updates a - [Document][google.cloud.discoveryengine.v1beta.Document]. + r"""Updates a `Document + `__. .. code-block:: python @@ -1256,21 +1277,26 @@ def sample_update_document(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.UpdateDocumentRequest, dict]): The request object. Request message for - [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1beta.DocumentService.UpdateDocument] + `DocumentService.UpdateDocument + `__ method. document (google.cloud.discoveryengine_v1beta.types.Document): Required. The document to update/create. - If the caller does not have permission to update the - [Document][google.cloud.discoveryengine.v1beta.Document], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + If the caller does not have permission + to update the `Document + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. - If the - [Document][google.cloud.discoveryengine.v1beta.Document] + If the `Document + `__ to update does not exist and - [allow_missing][google.cloud.discoveryengine.v1beta.UpdateDocumentRequest.allow_missing] - is not set, a ``NOT_FOUND`` error is returned. + `allow_missing + `__ + is not set, a ``NOT_FOUND`` error is + returned. This corresponds to the ``document`` field on the ``request`` instance; if ``request`` is provided, this @@ -1358,8 +1384,8 @@ def delete_document( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> None: - r"""Deletes a - [Document][google.cloud.discoveryengine.v1beta.Document]. + r"""Deletes a `Document + `__. .. code-block:: python @@ -1387,24 +1413,28 @@ def sample_delete_document(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.DeleteDocumentRequest, dict]): The request object. Request message for - [DocumentService.DeleteDocument][google.cloud.discoveryengine.v1beta.DocumentService.DeleteDocument] + `DocumentService.DeleteDocument + `__ method. name (str): Required. Full resource name of - [Document][google.cloud.discoveryengine.v1beta.Document], + `Document + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}``. - If the caller does not have permission to delete the - [Document][google.cloud.discoveryengine.v1beta.Document], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. - - If the - [Document][google.cloud.discoveryengine.v1beta.Document] - to delete does not exist, a ``NOT_FOUND`` error is + If the caller does not have permission + to delete the `Document + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is returned. + If the `Document + `__ + to delete does not exist, a + ``NOT_FOUND`` error is returned. + This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this should not be set. @@ -1468,12 +1498,14 @@ def import_documents( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: r"""Bulk import of multiple - [Document][google.cloud.discoveryengine.v1beta.Document]s. - Request processing may be synchronous. Non-existing items are - created. + `Document + `__s. + Request processing may be synchronous. Non-existing + items are created. Note: It is possible for a subset of the - [Document][google.cloud.discoveryengine.v1beta.Document]s to be + `Document + `__s to be successfully updated. .. code-block:: python @@ -1519,14 +1551,17 @@ def sample_import_documents(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.ImportDocumentsResponse` Response of the - [ImportDocumentsRequest][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest]. - If the long running operation is done, then this - message is returned by the - google.longrunning.Operations.response field if the - operation was successful. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.ImportDocumentsResponse` + Response of the `ImportDocumentsRequest + `__. + If the long running operation is done, + then this message is returned by the + google.longrunning.Operations.response + field if the operation was successful. """ # Create or coerce a protobuf request object. @@ -1576,23 +1611,29 @@ def purge_documents( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: r"""Permanently deletes all selected - [Document][google.cloud.discoveryengine.v1beta.Document]s in a + `Document + `__s in a branch. This process is asynchronous. Depending on the number of - [Document][google.cloud.discoveryengine.v1beta.Document]s to be - deleted, this operation can take hours to complete. Before the - delete operation completes, some - [Document][google.cloud.discoveryengine.v1beta.Document]s might + `Document + `__s to be + deleted, this operation can take hours to complete. + Before the delete operation completes, some `Document + `__s might still be returned by - [DocumentService.GetDocument][google.cloud.discoveryengine.v1beta.DocumentService.GetDocument] + `DocumentService.GetDocument + `__ or - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments]. + `DocumentService.ListDocuments + `__. To get a list of the - [Document][google.cloud.discoveryengine.v1beta.Document]s to be + `Document + `__s to be deleted, set - [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.force] + `PurgeDocumentsRequest.force + `__ to false. .. code-block:: python @@ -1633,7 +1674,8 @@ def sample_purge_documents(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.PurgeDocumentsRequest, dict]): The request object. Request message for - [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments] + `DocumentService.PurgeDocuments + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1645,13 +1687,19 @@ def sample_purge_documents(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.PurgeDocumentsResponse` Response message for - [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments] - method. If the long running operation is successfully - done, then this message is returned by the - google.longrunning.Operations.response field. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.PurgeDocumentsResponse` + Response message for + `DocumentService.PurgeDocuments + `__ + method. If the long running operation is + successfully done, then this message is + returned by the + google.longrunning.Operations.response + field. """ # Create or coerce a protobuf request object. @@ -1704,7 +1752,8 @@ def batch_get_documents_metadata( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> document_service.BatchGetDocumentsMetadataResponse: r"""Gets index freshness metadata for - [Document][google.cloud.discoveryengine.v1beta.Document]s. + `Document + `__s. Supported for website search only. .. code-block:: python @@ -1736,10 +1785,12 @@ def sample_batch_get_documents_metadata(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.BatchGetDocumentsMetadataRequest, dict]): The request object. Request message for - [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1beta.DocumentService.BatchGetDocumentsMetadata] + `DocumentService.BatchGetDocumentsMetadata + `__ method. parent (str): - Required. The parent branch resource name, such as + Required. The parent branch resource + name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. This corresponds to the ``parent`` field @@ -1756,8 +1807,9 @@ def sample_batch_get_documents_metadata(): Returns: google.cloud.discoveryengine_v1beta.types.BatchGetDocumentsMetadataResponse: Response message for - [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1beta.DocumentService.BatchGetDocumentsMetadata] - method. + `DocumentService.BatchGetDocumentsMetadata + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/document_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/document_service/transports/grpc.py index d433ba4b2b19..66752c737498 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/document_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/document_service/transports/grpc.py @@ -120,8 +120,8 @@ class DocumentServiceGrpcTransport(DocumentServiceTransport): """gRPC backend transport for DocumentService. Service for ingesting - [Document][google.cloud.discoveryengine.v1beta.Document] information - of the customer's website. + `Document `__ + information of the customer's website. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -355,7 +355,8 @@ def get_document( ) -> Callable[[document_service.GetDocumentRequest], document.Document]: r"""Return a callable for the get document method over gRPC. - Gets a [Document][google.cloud.discoveryengine.v1beta.Document]. + Gets a `Document + `__. Returns: Callable[[~.GetDocumentRequest], @@ -383,8 +384,8 @@ def list_documents( ]: r"""Return a callable for the list documents method over gRPC. - Gets a list of - [Document][google.cloud.discoveryengine.v1beta.Document]s. + Gets a list of `Document + `__s. Returns: Callable[[~.ListDocumentsRequest], @@ -410,8 +411,8 @@ def create_document( ) -> Callable[[document_service.CreateDocumentRequest], gcd_document.Document]: r"""Return a callable for the create document method over gRPC. - Creates a - [Document][google.cloud.discoveryengine.v1beta.Document]. + Creates a `Document + `__. Returns: Callable[[~.CreateDocumentRequest], @@ -437,8 +438,8 @@ def update_document( ) -> Callable[[document_service.UpdateDocumentRequest], gcd_document.Document]: r"""Return a callable for the update document method over gRPC. - Updates a - [Document][google.cloud.discoveryengine.v1beta.Document]. + Updates a `Document + `__. Returns: Callable[[~.UpdateDocumentRequest], @@ -464,8 +465,8 @@ def delete_document( ) -> Callable[[document_service.DeleteDocumentRequest], empty_pb2.Empty]: r"""Return a callable for the delete document method over gRPC. - Deletes a - [Document][google.cloud.discoveryengine.v1beta.Document]. + Deletes a `Document + `__. Returns: Callable[[~.DeleteDocumentRequest], @@ -492,12 +493,14 @@ def import_documents( r"""Return a callable for the import documents method over gRPC. Bulk import of multiple - [Document][google.cloud.discoveryengine.v1beta.Document]s. - Request processing may be synchronous. Non-existing items are - created. + `Document + `__s. + Request processing may be synchronous. Non-existing + items are created. Note: It is possible for a subset of the - [Document][google.cloud.discoveryengine.v1beta.Document]s to be + `Document + `__s to be successfully updated. Returns: @@ -525,23 +528,29 @@ def purge_documents( r"""Return a callable for the purge documents method over gRPC. Permanently deletes all selected - [Document][google.cloud.discoveryengine.v1beta.Document]s in a + `Document + `__s in a branch. This process is asynchronous. Depending on the number of - [Document][google.cloud.discoveryengine.v1beta.Document]s to be - deleted, this operation can take hours to complete. Before the - delete operation completes, some - [Document][google.cloud.discoveryengine.v1beta.Document]s might + `Document + `__s to be + deleted, this operation can take hours to complete. + Before the delete operation completes, some `Document + `__s might still be returned by - [DocumentService.GetDocument][google.cloud.discoveryengine.v1beta.DocumentService.GetDocument] + `DocumentService.GetDocument + `__ or - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments]. + `DocumentService.ListDocuments + `__. To get a list of the - [Document][google.cloud.discoveryengine.v1beta.Document]s to be + `Document + `__s to be deleted, set - [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.force] + `PurgeDocumentsRequest.force + `__ to false. Returns: @@ -572,7 +581,8 @@ def batch_get_documents_metadata( r"""Return a callable for the batch get documents metadata method over gRPC. Gets index freshness metadata for - [Document][google.cloud.discoveryengine.v1beta.Document]s. + `Document + `__s. Supported for website search only. Returns: diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/document_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/document_service/transports/grpc_asyncio.py index e49316923f5f..916c2883cc25 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/document_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/document_service/transports/grpc_asyncio.py @@ -126,8 +126,8 @@ class DocumentServiceGrpcAsyncIOTransport(DocumentServiceTransport): """gRPC AsyncIO backend transport for DocumentService. Service for ingesting - [Document][google.cloud.discoveryengine.v1beta.Document] information - of the customer's website. + `Document `__ + information of the customer's website. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -363,7 +363,8 @@ def get_document( ) -> Callable[[document_service.GetDocumentRequest], Awaitable[document.Document]]: r"""Return a callable for the get document method over gRPC. - Gets a [Document][google.cloud.discoveryengine.v1beta.Document]. + Gets a `Document + `__. Returns: Callable[[~.GetDocumentRequest], @@ -392,8 +393,8 @@ def list_documents( ]: r"""Return a callable for the list documents method over gRPC. - Gets a list of - [Document][google.cloud.discoveryengine.v1beta.Document]s. + Gets a list of `Document + `__s. Returns: Callable[[~.ListDocumentsRequest], @@ -421,8 +422,8 @@ def create_document( ]: r"""Return a callable for the create document method over gRPC. - Creates a - [Document][google.cloud.discoveryengine.v1beta.Document]. + Creates a `Document + `__. Returns: Callable[[~.CreateDocumentRequest], @@ -450,8 +451,8 @@ def update_document( ]: r"""Return a callable for the update document method over gRPC. - Updates a - [Document][google.cloud.discoveryengine.v1beta.Document]. + Updates a `Document + `__. Returns: Callable[[~.UpdateDocumentRequest], @@ -477,8 +478,8 @@ def delete_document( ) -> Callable[[document_service.DeleteDocumentRequest], Awaitable[empty_pb2.Empty]]: r"""Return a callable for the delete document method over gRPC. - Deletes a - [Document][google.cloud.discoveryengine.v1beta.Document]. + Deletes a `Document + `__. Returns: Callable[[~.DeleteDocumentRequest], @@ -507,12 +508,14 @@ def import_documents( r"""Return a callable for the import documents method over gRPC. Bulk import of multiple - [Document][google.cloud.discoveryengine.v1beta.Document]s. - Request processing may be synchronous. Non-existing items are - created. + `Document + `__s. + Request processing may be synchronous. Non-existing + items are created. Note: It is possible for a subset of the - [Document][google.cloud.discoveryengine.v1beta.Document]s to be + `Document + `__s to be successfully updated. Returns: @@ -542,23 +545,29 @@ def purge_documents( r"""Return a callable for the purge documents method over gRPC. Permanently deletes all selected - [Document][google.cloud.discoveryengine.v1beta.Document]s in a + `Document + `__s in a branch. This process is asynchronous. Depending on the number of - [Document][google.cloud.discoveryengine.v1beta.Document]s to be - deleted, this operation can take hours to complete. Before the - delete operation completes, some - [Document][google.cloud.discoveryengine.v1beta.Document]s might + `Document + `__s to be + deleted, this operation can take hours to complete. + Before the delete operation completes, some `Document + `__s might still be returned by - [DocumentService.GetDocument][google.cloud.discoveryengine.v1beta.DocumentService.GetDocument] + `DocumentService.GetDocument + `__ or - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments]. + `DocumentService.ListDocuments + `__. To get a list of the - [Document][google.cloud.discoveryengine.v1beta.Document]s to be + `Document + `__s to be deleted, set - [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.force] + `PurgeDocumentsRequest.force + `__ to false. Returns: @@ -589,7 +598,8 @@ def batch_get_documents_metadata( r"""Return a callable for the batch get documents metadata method over gRPC. Gets index freshness metadata for - [Document][google.cloud.discoveryengine.v1beta.Document]s. + `Document + `__s. Supported for website search only. Returns: diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/document_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/document_service/transports/rest.py index 8353af5ec1e1..b17cc68f3052 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/document_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/document_service/transports/rest.py @@ -586,8 +586,8 @@ class DocumentServiceRestTransport(_BaseDocumentServiceRestTransport): """REST backend synchronous transport for DocumentService. Service for ingesting - [Document][google.cloud.discoveryengine.v1beta.Document] information - of the customer's website. + `Document `__ + information of the customer's website. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -872,7 +872,8 @@ def __call__( Args: request (~.document_service.BatchGetDocumentsMetadataRequest): The request object. Request message for - [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1beta.DocumentService.BatchGetDocumentsMetadata] + `DocumentService.BatchGetDocumentsMetadata + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -885,7 +886,8 @@ def __call__( Returns: ~.document_service.BatchGetDocumentsMetadataResponse: Response message for - [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1beta.DocumentService.BatchGetDocumentsMetadata] + `DocumentService.BatchGetDocumentsMetadata + `__ method. """ @@ -1030,7 +1032,8 @@ def __call__( Args: request (~.document_service.CreateDocumentRequest): The request object. Request message for - [DocumentService.CreateDocument][google.cloud.discoveryengine.v1beta.DocumentService.CreateDocument] + `DocumentService.CreateDocument + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1184,7 +1187,8 @@ def __call__( Args: request (~.document_service.DeleteDocumentRequest): The request object. Request message for - [DocumentService.DeleteDocument][google.cloud.discoveryengine.v1beta.DocumentService.DeleteDocument] + `DocumentService.DeleteDocument + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1292,7 +1296,8 @@ def __call__( Args: request (~.document_service.GetDocumentRequest): The request object. Request message for - [DocumentService.GetDocument][google.cloud.discoveryengine.v1beta.DocumentService.GetDocument] + `DocumentService.GetDocument + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1594,7 +1599,8 @@ def __call__( Args: request (~.document_service.ListDocumentsRequest): The request object. Request message for - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments] + `DocumentService.ListDocuments + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1607,7 +1613,8 @@ def __call__( Returns: ~.document_service.ListDocumentsResponse: Response message for - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments] + `DocumentService.ListDocuments + `__ method. """ @@ -1746,7 +1753,8 @@ def __call__( Args: request (~.purge_config.PurgeDocumentsRequest): The request object. Request message for - [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments] + `DocumentService.PurgeDocuments + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1899,7 +1907,8 @@ def __call__( Args: request (~.document_service.UpdateDocumentRequest): The request object. Request message for - [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1beta.DocumentService.UpdateDocument] + `DocumentService.UpdateDocument + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/engine_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/engine_service/async_client.py index 61cebfea2d44..73251f1855b7 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/engine_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/engine_service/async_client.py @@ -73,8 +73,8 @@ class EngineServiceAsyncClient: - """Service for managing - [Engine][google.cloud.discoveryengine.v1beta.Engine] configuration. + """Service for managing `Engine + `__ configuration. """ _client: EngineServiceClient @@ -313,7 +313,8 @@ async def create_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Creates a [Engine][google.cloud.discoveryengine.v1beta.Engine]. + r"""Creates a `Engine + `__. .. code-block:: python @@ -354,34 +355,40 @@ async def sample_create_engine(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.CreateEngineRequest, dict]]): The request object. Request for - [EngineService.CreateEngine][google.cloud.discoveryengine.v1beta.EngineService.CreateEngine] + `EngineService.CreateEngine + `__ method. parent (:class:`str`): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. engine (:class:`google.cloud.discoveryengine_v1beta.types.Engine`): - Required. The - [Engine][google.cloud.discoveryengine.v1beta.Engine] to - create. + Required. The `Engine + `__ + to create. This corresponds to the ``engine`` field on the ``request`` instance; if ``request`` is provided, this should not be set. engine_id (:class:`str`): Required. The ID to use for the - [Engine][google.cloud.discoveryengine.v1beta.Engine], - which will become the final component of the - [Engine][google.cloud.discoveryengine.v1beta.Engine]'s + `Engine + `__, + which will become the final component of + the + `Engine + `__'s resource name. - This field must conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. - Otherwise, an INVALID_ARGUMENT error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 + characters. Otherwise, an + INVALID_ARGUMENT error is returned. This corresponds to the ``engine_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -396,10 +403,14 @@ async def sample_create_engine(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.Engine` Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1beta.Engine]. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.Engine` + Metadata that describes the training and + serving parameters of an `Engine + `__. """ # Create or coerce a protobuf request object. @@ -472,7 +483,8 @@ async def delete_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Deletes a [Engine][google.cloud.discoveryengine.v1beta.Engine]. + r"""Deletes a `Engine + `__. .. code-block:: python @@ -507,22 +519,26 @@ async def sample_delete_engine(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.DeleteEngineRequest, dict]]): The request object. Request message for - [EngineService.DeleteEngine][google.cloud.discoveryengine.v1beta.EngineService.DeleteEngine] + `EngineService.DeleteEngine + `__ method. name (:class:`str`): Required. Full resource name of - [Engine][google.cloud.discoveryengine.v1beta.Engine], + `Engine + `__, such as ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. - If the caller does not have permission to delete the - [Engine][google.cloud.discoveryengine.v1beta.Engine], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to delete the `Engine + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the - [Engine][google.cloud.discoveryengine.v1beta.Engine] to - delete does not exist, a NOT_FOUND error is returned. + If the `Engine + `__ + to delete does not exist, a NOT_FOUND + error is returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -537,18 +553,21 @@ async def sample_delete_engine(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. @@ -618,7 +637,8 @@ async def update_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_engine.Engine: - r"""Updates an [Engine][google.cloud.discoveryengine.v1beta.Engine] + r"""Updates an `Engine + `__ .. code-block:: python @@ -653,32 +673,37 @@ async def sample_update_engine(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.UpdateEngineRequest, dict]]): The request object. Request message for - [EngineService.UpdateEngine][google.cloud.discoveryengine.v1beta.EngineService.UpdateEngine] + `EngineService.UpdateEngine + `__ method. engine (:class:`google.cloud.discoveryengine_v1beta.types.Engine`): - Required. The - [Engine][google.cloud.discoveryengine.v1beta.Engine] to - update. + Required. The `Engine + `__ + to update. - If the caller does not have permission to update the - [Engine][google.cloud.discoveryengine.v1beta.Engine], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to update the `Engine + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the - [Engine][google.cloud.discoveryengine.v1beta.Engine] to - update does not exist, a NOT_FOUND error is returned. + If the `Engine + `__ + to update does not exist, a NOT_FOUND + error is returned. This corresponds to the ``engine`` field on the ``request`` instance; if ``request`` is provided, this should not be set. update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): Indicates which fields in the provided - [Engine][google.cloud.discoveryengine.v1beta.Engine] to - update. + `Engine + `__ + to update. - If an unsupported or unknown field is provided, an - INVALID_ARGUMENT error is returned. + If an unsupported or unknown field is + provided, an INVALID_ARGUMENT error is + returned. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -693,8 +718,9 @@ async def sample_update_engine(): Returns: google.cloud.discoveryengine_v1beta.types.Engine: - Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1beta.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ # Create or coerce a protobuf request object. @@ -759,7 +785,8 @@ async def get_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> engine.Engine: - r"""Gets a [Engine][google.cloud.discoveryengine.v1beta.Engine]. + r"""Gets a `Engine + `__. .. code-block:: python @@ -790,11 +817,13 @@ async def sample_get_engine(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.GetEngineRequest, dict]]): The request object. Request message for - [EngineService.GetEngine][google.cloud.discoveryengine.v1beta.EngineService.GetEngine] + `EngineService.GetEngine + `__ method. name (:class:`str`): Required. Full resource name of - [Engine][google.cloud.discoveryengine.v1beta.Engine], + `Engine + `__, such as ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. @@ -811,8 +840,9 @@ async def sample_get_engine(): Returns: google.cloud.discoveryengine_v1beta.types.Engine: - Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1beta.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ # Create or coerce a protobuf request object. @@ -873,9 +903,9 @@ async def list_engines( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListEnginesAsyncPager: - r"""Lists all the - [Engine][google.cloud.discoveryengine.v1beta.Engine]s associated - with the project. + r"""Lists all the `Engine + `__s + associated with the project. .. code-block:: python @@ -907,10 +937,12 @@ async def sample_list_engines(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.ListEnginesRequest, dict]]): The request object. Request message for - [EngineService.ListEngines][google.cloud.discoveryengine.v1beta.EngineService.ListEngines] + `EngineService.ListEngines + `__ method. parent (:class:`str`): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/collections/{collection_id}``. This corresponds to the ``parent`` field @@ -927,11 +959,13 @@ async def sample_list_engines(): Returns: google.cloud.discoveryengine_v1beta.services.engine_service.pagers.ListEnginesAsyncPager: Response message for - [EngineService.ListEngines][google.cloud.discoveryengine.v1beta.EngineService.ListEngines] - method. + `EngineService.ListEngines + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -1003,10 +1037,11 @@ async def pause_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> engine.Engine: - r"""Pauses the training of an existing engine. Only applicable if - [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + r"""Pauses the training of an existing engine. Only + applicable if `SolutionType + `__ is + `SOLUTION_TYPE_RECOMMENDATION + `__. .. code-block:: python @@ -1039,7 +1074,9 @@ async def sample_pause_engine(): The request object. Request for pausing training of an engine. name (:class:`str`): - Required. The name of the engine to pause. Format: + Required. The name of the engine to + pause. Format: + ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`` This corresponds to the ``name`` field @@ -1055,8 +1092,9 @@ async def sample_pause_engine(): Returns: google.cloud.discoveryengine_v1beta.types.Engine: - Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1beta.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ # Create or coerce a protobuf request object. @@ -1117,10 +1155,11 @@ async def resume_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> engine.Engine: - r"""Resumes the training of an existing engine. Only applicable if - [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + r"""Resumes the training of an existing engine. Only + applicable if `SolutionType + `__ is + `SOLUTION_TYPE_RECOMMENDATION + `__. .. code-block:: python @@ -1153,7 +1192,9 @@ async def sample_resume_engine(): The request object. Request for resuming training of an engine. name (:class:`str`): - Required. The name of the engine to resume. Format: + Required. The name of the engine to + resume. Format: + ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`` This corresponds to the ``name`` field @@ -1169,8 +1210,9 @@ async def sample_resume_engine(): Returns: google.cloud.discoveryengine_v1beta.types.Engine: - Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1beta.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ # Create or coerce a protobuf request object. @@ -1232,9 +1274,10 @@ async def tune_engine( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: r"""Tunes an existing engine. Only applicable if - [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + `SolutionType + `__ is + `SOLUTION_TYPE_RECOMMENDATION + `__. .. code-block:: python @@ -1273,8 +1316,9 @@ async def sample_tune_engine(): periodically scheduled tuning to happen). name (:class:`str`): - Required. The resource name of the engine to tune. - Format: + Required. The resource name of the + engine to tune. Format: + ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`` This corresponds to the ``name`` field @@ -1290,11 +1334,13 @@ async def sample_tune_engine(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1beta.types.TuneEngineResponse` - Response associated with a tune operation. + Response associated with a tune + operation. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/engine_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/engine_service/client.py index 3fb860fefcf8..8f147eb14663 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/engine_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/engine_service/client.py @@ -117,8 +117,8 @@ def get_transport_class( class EngineServiceClient(metaclass=EngineServiceClientMeta): - """Service for managing - [Engine][google.cloud.discoveryengine.v1beta.Engine] configuration. + """Service for managing `Engine + `__ configuration. """ @staticmethod @@ -758,7 +758,8 @@ def create_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Creates a [Engine][google.cloud.discoveryengine.v1beta.Engine]. + r"""Creates a `Engine + `__. .. code-block:: python @@ -799,34 +800,40 @@ def sample_create_engine(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.CreateEngineRequest, dict]): The request object. Request for - [EngineService.CreateEngine][google.cloud.discoveryengine.v1beta.EngineService.CreateEngine] + `EngineService.CreateEngine + `__ method. parent (str): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. engine (google.cloud.discoveryengine_v1beta.types.Engine): - Required. The - [Engine][google.cloud.discoveryengine.v1beta.Engine] to - create. + Required. The `Engine + `__ + to create. This corresponds to the ``engine`` field on the ``request`` instance; if ``request`` is provided, this should not be set. engine_id (str): Required. The ID to use for the - [Engine][google.cloud.discoveryengine.v1beta.Engine], - which will become the final component of the - [Engine][google.cloud.discoveryengine.v1beta.Engine]'s + `Engine + `__, + which will become the final component of + the + `Engine + `__'s resource name. - This field must conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. - Otherwise, an INVALID_ARGUMENT error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 + characters. Otherwise, an + INVALID_ARGUMENT error is returned. This corresponds to the ``engine_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -841,10 +848,14 @@ def sample_create_engine(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.Engine` Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1beta.Engine]. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.Engine` + Metadata that describes the training and + serving parameters of an `Engine + `__. """ # Create or coerce a protobuf request object. @@ -914,7 +925,8 @@ def delete_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Deletes a [Engine][google.cloud.discoveryengine.v1beta.Engine]. + r"""Deletes a `Engine + `__. .. code-block:: python @@ -949,22 +961,26 @@ def sample_delete_engine(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.DeleteEngineRequest, dict]): The request object. Request message for - [EngineService.DeleteEngine][google.cloud.discoveryengine.v1beta.EngineService.DeleteEngine] + `EngineService.DeleteEngine + `__ method. name (str): Required. Full resource name of - [Engine][google.cloud.discoveryengine.v1beta.Engine], + `Engine + `__, such as ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. - If the caller does not have permission to delete the - [Engine][google.cloud.discoveryengine.v1beta.Engine], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to delete the `Engine + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the - [Engine][google.cloud.discoveryengine.v1beta.Engine] to - delete does not exist, a NOT_FOUND error is returned. + If the `Engine + `__ + to delete does not exist, a NOT_FOUND + error is returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -979,18 +995,21 @@ def sample_delete_engine(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. @@ -1057,7 +1076,8 @@ def update_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_engine.Engine: - r"""Updates an [Engine][google.cloud.discoveryengine.v1beta.Engine] + r"""Updates an `Engine + `__ .. code-block:: python @@ -1092,32 +1112,37 @@ def sample_update_engine(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.UpdateEngineRequest, dict]): The request object. Request message for - [EngineService.UpdateEngine][google.cloud.discoveryengine.v1beta.EngineService.UpdateEngine] + `EngineService.UpdateEngine + `__ method. engine (google.cloud.discoveryengine_v1beta.types.Engine): - Required. The - [Engine][google.cloud.discoveryengine.v1beta.Engine] to - update. + Required. The `Engine + `__ + to update. - If the caller does not have permission to update the - [Engine][google.cloud.discoveryengine.v1beta.Engine], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to update the `Engine + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the - [Engine][google.cloud.discoveryengine.v1beta.Engine] to - update does not exist, a NOT_FOUND error is returned. + If the `Engine + `__ + to update does not exist, a NOT_FOUND + error is returned. This corresponds to the ``engine`` field on the ``request`` instance; if ``request`` is provided, this should not be set. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [Engine][google.cloud.discoveryengine.v1beta.Engine] to - update. + `Engine + `__ + to update. - If an unsupported or unknown field is provided, an - INVALID_ARGUMENT error is returned. + If an unsupported or unknown field is + provided, an INVALID_ARGUMENT error is + returned. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -1132,8 +1157,9 @@ def sample_update_engine(): Returns: google.cloud.discoveryengine_v1beta.types.Engine: - Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1beta.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ # Create or coerce a protobuf request object. @@ -1195,7 +1221,8 @@ def get_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> engine.Engine: - r"""Gets a [Engine][google.cloud.discoveryengine.v1beta.Engine]. + r"""Gets a `Engine + `__. .. code-block:: python @@ -1226,11 +1253,13 @@ def sample_get_engine(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.GetEngineRequest, dict]): The request object. Request message for - [EngineService.GetEngine][google.cloud.discoveryengine.v1beta.EngineService.GetEngine] + `EngineService.GetEngine + `__ method. name (str): Required. Full resource name of - [Engine][google.cloud.discoveryengine.v1beta.Engine], + `Engine + `__, such as ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. @@ -1247,8 +1276,9 @@ def sample_get_engine(): Returns: google.cloud.discoveryengine_v1beta.types.Engine: - Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1beta.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ # Create or coerce a protobuf request object. @@ -1306,9 +1336,9 @@ def list_engines( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListEnginesPager: - r"""Lists all the - [Engine][google.cloud.discoveryengine.v1beta.Engine]s associated - with the project. + r"""Lists all the `Engine + `__s + associated with the project. .. code-block:: python @@ -1340,10 +1370,12 @@ def sample_list_engines(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.ListEnginesRequest, dict]): The request object. Request message for - [EngineService.ListEngines][google.cloud.discoveryengine.v1beta.EngineService.ListEngines] + `EngineService.ListEngines + `__ method. parent (str): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/collections/{collection_id}``. This corresponds to the ``parent`` field @@ -1360,11 +1392,13 @@ def sample_list_engines(): Returns: google.cloud.discoveryengine_v1beta.services.engine_service.pagers.ListEnginesPager: Response message for - [EngineService.ListEngines][google.cloud.discoveryengine.v1beta.EngineService.ListEngines] - method. + `EngineService.ListEngines + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -1433,10 +1467,11 @@ def pause_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> engine.Engine: - r"""Pauses the training of an existing engine. Only applicable if - [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + r"""Pauses the training of an existing engine. Only + applicable if `SolutionType + `__ is + `SOLUTION_TYPE_RECOMMENDATION + `__. .. code-block:: python @@ -1469,7 +1504,9 @@ def sample_pause_engine(): The request object. Request for pausing training of an engine. name (str): - Required. The name of the engine to pause. Format: + Required. The name of the engine to + pause. Format: + ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`` This corresponds to the ``name`` field @@ -1485,8 +1522,9 @@ def sample_pause_engine(): Returns: google.cloud.discoveryengine_v1beta.types.Engine: - Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1beta.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ # Create or coerce a protobuf request object. @@ -1544,10 +1582,11 @@ def resume_engine( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> engine.Engine: - r"""Resumes the training of an existing engine. Only applicable if - [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + r"""Resumes the training of an existing engine. Only + applicable if `SolutionType + `__ is + `SOLUTION_TYPE_RECOMMENDATION + `__. .. code-block:: python @@ -1580,7 +1619,9 @@ def sample_resume_engine(): The request object. Request for resuming training of an engine. name (str): - Required. The name of the engine to resume. Format: + Required. The name of the engine to + resume. Format: + ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`` This corresponds to the ``name`` field @@ -1596,8 +1637,9 @@ def sample_resume_engine(): Returns: google.cloud.discoveryengine_v1beta.types.Engine: - Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1beta.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ # Create or coerce a protobuf request object. @@ -1656,9 +1698,10 @@ def tune_engine( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: r"""Tunes an existing engine. Only applicable if - [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + `SolutionType + `__ is + `SOLUTION_TYPE_RECOMMENDATION + `__. .. code-block:: python @@ -1697,8 +1740,9 @@ def sample_tune_engine(): periodically scheduled tuning to happen). name (str): - Required. The resource name of the engine to tune. - Format: + Required. The resource name of the + engine to tune. Format: + ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`` This corresponds to the ``name`` field @@ -1714,11 +1758,13 @@ def sample_tune_engine(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1beta.types.TuneEngineResponse` - Response associated with a tune operation. + Response associated with a tune + operation. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/engine_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/engine_service/transports/grpc.py index 5870795ef656..887f7b120abb 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/engine_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/engine_service/transports/grpc.py @@ -114,8 +114,8 @@ def intercept_unary_unary(self, continuation, client_call_details, request): class EngineServiceGrpcTransport(EngineServiceTransport): """gRPC backend transport for EngineService. - Service for managing - [Engine][google.cloud.discoveryengine.v1beta.Engine] configuration. + Service for managing `Engine + `__ configuration. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -349,7 +349,8 @@ def create_engine( ) -> Callable[[engine_service.CreateEngineRequest], operations_pb2.Operation]: r"""Return a callable for the create engine method over gRPC. - Creates a [Engine][google.cloud.discoveryengine.v1beta.Engine]. + Creates a `Engine + `__. Returns: Callable[[~.CreateEngineRequest], @@ -375,7 +376,8 @@ def delete_engine( ) -> Callable[[engine_service.DeleteEngineRequest], operations_pb2.Operation]: r"""Return a callable for the delete engine method over gRPC. - Deletes a [Engine][google.cloud.discoveryengine.v1beta.Engine]. + Deletes a `Engine + `__. Returns: Callable[[~.DeleteEngineRequest], @@ -401,7 +403,8 @@ def update_engine( ) -> Callable[[engine_service.UpdateEngineRequest], gcd_engine.Engine]: r"""Return a callable for the update engine method over gRPC. - Updates an [Engine][google.cloud.discoveryengine.v1beta.Engine] + Updates an `Engine + `__ Returns: Callable[[~.UpdateEngineRequest], @@ -425,7 +428,8 @@ def update_engine( def get_engine(self) -> Callable[[engine_service.GetEngineRequest], engine.Engine]: r"""Return a callable for the get engine method over gRPC. - Gets a [Engine][google.cloud.discoveryengine.v1beta.Engine]. + Gets a `Engine + `__. Returns: Callable[[~.GetEngineRequest], @@ -453,9 +457,9 @@ def list_engines( ]: r"""Return a callable for the list engines method over gRPC. - Lists all the - [Engine][google.cloud.discoveryengine.v1beta.Engine]s associated - with the project. + Lists all the `Engine + `__s + associated with the project. Returns: Callable[[~.ListEnginesRequest], @@ -481,10 +485,11 @@ def pause_engine( ) -> Callable[[engine_service.PauseEngineRequest], engine.Engine]: r"""Return a callable for the pause engine method over gRPC. - Pauses the training of an existing engine. Only applicable if - [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + Pauses the training of an existing engine. Only + applicable if `SolutionType + `__ is + `SOLUTION_TYPE_RECOMMENDATION + `__. Returns: Callable[[~.PauseEngineRequest], @@ -510,10 +515,11 @@ def resume_engine( ) -> Callable[[engine_service.ResumeEngineRequest], engine.Engine]: r"""Return a callable for the resume engine method over gRPC. - Resumes the training of an existing engine. Only applicable if - [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + Resumes the training of an existing engine. Only + applicable if `SolutionType + `__ is + `SOLUTION_TYPE_RECOMMENDATION + `__. Returns: Callable[[~.ResumeEngineRequest], @@ -540,9 +546,10 @@ def tune_engine( r"""Return a callable for the tune engine method over gRPC. Tunes an existing engine. Only applicable if - [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + `SolutionType + `__ is + `SOLUTION_TYPE_RECOMMENDATION + `__. Returns: Callable[[~.TuneEngineRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/engine_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/engine_service/transports/grpc_asyncio.py index d9b75c05f3c8..7e21ada1c688 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/engine_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/engine_service/transports/grpc_asyncio.py @@ -120,8 +120,8 @@ async def intercept_unary_unary(self, continuation, client_call_details, request class EngineServiceGrpcAsyncIOTransport(EngineServiceTransport): """gRPC AsyncIO backend transport for EngineService. - Service for managing - [Engine][google.cloud.discoveryengine.v1beta.Engine] configuration. + Service for managing `Engine + `__ configuration. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -359,7 +359,8 @@ def create_engine( ]: r"""Return a callable for the create engine method over gRPC. - Creates a [Engine][google.cloud.discoveryengine.v1beta.Engine]. + Creates a `Engine + `__. Returns: Callable[[~.CreateEngineRequest], @@ -387,7 +388,8 @@ def delete_engine( ]: r"""Return a callable for the delete engine method over gRPC. - Deletes a [Engine][google.cloud.discoveryengine.v1beta.Engine]. + Deletes a `Engine + `__. Returns: Callable[[~.DeleteEngineRequest], @@ -413,7 +415,8 @@ def update_engine( ) -> Callable[[engine_service.UpdateEngineRequest], Awaitable[gcd_engine.Engine]]: r"""Return a callable for the update engine method over gRPC. - Updates an [Engine][google.cloud.discoveryengine.v1beta.Engine] + Updates an `Engine + `__ Returns: Callable[[~.UpdateEngineRequest], @@ -439,7 +442,8 @@ def get_engine( ) -> Callable[[engine_service.GetEngineRequest], Awaitable[engine.Engine]]: r"""Return a callable for the get engine method over gRPC. - Gets a [Engine][google.cloud.discoveryengine.v1beta.Engine]. + Gets a `Engine + `__. Returns: Callable[[~.GetEngineRequest], @@ -468,9 +472,9 @@ def list_engines( ]: r"""Return a callable for the list engines method over gRPC. - Lists all the - [Engine][google.cloud.discoveryengine.v1beta.Engine]s associated - with the project. + Lists all the `Engine + `__s + associated with the project. Returns: Callable[[~.ListEnginesRequest], @@ -496,10 +500,11 @@ def pause_engine( ) -> Callable[[engine_service.PauseEngineRequest], Awaitable[engine.Engine]]: r"""Return a callable for the pause engine method over gRPC. - Pauses the training of an existing engine. Only applicable if - [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + Pauses the training of an existing engine. Only + applicable if `SolutionType + `__ is + `SOLUTION_TYPE_RECOMMENDATION + `__. Returns: Callable[[~.PauseEngineRequest], @@ -525,10 +530,11 @@ def resume_engine( ) -> Callable[[engine_service.ResumeEngineRequest], Awaitable[engine.Engine]]: r"""Return a callable for the resume engine method over gRPC. - Resumes the training of an existing engine. Only applicable if - [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + Resumes the training of an existing engine. Only + applicable if `SolutionType + `__ is + `SOLUTION_TYPE_RECOMMENDATION + `__. Returns: Callable[[~.ResumeEngineRequest], @@ -557,9 +563,10 @@ def tune_engine( r"""Return a callable for the tune engine method over gRPC. Tunes an existing engine. Only applicable if - [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + `SolutionType + `__ is + `SOLUTION_TYPE_RECOMMENDATION + `__. Returns: Callable[[~.TuneEngineRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/engine_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/engine_service/transports/rest.py index 887e62d08bd5..b04f5c85c235 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/engine_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/engine_service/transports/rest.py @@ -602,8 +602,8 @@ class EngineServiceRestStub: class EngineServiceRestTransport(_BaseEngineServiceRestTransport): """REST backend synchronous transport for EngineService. - Service for managing - [Engine][google.cloud.discoveryengine.v1beta.Engine] configuration. + Service for managing `Engine + `__ configuration. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -887,7 +887,8 @@ def __call__( Args: request (~.engine_service.CreateEngineRequest): The request object. Request for - [EngineService.CreateEngine][google.cloud.discoveryengine.v1beta.EngineService.CreateEngine] + `EngineService.CreateEngine + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1039,7 +1040,8 @@ def __call__( Args: request (~.engine_service.DeleteEngineRequest): The request object. Request message for - [EngineService.DeleteEngine][google.cloud.discoveryengine.v1beta.EngineService.DeleteEngine] + `EngineService.DeleteEngine + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1186,7 +1188,8 @@ def __call__( Args: request (~.engine_service.GetEngineRequest): The request object. Request message for - [EngineService.GetEngine][google.cloud.discoveryengine.v1beta.EngineService.GetEngine] + `EngineService.GetEngine + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1198,9 +1201,9 @@ def __call__( Returns: ~.engine.Engine: - Metadata that describes the training and serving - parameters of an - [Engine][google.cloud.discoveryengine.v1beta.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ @@ -1339,7 +1342,8 @@ def __call__( Args: request (~.engine_service.ListEnginesRequest): The request object. Request message for - [EngineService.ListEngines][google.cloud.discoveryengine.v1beta.EngineService.ListEngines] + `EngineService.ListEngines + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1352,7 +1356,8 @@ def __call__( Returns: ~.engine_service.ListEnginesResponse: Response message for - [EngineService.ListEngines][google.cloud.discoveryengine.v1beta.EngineService.ListEngines] + `EngineService.ListEngines + `__ method. """ @@ -1504,9 +1509,9 @@ def __call__( Returns: ~.engine.Engine: - Metadata that describes the training and serving - parameters of an - [Engine][google.cloud.discoveryengine.v1beta.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ @@ -1662,9 +1667,9 @@ def __call__( Returns: ~.engine.Engine: - Metadata that describes the training and serving - parameters of an - [Engine][google.cloud.discoveryengine.v1beta.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ @@ -1965,7 +1970,8 @@ def __call__( Args: request (~.engine_service.UpdateEngineRequest): The request object. Request message for - [EngineService.UpdateEngine][google.cloud.discoveryengine.v1beta.EngineService.UpdateEngine] + `EngineService.UpdateEngine + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1977,9 +1983,9 @@ def __call__( Returns: ~.gcd_engine.Engine: - Metadata that describes the training and serving - parameters of an - [Engine][google.cloud.discoveryengine.v1beta.Engine]. + Metadata that describes the training and + serving parameters of an `Engine + `__. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/evaluation_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/evaluation_service/async_client.py index 43947eb1ca8f..ef930322a82e 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/evaluation_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/evaluation_service/async_client.py @@ -72,7 +72,8 @@ class EvaluationServiceAsyncClient: """Service for managing - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]s, + `Evaluation + `__s, """ _client: EvaluationServiceClient @@ -331,8 +332,8 @@ async def get_evaluation( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> evaluation.Evaluation: - r"""Gets a - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]. + r"""Gets a `Evaluation + `__. .. code-block:: python @@ -363,22 +364,27 @@ async def sample_get_evaluation(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.GetEvaluationRequest, dict]]): The request object. Request message for - [EvaluationService.GetEvaluation][google.cloud.discoveryengine.v1beta.EvaluationService.GetEvaluation] + `EvaluationService.GetEvaluation + `__ method. name (:class:`str`): Required. Full resource name of - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation], + `Evaluation + `__, such as ``projects/{project}/locations/{location}/evaluations/{evaluation}``. - If the caller does not have permission to access the - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `Evaluation + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. If the requested - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation] - does not exist, a NOT_FOUND error is returned. + `Evaluation + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -460,7 +466,8 @@ async def list_evaluations( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListEvaluationsAsyncPager: r"""Gets a list of - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]s. + `Evaluation + `__s. .. code-block:: python @@ -492,17 +499,20 @@ async def sample_list_evaluations(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.ListEvaluationsRequest, dict]]): The request object. Request message for - [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluations] + `EvaluationService.ListEvaluations + `__ method. parent (:class:`str`): - Required. The parent location resource name, such as + Required. The parent location resource + name, such as ``projects/{project}/locations/{location}``. - If the caller does not have permission to list - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]s - under this location, regardless of whether or not this - location exists, a ``PERMISSION_DENIED`` error is - returned. + If the caller does not have permission + to list `Evaluation + `__s + under this location, regardless of + whether or not this location exists, a + ``PERMISSION_DENIED`` error is returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -518,11 +528,13 @@ async def sample_list_evaluations(): Returns: google.cloud.discoveryengine_v1beta.services.evaluation_service.pagers.ListEvaluationsAsyncPager: Response message for - [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluations] - method. + `EvaluationService.ListEvaluations + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -597,11 +609,10 @@ async def create_evaluation( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Creates a - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]. - - Upon creation, the evaluation will be automatically triggered - and begin execution. + r"""Creates a `Evaluation + `__. + Upon creation, the evaluation will be automatically + triggered and begin execution. .. code-block:: python @@ -641,18 +652,20 @@ async def sample_create_evaluation(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.CreateEvaluationRequest, dict]]): The request object. Request message for - [EvaluationService.CreateEvaluation][google.cloud.discoveryengine.v1beta.EvaluationService.CreateEvaluation] + `EvaluationService.CreateEvaluation + `__ method. parent (:class:`str`): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. evaluation (:class:`google.cloud.discoveryengine_v1beta.types.Evaluation`): - Required. The - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation] + Required. The `Evaluation + `__ to create. This corresponds to the ``evaluation`` field @@ -668,11 +681,15 @@ async def sample_create_evaluation(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.Evaluation` An evaluation is a single execution (or run) of an evaluation process. It - encapsulates the state of the evaluation and the - resulting data. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.Evaluation` + An evaluation is a single execution (or + run) of an evaluation process. It + encapsulates the state of the evaluation + and the resulting data. """ # Create or coerce a protobuf request object. @@ -746,7 +763,8 @@ async def list_evaluation_results( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListEvaluationResultsAsyncPager: r"""Gets a list of results for a given a - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]. + `Evaluation + `__. .. code-block:: python @@ -778,15 +796,18 @@ async def sample_list_evaluation_results(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.ListEvaluationResultsRequest, dict]]): The request object. Request message for - [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults] + `EvaluationService.ListEvaluationResults + `__ method. evaluation (:class:`str`): - Required. The evaluation resource name, such as + Required. The evaluation resource name, + such as ``projects/{project}/locations/{location}/evaluations/{evaluation}``. - If the caller does not have permission to list - [EvaluationResult][] under this evaluation, regardless - of whether or not this evaluation set exists, a + If the caller does not have permission + to list [EvaluationResult][] under this + evaluation, regardless of whether or not + this evaluation set exists, a ``PERMISSION_DENIED`` error is returned. This corresponds to the ``evaluation`` field @@ -803,11 +824,13 @@ async def sample_list_evaluation_results(): Returns: google.cloud.discoveryengine_v1beta.services.evaluation_service.pagers.ListEvaluationResultsAsyncPager: Response message for - [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults] - method. + `EvaluationService.ListEvaluationResults + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/evaluation_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/evaluation_service/client.py index fb25635d3e51..4681cf10292c 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/evaluation_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/evaluation_service/client.py @@ -118,7 +118,8 @@ def get_transport_class( class EvaluationServiceClient(metaclass=EvaluationServiceClientMeta): """Service for managing - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]s, + `Evaluation + `__s, """ @staticmethod @@ -894,8 +895,8 @@ def get_evaluation( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> evaluation.Evaluation: - r"""Gets a - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]. + r"""Gets a `Evaluation + `__. .. code-block:: python @@ -926,22 +927,27 @@ def sample_get_evaluation(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.GetEvaluationRequest, dict]): The request object. Request message for - [EvaluationService.GetEvaluation][google.cloud.discoveryengine.v1beta.EvaluationService.GetEvaluation] + `EvaluationService.GetEvaluation + `__ method. name (str): Required. Full resource name of - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation], + `Evaluation + `__, such as ``projects/{project}/locations/{location}/evaluations/{evaluation}``. - If the caller does not have permission to access the - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `Evaluation + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. If the requested - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation] - does not exist, a NOT_FOUND error is returned. + `Evaluation + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -1020,7 +1026,8 @@ def list_evaluations( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListEvaluationsPager: r"""Gets a list of - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]s. + `Evaluation + `__s. .. code-block:: python @@ -1052,17 +1059,20 @@ def sample_list_evaluations(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.ListEvaluationsRequest, dict]): The request object. Request message for - [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluations] + `EvaluationService.ListEvaluations + `__ method. parent (str): - Required. The parent location resource name, such as + Required. The parent location resource + name, such as ``projects/{project}/locations/{location}``. - If the caller does not have permission to list - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]s - under this location, regardless of whether or not this - location exists, a ``PERMISSION_DENIED`` error is - returned. + If the caller does not have permission + to list `Evaluation + `__s + under this location, regardless of + whether or not this location exists, a + ``PERMISSION_DENIED`` error is returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -1078,11 +1088,13 @@ def sample_list_evaluations(): Returns: google.cloud.discoveryengine_v1beta.services.evaluation_service.pagers.ListEvaluationsPager: Response message for - [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluations] - method. + `EvaluationService.ListEvaluations + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -1154,11 +1166,10 @@ def create_evaluation( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Creates a - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]. - - Upon creation, the evaluation will be automatically triggered - and begin execution. + r"""Creates a `Evaluation + `__. + Upon creation, the evaluation will be automatically + triggered and begin execution. .. code-block:: python @@ -1198,18 +1209,20 @@ def sample_create_evaluation(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.CreateEvaluationRequest, dict]): The request object. Request message for - [EvaluationService.CreateEvaluation][google.cloud.discoveryengine.v1beta.EvaluationService.CreateEvaluation] + `EvaluationService.CreateEvaluation + `__ method. parent (str): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. evaluation (google.cloud.discoveryengine_v1beta.types.Evaluation): - Required. The - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation] + Required. The `Evaluation + `__ to create. This corresponds to the ``evaluation`` field @@ -1225,11 +1238,15 @@ def sample_create_evaluation(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.Evaluation` An evaluation is a single execution (or run) of an evaluation process. It - encapsulates the state of the evaluation and the - resulting data. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.Evaluation` + An evaluation is a single execution (or + run) of an evaluation process. It + encapsulates the state of the evaluation + and the resulting data. """ # Create or coerce a protobuf request object. @@ -1300,7 +1317,8 @@ def list_evaluation_results( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListEvaluationResultsPager: r"""Gets a list of results for a given a - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]. + `Evaluation + `__. .. code-block:: python @@ -1332,15 +1350,18 @@ def sample_list_evaluation_results(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.ListEvaluationResultsRequest, dict]): The request object. Request message for - [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults] + `EvaluationService.ListEvaluationResults + `__ method. evaluation (str): - Required. The evaluation resource name, such as + Required. The evaluation resource name, + such as ``projects/{project}/locations/{location}/evaluations/{evaluation}``. - If the caller does not have permission to list - [EvaluationResult][] under this evaluation, regardless - of whether or not this evaluation set exists, a + If the caller does not have permission + to list [EvaluationResult][] under this + evaluation, regardless of whether or not + this evaluation set exists, a ``PERMISSION_DENIED`` error is returned. This corresponds to the ``evaluation`` field @@ -1357,11 +1378,13 @@ def sample_list_evaluation_results(): Returns: google.cloud.discoveryengine_v1beta.services.evaluation_service.pagers.ListEvaluationResultsPager: Response message for - [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults] - method. + `EvaluationService.ListEvaluationResults + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/evaluation_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/evaluation_service/transports/grpc.py index eab8f572169b..2350e005e7b2 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/evaluation_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/evaluation_service/transports/grpc.py @@ -113,7 +113,8 @@ class EvaluationServiceGrpcTransport(EvaluationServiceTransport): """gRPC backend transport for EvaluationService. Service for managing - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]s, + `Evaluation + `__s, This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -347,8 +348,8 @@ def get_evaluation( ) -> Callable[[evaluation_service.GetEvaluationRequest], evaluation.Evaluation]: r"""Return a callable for the get evaluation method over gRPC. - Gets a - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]. + Gets a `Evaluation + `__. Returns: Callable[[~.GetEvaluationRequest], @@ -378,7 +379,8 @@ def list_evaluations( r"""Return a callable for the list evaluations method over gRPC. Gets a list of - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]s. + `Evaluation + `__s. Returns: Callable[[~.ListEvaluationsRequest], @@ -406,11 +408,10 @@ def create_evaluation( ]: r"""Return a callable for the create evaluation method over gRPC. - Creates a - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]. - - Upon creation, the evaluation will be automatically triggered - and begin execution. + Creates a `Evaluation + `__. + Upon creation, the evaluation will be automatically + triggered and begin execution. Returns: Callable[[~.CreateEvaluationRequest], @@ -440,7 +441,8 @@ def list_evaluation_results( r"""Return a callable for the list evaluation results method over gRPC. Gets a list of results for a given a - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]. + `Evaluation + `__. Returns: Callable[[~.ListEvaluationResultsRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/evaluation_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/evaluation_service/transports/grpc_asyncio.py index f1d611ceb6af..24d7db484608 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/evaluation_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/evaluation_service/transports/grpc_asyncio.py @@ -119,7 +119,8 @@ class EvaluationServiceGrpcAsyncIOTransport(EvaluationServiceTransport): """gRPC AsyncIO backend transport for EvaluationService. Service for managing - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]s, + `Evaluation + `__s, This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -357,8 +358,8 @@ def get_evaluation( ]: r"""Return a callable for the get evaluation method over gRPC. - Gets a - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]. + Gets a `Evaluation + `__. Returns: Callable[[~.GetEvaluationRequest], @@ -388,7 +389,8 @@ def list_evaluations( r"""Return a callable for the list evaluations method over gRPC. Gets a list of - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]s. + `Evaluation + `__s. Returns: Callable[[~.ListEvaluationsRequest], @@ -417,11 +419,10 @@ def create_evaluation( ]: r"""Return a callable for the create evaluation method over gRPC. - Creates a - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]. - - Upon creation, the evaluation will be automatically triggered - and begin execution. + Creates a `Evaluation + `__. + Upon creation, the evaluation will be automatically + triggered and begin execution. Returns: Callable[[~.CreateEvaluationRequest], @@ -451,7 +452,8 @@ def list_evaluation_results( r"""Return a callable for the list evaluation results method over gRPC. Gets a list of results for a given a - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]. + `Evaluation + `__. Returns: Callable[[~.ListEvaluationResultsRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/evaluation_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/evaluation_service/transports/rest.py index 54e4267e7cd7..3c0ba9b5fccf 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/evaluation_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/evaluation_service/transports/rest.py @@ -398,7 +398,8 @@ class EvaluationServiceRestTransport(_BaseEvaluationServiceRestTransport): """REST backend synchronous transport for EvaluationService. Service for managing - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]s, + `Evaluation + `__s, This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -683,7 +684,8 @@ def __call__( Args: request (~.evaluation_service.CreateEvaluationRequest): The request object. Request message for - [EvaluationService.CreateEvaluation][google.cloud.discoveryengine.v1beta.EvaluationService.CreateEvaluation] + `EvaluationService.CreateEvaluation + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -838,7 +840,8 @@ def __call__( Args: request (~.evaluation_service.GetEvaluationRequest): The request object. Request message for - [EvaluationService.GetEvaluation][google.cloud.discoveryengine.v1beta.EvaluationService.GetEvaluation] + `EvaluationService.GetEvaluation + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -989,7 +992,8 @@ def __call__( Args: request (~.evaluation_service.ListEvaluationResultsRequest): The request object. Request message for - [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults] + `EvaluationService.ListEvaluationResults + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1002,7 +1006,8 @@ def __call__( Returns: ~.evaluation_service.ListEvaluationResultsResponse: Response message for - [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults] + `EvaluationService.ListEvaluationResults + `__ method. """ @@ -1147,7 +1152,8 @@ def __call__( Args: request (~.evaluation_service.ListEvaluationsRequest): The request object. Request message for - [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluations] + `EvaluationService.ListEvaluations + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1160,7 +1166,8 @@ def __call__( Returns: ~.evaluation_service.ListEvaluationsResponse: Response message for - [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluations] + `EvaluationService.ListEvaluations + `__ method. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/grounded_generation_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/grounded_generation_service/async_client.py index c65372ddc526..d614726cd2a5 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/grounded_generation_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/grounded_generation_service/async_client.py @@ -374,8 +374,8 @@ def request_generator(): Args: requests (AsyncIterator[`google.cloud.discoveryengine_v1beta.types.GenerateGroundedContentRequest`]): - The request object AsyncIterator. Top-level message sent by the client for the - ``GenerateGroundedContent`` method. + The request object AsyncIterator. Top-level message sent by the client for + the ``GenerateGroundedContent`` method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -386,7 +386,9 @@ def request_generator(): Returns: AsyncIterable[google.cloud.discoveryengine_v1beta.types.GenerateGroundedContentResponse]: - Response for the GenerateGroundedContent method. + Response for the + ``GenerateGroundedContent`` method. + """ # Wrap the RPC method; this adds retry and timeout information, @@ -453,8 +455,8 @@ async def sample_generate_grounded_content(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.GenerateGroundedContentRequest, dict]]): - The request object. Top-level message sent by the client for the - ``GenerateGroundedContent`` method. + The request object. Top-level message sent by the client for + the ``GenerateGroundedContent`` method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -465,7 +467,9 @@ async def sample_generate_grounded_content(): Returns: google.cloud.discoveryengine_v1beta.types.GenerateGroundedContentResponse: - Response for the GenerateGroundedContent method. + Response for the + ``GenerateGroundedContent`` method. + """ # Create or coerce a protobuf request object. # - Use the request object if provided (there's no risk of modifying the input as @@ -544,7 +548,8 @@ async def sample_check_grounding(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.CheckGroundingRequest, dict]]): The request object. Request message for - [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1beta.GroundedGenerationService.CheckGrounding] + `GroundedGenerationService.CheckGrounding + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -557,8 +562,9 @@ async def sample_check_grounding(): Returns: google.cloud.discoveryengine_v1beta.types.CheckGroundingResponse: Response message for the - [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1beta.GroundedGenerationService.CheckGrounding] - method. + `GroundedGenerationService.CheckGrounding + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/grounded_generation_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/grounded_generation_service/client.py index 593a48b016a6..a0e2bf67d442 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/grounded_generation_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/grounded_generation_service/client.py @@ -818,8 +818,8 @@ def request_generator(): Args: requests (Iterator[google.cloud.discoveryengine_v1beta.types.GenerateGroundedContentRequest]): - The request object iterator. Top-level message sent by the client for the - ``GenerateGroundedContent`` method. + The request object iterator. Top-level message sent by the client for + the ``GenerateGroundedContent`` method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -830,7 +830,9 @@ def request_generator(): Returns: Iterable[google.cloud.discoveryengine_v1beta.types.GenerateGroundedContentResponse]: - Response for the GenerateGroundedContent method. + Response for the + ``GenerateGroundedContent`` method. + """ # Wrap the RPC method; this adds retry and timeout information, @@ -897,8 +899,8 @@ def sample_generate_grounded_content(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.GenerateGroundedContentRequest, dict]): - The request object. Top-level message sent by the client for the - ``GenerateGroundedContent`` method. + The request object. Top-level message sent by the client for + the ``GenerateGroundedContent`` method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -909,7 +911,9 @@ def sample_generate_grounded_content(): Returns: google.cloud.discoveryengine_v1beta.types.GenerateGroundedContentResponse: - Response for the GenerateGroundedContent method. + Response for the + ``GenerateGroundedContent`` method. + """ # Create or coerce a protobuf request object. # - Use the request object if provided (there's no risk of modifying the input as @@ -988,7 +992,8 @@ def sample_check_grounding(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.CheckGroundingRequest, dict]): The request object. Request message for - [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1beta.GroundedGenerationService.CheckGrounding] + `GroundedGenerationService.CheckGrounding + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1001,8 +1006,9 @@ def sample_check_grounding(): Returns: google.cloud.discoveryengine_v1beta.types.CheckGroundingResponse: Response message for the - [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1beta.GroundedGenerationService.CheckGrounding] - method. + `GroundedGenerationService.CheckGrounding + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/grounded_generation_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/grounded_generation_service/transports/rest.py index 4f218f7971e9..5c7a4e1098e9 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/grounded_generation_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/grounded_generation_service/transports/rest.py @@ -406,7 +406,8 @@ def __call__( Args: request (~.grounded_generation_service.CheckGroundingRequest): The request object. Request message for - [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1beta.GroundedGenerationService.CheckGrounding] + `GroundedGenerationService.CheckGrounding + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -419,7 +420,8 @@ def __call__( Returns: ~.grounded_generation_service.CheckGroundingResponse: Response message for the - [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1beta.GroundedGenerationService.CheckGrounding] + `GroundedGenerationService.CheckGrounding + `__ method. """ @@ -569,8 +571,8 @@ def __call__( Args: request (~.grounded_generation_service.GenerateGroundedContentRequest): - The request object. Top-level message sent by the client for the - ``GenerateGroundedContent`` method. + The request object. Top-level message sent by the client for + the ``GenerateGroundedContent`` method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. @@ -581,7 +583,9 @@ def __call__( Returns: ~.grounded_generation_service.GenerateGroundedContentResponse: - Response for the ``GenerateGroundedContent`` method. + Response for the + ``GenerateGroundedContent`` method. + """ http_options = ( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/project_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/project_service/async_client.py index 552a89a63156..a42758a74931 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/project_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/project_service/async_client.py @@ -67,7 +67,7 @@ class ProjectServiceAsyncClient: """Service for operations on the - [Project][google.cloud.discoveryengine.v1beta.Project]. + `Project `__. """ _client: ProjectServiceClient @@ -302,13 +302,14 @@ async def provision_project( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Provisions the project resource. During the process, related - systems will get prepared and initialized. + r"""Provisions the project resource. During the + process, related systems will get prepared and + initialized. Caller must read the `Terms for data - use `__, and - optionally specify in request to provide consent to that service - terms. + use `__, + and optionally specify in request to provide consent to + that service terms. .. code-block:: python @@ -345,12 +346,15 @@ async def sample_provision_project(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.ProvisionProjectRequest, dict]]): The request object. Request for - [ProjectService.ProvisionProject][google.cloud.discoveryengine.v1beta.ProjectService.ProvisionProject] + `ProjectService.ProvisionProject + `__ method. name (:class:`str`): Required. Full resource name of a - [Project][google.cloud.discoveryengine.v1beta.Project], - such as ``projects/{project_id_or_number}``. + `Project + `__, + such as + ``projects/{project_id_or_number}``. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -365,12 +369,13 @@ async def sample_provision_project(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1beta.types.Project` - Metadata and configurations for a Google Cloud project - in the service. + Metadata and configurations for a Google + Cloud project in the service. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/project_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/project_service/client.py index ac35ae297646..9e295de3dbc3 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/project_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/project_service/client.py @@ -113,7 +113,7 @@ def get_transport_class( class ProjectServiceClient(metaclass=ProjectServiceClientMeta): """Service for operations on the - [Project][google.cloud.discoveryengine.v1beta.Project]. + `Project `__. """ @staticmethod @@ -718,13 +718,14 @@ def provision_project( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Provisions the project resource. During the process, related - systems will get prepared and initialized. + r"""Provisions the project resource. During the + process, related systems will get prepared and + initialized. Caller must read the `Terms for data - use `__, and - optionally specify in request to provide consent to that service - terms. + use `__, + and optionally specify in request to provide consent to + that service terms. .. code-block:: python @@ -761,12 +762,15 @@ def sample_provision_project(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.ProvisionProjectRequest, dict]): The request object. Request for - [ProjectService.ProvisionProject][google.cloud.discoveryengine.v1beta.ProjectService.ProvisionProject] + `ProjectService.ProvisionProject + `__ method. name (str): Required. Full resource name of a - [Project][google.cloud.discoveryengine.v1beta.Project], - such as ``projects/{project_id_or_number}``. + `Project + `__, + such as + ``projects/{project_id_or_number}``. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -781,12 +785,13 @@ def sample_provision_project(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1beta.types.Project` - Metadata and configurations for a Google Cloud project - in the service. + Metadata and configurations for a Google + Cloud project in the service. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/project_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/project_service/transports/grpc.py index 06508f0203a3..00c8201eb037 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/project_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/project_service/transports/grpc.py @@ -113,7 +113,7 @@ class ProjectServiceGrpcTransport(ProjectServiceTransport): """gRPC backend transport for ProjectService. Service for operations on the - [Project][google.cloud.discoveryengine.v1beta.Project]. + `Project `__. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -347,13 +347,14 @@ def provision_project( ) -> Callable[[project_service.ProvisionProjectRequest], operations_pb2.Operation]: r"""Return a callable for the provision project method over gRPC. - Provisions the project resource. During the process, related - systems will get prepared and initialized. + Provisions the project resource. During the + process, related systems will get prepared and + initialized. Caller must read the `Terms for data - use `__, and - optionally specify in request to provide consent to that service - terms. + use `__, + and optionally specify in request to provide consent to + that service terms. Returns: Callable[[~.ProvisionProjectRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/project_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/project_service/transports/grpc_asyncio.py index d1bdfde6cdd3..8912403ceebd 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/project_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/project_service/transports/grpc_asyncio.py @@ -119,7 +119,7 @@ class ProjectServiceGrpcAsyncIOTransport(ProjectServiceTransport): """gRPC AsyncIO backend transport for ProjectService. Service for operations on the - [Project][google.cloud.discoveryengine.v1beta.Project]. + `Project `__. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -357,13 +357,14 @@ def provision_project( ]: r"""Return a callable for the provision project method over gRPC. - Provisions the project resource. During the process, related - systems will get prepared and initialized. + Provisions the project resource. During the + process, related systems will get prepared and + initialized. Caller must read the `Terms for data - use `__, and - optionally specify in request to provide consent to that service - terms. + use `__, + and optionally specify in request to provide consent to + that service terms. Returns: Callable[[~.ProvisionProjectRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/project_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/project_service/transports/rest.py index e0f89fde21a5..5cc477268e8b 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/project_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/project_service/transports/rest.py @@ -221,7 +221,7 @@ class ProjectServiceRestTransport(_BaseProjectServiceRestTransport): """REST backend synchronous transport for ProjectService. Service for operations on the - [Project][google.cloud.discoveryengine.v1beta.Project]. + `Project `__. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -505,7 +505,8 @@ def __call__( Args: request (~.project_service.ProvisionProjectRequest): The request object. Request for - [ProjectService.ProvisionProject][google.cloud.discoveryengine.v1beta.ProjectService.ProvisionProject] + `ProjectService.ProvisionProject + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/rank_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/rank_service/async_client.py index 2c45bd54afed..a30e7602586d 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/rank_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/rank_service/async_client.py @@ -327,7 +327,8 @@ async def sample_rank(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.RankRequest, dict]]): The request object. Request message for - [RankService.Rank][google.cloud.discoveryengine.v1beta.RankService.Rank] + `RankService.Rank + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -340,8 +341,9 @@ async def sample_rank(): Returns: google.cloud.discoveryengine_v1beta.types.RankResponse: Response message for - [RankService.Rank][google.cloud.discoveryengine.v1beta.RankService.Rank] - method. + `RankService.Rank + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/rank_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/rank_service/client.py index 86f4066b4ab4..aba29f91006c 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/rank_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/rank_service/client.py @@ -747,7 +747,8 @@ def sample_rank(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.RankRequest, dict]): The request object. Request message for - [RankService.Rank][google.cloud.discoveryengine.v1beta.RankService.Rank] + `RankService.Rank + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -760,8 +761,9 @@ def sample_rank(): Returns: google.cloud.discoveryengine_v1beta.types.RankResponse: Response message for - [RankService.Rank][google.cloud.discoveryengine.v1beta.RankService.Rank] - method. + `RankService.Rank + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/rank_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/rank_service/transports/rest.py index 6f230c8ce341..c79fc7405c07 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/rank_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/rank_service/transports/rest.py @@ -335,7 +335,8 @@ def __call__( Args: request (~.rank_service.RankRequest): The request object. Request message for - [RankService.Rank][google.cloud.discoveryengine.v1beta.RankService.Rank] + `RankService.Rank + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -348,7 +349,8 @@ def __call__( Returns: ~.rank_service.RankResponse: Response message for - [RankService.Rank][google.cloud.discoveryengine.v1beta.RankService.Rank] + `RankService.Rank + `__ method. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_service/async_client.py index 9b267d313d5c..bdfd349f3e92 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_service/async_client.py @@ -73,7 +73,8 @@ class SampleQueryServiceAsyncClient: """Service for managing - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s, + `SampleQuery + `__s, """ _client: SampleQueryServiceClient @@ -320,8 +321,8 @@ async def get_sample_query( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> sample_query.SampleQuery: - r"""Gets a - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]. + r"""Gets a `SampleQuery + `__. .. code-block:: python @@ -352,22 +353,27 @@ async def sample_get_sample_query(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.GetSampleQueryRequest, dict]]): The request object. Request message for - [SampleQueryService.GetSampleQuery][google.cloud.discoveryengine.v1beta.SampleQueryService.GetSampleQuery] + `SampleQueryService.GetSampleQuery + `__ method. name (:class:`str`): Required. Full resource name of - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], + `SampleQuery + `__, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}``. - If the caller does not have permission to access the - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `SampleQuery + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. If the requested - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] - does not exist, a NOT_FOUND error is returned. + `SampleQuery + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -447,7 +453,8 @@ async def list_sample_queries( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListSampleQueriesAsyncPager: r"""Gets a list of - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s. + `SampleQuery + `__s. .. code-block:: python @@ -479,18 +486,21 @@ async def sample_list_sample_queries(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.ListSampleQueriesRequest, dict]]): The request object. Request message for - [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ListSampleQueries] + `SampleQueryService.ListSampleQueries + `__ method. parent (:class:`str`): - Required. The parent sample query set resource name, - such as + Required. The parent sample query set + resource name, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}``. - If the caller does not have permission to list - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s - under this sample query set, regardless of whether or - not this sample query set exists, a - ``PERMISSION_DENIED`` error is returned. + If the caller does not have permission + to list `SampleQuery + `__s + under this sample query set, regardless + of whether or not this sample query set + exists, a ``PERMISSION_DENIED`` error is + returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -506,11 +516,13 @@ async def sample_list_sample_queries(): Returns: google.cloud.discoveryengine_v1beta.services.sample_query_service.pagers.ListSampleQueriesAsyncPager: Response message for - [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ListSampleQueries] - method. + `SampleQueryService.ListSampleQueries + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -586,8 +598,8 @@ async def create_sample_query( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_sample_query.SampleQuery: - r"""Creates a - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] + r"""Creates a `SampleQuery + `__ .. code-block:: python @@ -623,10 +635,12 @@ async def sample_create_sample_query(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.CreateSampleQueryRequest, dict]]): The request object. Request message for - [SampleQueryService.CreateSampleQuery][google.cloud.discoveryengine.v1beta.SampleQueryService.CreateSampleQuery] + `SampleQueryService.CreateSampleQuery + `__ method. parent (:class:`str`): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}``. This corresponds to the ``parent`` field @@ -634,7 +648,8 @@ async def sample_create_sample_query(): should not be set. sample_query (:class:`google.cloud.discoveryengine_v1beta.types.SampleQuery`): Required. The - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] + `SampleQuery + `__ to create. This corresponds to the ``sample_query`` field @@ -642,25 +657,34 @@ async def sample_create_sample_query(): should not be set. sample_query_id (:class:`str`): Required. The ID to use for the - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], - which will become the final component of the - [SampleQuery.name][google.cloud.discoveryengine.v1beta.SampleQuery.name]. - - If the caller does not have permission to create the - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + `SampleQuery + `__, + which will become the final component of + the + `SampleQuery.name + `__. + + If the caller does not have permission + to create the `SampleQuery + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. This field must be unique among all - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s + `SampleQuery + `__s with the same - [parent][google.cloud.discoveryengine.v1beta.CreateSampleQueryRequest.parent]. - Otherwise, an ``ALREADY_EXISTS`` error is returned. + `parent + `__. + Otherwise, an ``ALREADY_EXISTS`` error + is returned. - This field must conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. - Otherwise, an ``INVALID_ARGUMENT`` error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 + characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. This corresponds to the ``sample_query_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -744,8 +768,8 @@ async def update_sample_query( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_sample_query.SampleQuery: - r"""Updates a - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]. + r"""Updates a `SampleQuery + `__. .. code-block:: python @@ -779,21 +803,24 @@ async def sample_update_sample_query(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.UpdateSampleQueryRequest, dict]]): The request object. Request message for - [SampleQueryService.UpdateSampleQuery][google.cloud.discoveryengine.v1beta.SampleQueryService.UpdateSampleQuery] + `SampleQueryService.UpdateSampleQuery + `__ method. sample_query (:class:`google.cloud.discoveryengine_v1beta.types.SampleQuery`): Required. The simple query to update. - If the caller does not have permission to update the - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. - - If the - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] - to update does not exist a ``NOT_FOUND`` error is + If the caller does not have permission + to update the `SampleQuery + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is returned. + If the `SampleQuery + `__ + to update does not exist a ``NOT_FOUND`` + error is returned. + This corresponds to the ``sample_query`` field on the ``request`` instance; if ``request`` is provided, this should not be set. @@ -884,8 +911,8 @@ async def delete_sample_query( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> None: - r"""Deletes a - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]. + r"""Deletes a `SampleQuery + `__. .. code-block:: python @@ -913,24 +940,28 @@ async def sample_delete_sample_query(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.DeleteSampleQueryRequest, dict]]): The request object. Request message for - [SampleQueryService.DeleteSampleQuery][google.cloud.discoveryengine.v1beta.SampleQueryService.DeleteSampleQuery] + `SampleQueryService.DeleteSampleQuery + `__ method. name (:class:`str`): Required. Full resource name of - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], + `SampleQuery + `__, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}``. - If the caller does not have permission to delete the - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. - - If the - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] - to delete does not exist, a ``NOT_FOUND`` error is + If the caller does not have permission + to delete the `SampleQuery + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is returned. + If the `SampleQuery + `__ + to delete does not exist, a + ``NOT_FOUND`` error is returned. + This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this should not be set. @@ -997,12 +1028,14 @@ async def import_sample_queries( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: r"""Bulk import of multiple - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s. + `SampleQuery + `__s. Sample queries that already exist may be deleted. Note: It is possible for a subset of the - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s - to be successfully imported. + `SampleQuery + `__s to + be successfully imported. .. code-block:: python @@ -1041,7 +1074,8 @@ async def sample_import_sample_queries(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.ImportSampleQueriesRequest, dict]]): The request object. Request message for - [SampleQueryService.ImportSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ImportSampleQueries] + `SampleQueryService.ImportSampleQueries + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -1053,14 +1087,18 @@ async def sample_import_sample_queries(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.ImportSampleQueriesResponse` Response of the - [SampleQueryService.ImportSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ImportSampleQueries] - method. If the long running operation is done, this - message is returned by the - google.longrunning.Operations.response field if the - operation is successful. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.ImportSampleQueriesResponse` + Response of the + `SampleQueryService.ImportSampleQueries + `__ + method. If the long running operation is + done, this message is returned by the + google.longrunning.Operations.response + field if the operation is successful. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_service/client.py index 3ccc691336bb..a04b6dc528d5 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_service/client.py @@ -119,7 +119,8 @@ def get_transport_class( class SampleQueryServiceClient(metaclass=SampleQueryServiceClientMeta): """Service for managing - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s, + `SampleQuery + `__s, """ @staticmethod @@ -762,8 +763,8 @@ def get_sample_query( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> sample_query.SampleQuery: - r"""Gets a - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]. + r"""Gets a `SampleQuery + `__. .. code-block:: python @@ -794,22 +795,27 @@ def sample_get_sample_query(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.GetSampleQueryRequest, dict]): The request object. Request message for - [SampleQueryService.GetSampleQuery][google.cloud.discoveryengine.v1beta.SampleQueryService.GetSampleQuery] + `SampleQueryService.GetSampleQuery + `__ method. name (str): Required. Full resource name of - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], + `SampleQuery + `__, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}``. - If the caller does not have permission to access the - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `SampleQuery + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. If the requested - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] - does not exist, a NOT_FOUND error is returned. + `SampleQuery + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -886,7 +892,8 @@ def list_sample_queries( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListSampleQueriesPager: r"""Gets a list of - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s. + `SampleQuery + `__s. .. code-block:: python @@ -918,18 +925,21 @@ def sample_list_sample_queries(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.ListSampleQueriesRequest, dict]): The request object. Request message for - [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ListSampleQueries] + `SampleQueryService.ListSampleQueries + `__ method. parent (str): - Required. The parent sample query set resource name, - such as + Required. The parent sample query set + resource name, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}``. - If the caller does not have permission to list - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s - under this sample query set, regardless of whether or - not this sample query set exists, a - ``PERMISSION_DENIED`` error is returned. + If the caller does not have permission + to list `SampleQuery + `__s + under this sample query set, regardless + of whether or not this sample query set + exists, a ``PERMISSION_DENIED`` error is + returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -945,11 +955,13 @@ def sample_list_sample_queries(): Returns: google.cloud.discoveryengine_v1beta.services.sample_query_service.pagers.ListSampleQueriesPager: Response message for - [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ListSampleQueries] - method. + `SampleQueryService.ListSampleQueries + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -1022,8 +1034,8 @@ def create_sample_query( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_sample_query.SampleQuery: - r"""Creates a - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] + r"""Creates a `SampleQuery + `__ .. code-block:: python @@ -1059,10 +1071,12 @@ def sample_create_sample_query(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.CreateSampleQueryRequest, dict]): The request object. Request message for - [SampleQueryService.CreateSampleQuery][google.cloud.discoveryengine.v1beta.SampleQueryService.CreateSampleQuery] + `SampleQueryService.CreateSampleQuery + `__ method. parent (str): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}``. This corresponds to the ``parent`` field @@ -1070,7 +1084,8 @@ def sample_create_sample_query(): should not be set. sample_query (google.cloud.discoveryengine_v1beta.types.SampleQuery): Required. The - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] + `SampleQuery + `__ to create. This corresponds to the ``sample_query`` field @@ -1078,25 +1093,34 @@ def sample_create_sample_query(): should not be set. sample_query_id (str): Required. The ID to use for the - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], - which will become the final component of the - [SampleQuery.name][google.cloud.discoveryengine.v1beta.SampleQuery.name]. - - If the caller does not have permission to create the - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + `SampleQuery + `__, + which will become the final component of + the + `SampleQuery.name + `__. + + If the caller does not have permission + to create the `SampleQuery + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. This field must be unique among all - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s + `SampleQuery + `__s with the same - [parent][google.cloud.discoveryengine.v1beta.CreateSampleQueryRequest.parent]. - Otherwise, an ``ALREADY_EXISTS`` error is returned. + `parent + `__. + Otherwise, an ``ALREADY_EXISTS`` error + is returned. - This field must conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. - Otherwise, an ``INVALID_ARGUMENT`` error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 + characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. This corresponds to the ``sample_query_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -1177,8 +1201,8 @@ def update_sample_query( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_sample_query.SampleQuery: - r"""Updates a - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]. + r"""Updates a `SampleQuery + `__. .. code-block:: python @@ -1212,21 +1236,24 @@ def sample_update_sample_query(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.UpdateSampleQueryRequest, dict]): The request object. Request message for - [SampleQueryService.UpdateSampleQuery][google.cloud.discoveryengine.v1beta.SampleQueryService.UpdateSampleQuery] + `SampleQueryService.UpdateSampleQuery + `__ method. sample_query (google.cloud.discoveryengine_v1beta.types.SampleQuery): Required. The simple query to update. - If the caller does not have permission to update the - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. - - If the - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] - to update does not exist a ``NOT_FOUND`` error is + If the caller does not have permission + to update the `SampleQuery + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is returned. + If the `SampleQuery + `__ + to update does not exist a ``NOT_FOUND`` + error is returned. + This corresponds to the ``sample_query`` field on the ``request`` instance; if ``request`` is provided, this should not be set. @@ -1314,8 +1341,8 @@ def delete_sample_query( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> None: - r"""Deletes a - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]. + r"""Deletes a `SampleQuery + `__. .. code-block:: python @@ -1343,24 +1370,28 @@ def sample_delete_sample_query(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.DeleteSampleQueryRequest, dict]): The request object. Request message for - [SampleQueryService.DeleteSampleQuery][google.cloud.discoveryengine.v1beta.SampleQueryService.DeleteSampleQuery] + `SampleQueryService.DeleteSampleQuery + `__ method. name (str): Required. Full resource name of - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], + `SampleQuery + `__, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}``. - If the caller does not have permission to delete the - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. - - If the - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] - to delete does not exist, a ``NOT_FOUND`` error is + If the caller does not have permission + to delete the `SampleQuery + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is returned. + If the `SampleQuery + `__ + to delete does not exist, a + ``NOT_FOUND`` error is returned. + This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this should not be set. @@ -1424,12 +1455,14 @@ def import_sample_queries( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: r"""Bulk import of multiple - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s. + `SampleQuery + `__s. Sample queries that already exist may be deleted. Note: It is possible for a subset of the - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s - to be successfully imported. + `SampleQuery + `__s to + be successfully imported. .. code-block:: python @@ -1468,7 +1501,8 @@ def sample_import_sample_queries(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.ImportSampleQueriesRequest, dict]): The request object. Request message for - [SampleQueryService.ImportSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ImportSampleQueries] + `SampleQueryService.ImportSampleQueries + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1480,14 +1514,18 @@ def sample_import_sample_queries(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.ImportSampleQueriesResponse` Response of the - [SampleQueryService.ImportSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ImportSampleQueries] - method. If the long running operation is done, this - message is returned by the - google.longrunning.Operations.response field if the - operation is successful. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.ImportSampleQueriesResponse` + Response of the + `SampleQueryService.ImportSampleQueries + `__ + method. If the long running operation is + done, this message is returned by the + google.longrunning.Operations.response + field if the operation is successful. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_service/transports/grpc.py index 6fe3b9e28646..514712b68c94 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_service/transports/grpc.py @@ -117,7 +117,8 @@ class SampleQueryServiceGrpcTransport(SampleQueryServiceTransport): """gRPC backend transport for SampleQueryService. Service for managing - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s, + `SampleQuery + `__s, This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -353,8 +354,8 @@ def get_sample_query( ]: r"""Return a callable for the get sample query method over gRPC. - Gets a - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]. + Gets a `SampleQuery + `__. Returns: Callable[[~.GetSampleQueryRequest], @@ -384,7 +385,8 @@ def list_sample_queries( r"""Return a callable for the list sample queries method over gRPC. Gets a list of - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s. + `SampleQuery + `__s. Returns: Callable[[~.ListSampleQueriesRequest], @@ -412,8 +414,8 @@ def create_sample_query( ]: r"""Return a callable for the create sample query method over gRPC. - Creates a - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] + Creates a `SampleQuery + `__ Returns: Callable[[~.CreateSampleQueryRequest], @@ -441,8 +443,8 @@ def update_sample_query( ]: r"""Return a callable for the update sample query method over gRPC. - Updates a - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]. + Updates a `SampleQuery + `__. Returns: Callable[[~.UpdateSampleQueryRequest], @@ -468,8 +470,8 @@ def delete_sample_query( ) -> Callable[[sample_query_service.DeleteSampleQueryRequest], empty_pb2.Empty]: r"""Return a callable for the delete sample query method over gRPC. - Deletes a - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]. + Deletes a `SampleQuery + `__. Returns: Callable[[~.DeleteSampleQueryRequest], @@ -496,12 +498,14 @@ def import_sample_queries( r"""Return a callable for the import sample queries method over gRPC. Bulk import of multiple - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s. + `SampleQuery + `__s. Sample queries that already exist may be deleted. Note: It is possible for a subset of the - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s - to be successfully imported. + `SampleQuery + `__s to + be successfully imported. Returns: Callable[[~.ImportSampleQueriesRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_service/transports/grpc_asyncio.py index b1f8d05cbb30..f16056a29beb 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_service/transports/grpc_asyncio.py @@ -123,7 +123,8 @@ class SampleQueryServiceGrpcAsyncIOTransport(SampleQueryServiceTransport): """gRPC AsyncIO backend transport for SampleQueryService. Service for managing - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s, + `SampleQuery + `__s, This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -362,8 +363,8 @@ def get_sample_query( ]: r"""Return a callable for the get sample query method over gRPC. - Gets a - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]. + Gets a `SampleQuery + `__. Returns: Callable[[~.GetSampleQueryRequest], @@ -393,7 +394,8 @@ def list_sample_queries( r"""Return a callable for the list sample queries method over gRPC. Gets a list of - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s. + `SampleQuery + `__s. Returns: Callable[[~.ListSampleQueriesRequest], @@ -422,8 +424,8 @@ def create_sample_query( ]: r"""Return a callable for the create sample query method over gRPC. - Creates a - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] + Creates a `SampleQuery + `__ Returns: Callable[[~.CreateSampleQueryRequest], @@ -452,8 +454,8 @@ def update_sample_query( ]: r"""Return a callable for the update sample query method over gRPC. - Updates a - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]. + Updates a `SampleQuery + `__. Returns: Callable[[~.UpdateSampleQueryRequest], @@ -481,8 +483,8 @@ def delete_sample_query( ]: r"""Return a callable for the delete sample query method over gRPC. - Deletes a - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]. + Deletes a `SampleQuery + `__. Returns: Callable[[~.DeleteSampleQueryRequest], @@ -511,12 +513,14 @@ def import_sample_queries( r"""Return a callable for the import sample queries method over gRPC. Bulk import of multiple - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s. + `SampleQuery + `__s. Sample queries that already exist may be deleted. Note: It is possible for a subset of the - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s - to be successfully imported. + `SampleQuery + `__s to + be successfully imported. Returns: Callable[[~.ImportSampleQueriesRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_service/transports/rest.py index ef6fbf5ee1f0..054b055c278e 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_service/transports/rest.py @@ -476,7 +476,8 @@ class SampleQueryServiceRestTransport(_BaseSampleQueryServiceRestTransport): """REST backend synchronous transport for SampleQueryService. Service for managing - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s, + `SampleQuery + `__s, This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -761,7 +762,8 @@ def __call__( Args: request (~.sample_query_service.CreateSampleQueryRequest): The request object. Request message for - [SampleQueryService.CreateSampleQuery][google.cloud.discoveryengine.v1beta.SampleQueryService.CreateSampleQuery] + `SampleQueryService.CreateSampleQuery + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -917,7 +919,8 @@ def __call__( Args: request (~.sample_query_service.DeleteSampleQueryRequest): The request object. Request message for - [SampleQueryService.DeleteSampleQuery][google.cloud.discoveryengine.v1beta.SampleQueryService.DeleteSampleQuery] + `SampleQueryService.DeleteSampleQuery + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1028,7 +1031,8 @@ def __call__( Args: request (~.sample_query_service.GetSampleQueryRequest): The request object. Request message for - [SampleQueryService.GetSampleQuery][google.cloud.discoveryengine.v1beta.SampleQueryService.GetSampleQuery] + `SampleQueryService.GetSampleQuery + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1180,7 +1184,8 @@ def __call__( Args: request (~.import_config.ImportSampleQueriesRequest): The request object. Request message for - [SampleQueryService.ImportSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ImportSampleQueries] + `SampleQueryService.ImportSampleQueries + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1337,7 +1342,8 @@ def __call__( Args: request (~.sample_query_service.ListSampleQueriesRequest): The request object. Request message for - [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ListSampleQueries] + `SampleQueryService.ListSampleQueries + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1350,7 +1356,8 @@ def __call__( Returns: ~.sample_query_service.ListSampleQueriesResponse: Response message for - [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ListSampleQueries] + `SampleQueryService.ListSampleQueries + `__ method. """ @@ -1492,7 +1499,8 @@ def __call__( Args: request (~.sample_query_service.UpdateSampleQueryRequest): The request object. Request message for - [SampleQueryService.UpdateSampleQuery][google.cloud.discoveryengine.v1beta.SampleQueryService.UpdateSampleQuery] + `SampleQueryService.UpdateSampleQuery + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_set_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_set_service/async_client.py index f7068c5d8516..579a9f8037bb 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_set_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_set_service/async_client.py @@ -72,7 +72,8 @@ class SampleQuerySetServiceAsyncClient: """Service for managing - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s, + `SampleQuerySet + `__s, """ _client: SampleQuerySetServiceClient @@ -322,7 +323,8 @@ async def get_sample_query_set( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> sample_query_set.SampleQuerySet: r"""Gets a - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]. + `SampleQuerySet + `__. .. code-block:: python @@ -353,22 +355,27 @@ async def sample_get_sample_query_set(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.GetSampleQuerySetRequest, dict]]): The request object. Request message for - [SampleQuerySetService.GetSampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySetService.GetSampleQuerySet] + `SampleQuerySetService.GetSampleQuerySet + `__ method. name (:class:`str`): Required. Full resource name of - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], + `SampleQuerySet + `__, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}``. - If the caller does not have permission to access the - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `SampleQuerySet + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. If the requested - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] - does not exist, a NOT_FOUND error is returned. + `SampleQuerySet + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -450,7 +457,8 @@ async def list_sample_query_sets( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListSampleQuerySetsAsyncPager: r"""Gets a list of - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s. + `SampleQuerySet + `__s. .. code-block:: python @@ -482,17 +490,20 @@ async def sample_list_sample_query_sets(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.ListSampleQuerySetsRequest, dict]]): The request object. Request message for - [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1beta.SampleQuerySetService.ListSampleQuerySets] + `SampleQuerySetService.ListSampleQuerySets + `__ method. parent (:class:`str`): - Required. The parent location resource name, such as + Required. The parent location resource + name, such as ``projects/{project}/locations/{location}``. - If the caller does not have permission to list - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s - under this location, regardless of whether or not this - location exists, a ``PERMISSION_DENIED`` error is - returned. + If the caller does not have permission + to list `SampleQuerySet + `__s + under this location, regardless of + whether or not this location exists, a + ``PERMISSION_DENIED`` error is returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -508,11 +519,13 @@ async def sample_list_sample_query_sets(): Returns: google.cloud.discoveryengine_v1beta.services.sample_query_set_service.pagers.ListSampleQuerySetsAsyncPager: Response message for - [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1beta.SampleQuerySetService.ListSampleQuerySets] - method. + `SampleQuerySetService.ListSampleQuerySets + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -589,7 +602,8 @@ async def create_sample_query_set( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_sample_query_set.SampleQuerySet: r"""Creates a - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] + `SampleQuerySet + `__ .. code-block:: python @@ -625,10 +639,12 @@ async def sample_create_sample_query_set(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.CreateSampleQuerySetRequest, dict]]): The request object. Request message for - [SampleQuerySetService.CreateSampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySetService.CreateSampleQuerySet] + `SampleQuerySetService.CreateSampleQuerySet + `__ method. parent (:class:`str`): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}``. This corresponds to the ``parent`` field @@ -636,7 +652,8 @@ async def sample_create_sample_query_set(): should not be set. sample_query_set (:class:`google.cloud.discoveryengine_v1beta.types.SampleQuerySet`): Required. The - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] + `SampleQuerySet + `__ to create. This corresponds to the ``sample_query_set`` field @@ -644,25 +661,34 @@ async def sample_create_sample_query_set(): should not be set. sample_query_set_id (:class:`str`): Required. The ID to use for the - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], - which will become the final component of the - [SampleQuerySet.name][google.cloud.discoveryengine.v1beta.SampleQuerySet.name]. - - If the caller does not have permission to create the - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + `SampleQuerySet + `__, + which will become the final component of + the + `SampleQuerySet.name + `__. + + If the caller does not have permission + to create the `SampleQuerySet + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. This field must be unique among all - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s + `SampleQuerySet + `__s with the same - [parent][google.cloud.discoveryengine.v1beta.CreateSampleQuerySetRequest.parent]. - Otherwise, an ``ALREADY_EXISTS`` error is returned. + `parent + `__. + Otherwise, an ``ALREADY_EXISTS`` error + is returned. - This field must conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. - Otherwise, an ``INVALID_ARGUMENT`` error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 + characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. This corresponds to the ``sample_query_set_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -751,7 +777,8 @@ async def update_sample_query_set( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_sample_query_set.SampleQuerySet: r"""Updates a - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]. + `SampleQuerySet + `__. .. code-block:: python @@ -785,21 +812,24 @@ async def sample_update_sample_query_set(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.UpdateSampleQuerySetRequest, dict]]): The request object. Request message for - [SampleQuerySetService.UpdateSampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySetService.UpdateSampleQuerySet] + `SampleQuerySetService.UpdateSampleQuerySet + `__ method. sample_query_set (:class:`google.cloud.discoveryengine_v1beta.types.SampleQuerySet`): - Required. The sample query set to update. - - If the caller does not have permission to update the - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. - - If the - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] - to update does not exist a ``NOT_FOUND`` error is + Required. The sample query set to + update. + If the caller does not have permission + to update the `SampleQuerySet + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is returned. + If the `SampleQuerySet + `__ + to update does not exist a ``NOT_FOUND`` + error is returned. + This corresponds to the ``sample_query_set`` field on the ``request`` instance; if ``request`` is provided, this should not be set. @@ -895,7 +925,8 @@ async def delete_sample_query_set( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> None: r"""Deletes a - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]. + `SampleQuerySet + `__. .. code-block:: python @@ -923,24 +954,28 @@ async def sample_delete_sample_query_set(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.DeleteSampleQuerySetRequest, dict]]): The request object. Request message for - [SampleQuerySetService.DeleteSampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySetService.DeleteSampleQuerySet] + `SampleQuerySetService.DeleteSampleQuerySet + `__ method. name (:class:`str`): Required. Full resource name of - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], + `SampleQuerySet + `__, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}``. - If the caller does not have permission to delete the - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. - - If the - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] - to delete does not exist, a ``NOT_FOUND`` error is + If the caller does not have permission + to delete the `SampleQuerySet + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is returned. + If the `SampleQuerySet + `__ + to delete does not exist, a + ``NOT_FOUND`` error is returned. + This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this should not be set. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_set_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_set_service/client.py index 436506bd265a..64e6b61a67ac 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_set_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_set_service/client.py @@ -118,7 +118,8 @@ def get_transport_class( class SampleQuerySetServiceClient(metaclass=SampleQuerySetServiceClientMeta): """Service for managing - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s, + `SampleQuerySet + `__s, """ @staticmethod @@ -757,7 +758,8 @@ def get_sample_query_set( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> sample_query_set.SampleQuerySet: r"""Gets a - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]. + `SampleQuerySet + `__. .. code-block:: python @@ -788,22 +790,27 @@ def sample_get_sample_query_set(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.GetSampleQuerySetRequest, dict]): The request object. Request message for - [SampleQuerySetService.GetSampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySetService.GetSampleQuerySet] + `SampleQuerySetService.GetSampleQuerySet + `__ method. name (str): Required. Full resource name of - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], + `SampleQuerySet + `__, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}``. - If the caller does not have permission to access the - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `SampleQuerySet + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. If the requested - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] - does not exist, a NOT_FOUND error is returned. + `SampleQuerySet + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -882,7 +889,8 @@ def list_sample_query_sets( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListSampleQuerySetsPager: r"""Gets a list of - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s. + `SampleQuerySet + `__s. .. code-block:: python @@ -914,17 +922,20 @@ def sample_list_sample_query_sets(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.ListSampleQuerySetsRequest, dict]): The request object. Request message for - [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1beta.SampleQuerySetService.ListSampleQuerySets] + `SampleQuerySetService.ListSampleQuerySets + `__ method. parent (str): - Required. The parent location resource name, such as + Required. The parent location resource + name, such as ``projects/{project}/locations/{location}``. - If the caller does not have permission to list - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s - under this location, regardless of whether or not this - location exists, a ``PERMISSION_DENIED`` error is - returned. + If the caller does not have permission + to list `SampleQuerySet + `__s + under this location, regardless of + whether or not this location exists, a + ``PERMISSION_DENIED`` error is returned. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -940,11 +951,13 @@ def sample_list_sample_query_sets(): Returns: google.cloud.discoveryengine_v1beta.services.sample_query_set_service.pagers.ListSampleQuerySetsPager: Response message for - [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1beta.SampleQuerySetService.ListSampleQuerySets] - method. + `SampleQuerySetService.ListSampleQuerySets + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -1018,7 +1031,8 @@ def create_sample_query_set( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_sample_query_set.SampleQuerySet: r"""Creates a - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] + `SampleQuerySet + `__ .. code-block:: python @@ -1054,10 +1068,12 @@ def sample_create_sample_query_set(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.CreateSampleQuerySetRequest, dict]): The request object. Request message for - [SampleQuerySetService.CreateSampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySetService.CreateSampleQuerySet] + `SampleQuerySetService.CreateSampleQuerySet + `__ method. parent (str): - Required. The parent resource name, such as + Required. The parent resource name, such + as ``projects/{project}/locations/{location}``. This corresponds to the ``parent`` field @@ -1065,7 +1081,8 @@ def sample_create_sample_query_set(): should not be set. sample_query_set (google.cloud.discoveryengine_v1beta.types.SampleQuerySet): Required. The - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] + `SampleQuerySet + `__ to create. This corresponds to the ``sample_query_set`` field @@ -1073,25 +1090,34 @@ def sample_create_sample_query_set(): should not be set. sample_query_set_id (str): Required. The ID to use for the - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], - which will become the final component of the - [SampleQuerySet.name][google.cloud.discoveryengine.v1beta.SampleQuerySet.name]. - - If the caller does not have permission to create the - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. + `SampleQuerySet + `__, + which will become the final component of + the + `SampleQuerySet.name + `__. + + If the caller does not have permission + to create the `SampleQuerySet + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is + returned. This field must be unique among all - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s + `SampleQuerySet + `__s with the same - [parent][google.cloud.discoveryengine.v1beta.CreateSampleQuerySetRequest.parent]. - Otherwise, an ``ALREADY_EXISTS`` error is returned. + `parent + `__. + Otherwise, an ``ALREADY_EXISTS`` error + is returned. - This field must conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. - Otherwise, an ``INVALID_ARGUMENT`` error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 + characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. This corresponds to the ``sample_query_set_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -1177,7 +1203,8 @@ def update_sample_query_set( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> gcd_sample_query_set.SampleQuerySet: r"""Updates a - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]. + `SampleQuerySet + `__. .. code-block:: python @@ -1211,21 +1238,24 @@ def sample_update_sample_query_set(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.UpdateSampleQuerySetRequest, dict]): The request object. Request message for - [SampleQuerySetService.UpdateSampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySetService.UpdateSampleQuerySet] + `SampleQuerySetService.UpdateSampleQuerySet + `__ method. sample_query_set (google.cloud.discoveryengine_v1beta.types.SampleQuerySet): - Required. The sample query set to update. - - If the caller does not have permission to update the - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. - - If the - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] - to update does not exist a ``NOT_FOUND`` error is + Required. The sample query set to + update. + If the caller does not have permission + to update the `SampleQuerySet + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is returned. + If the `SampleQuerySet + `__ + to update does not exist a ``NOT_FOUND`` + error is returned. + This corresponds to the ``sample_query_set`` field on the ``request`` instance; if ``request`` is provided, this should not be set. @@ -1318,7 +1348,8 @@ def delete_sample_query_set( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> None: r"""Deletes a - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]. + `SampleQuerySet + `__. .. code-block:: python @@ -1346,24 +1377,28 @@ def sample_delete_sample_query_set(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.DeleteSampleQuerySetRequest, dict]): The request object. Request message for - [SampleQuerySetService.DeleteSampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySetService.DeleteSampleQuerySet] + `SampleQuerySetService.DeleteSampleQuerySet + `__ method. name (str): Required. Full resource name of - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], + `SampleQuerySet + `__, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}``. - If the caller does not have permission to delete the - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], - regardless of whether or not it exists, a - ``PERMISSION_DENIED`` error is returned. - - If the - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] - to delete does not exist, a ``NOT_FOUND`` error is + If the caller does not have permission + to delete the `SampleQuerySet + `__, + regardless of whether or not it exists, + a ``PERMISSION_DENIED`` error is returned. + If the `SampleQuerySet + `__ + to delete does not exist, a + ``NOT_FOUND`` error is returned. + This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this should not be set. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_set_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_set_service/transports/grpc.py index 2040ee5d6e13..382b9d35f50c 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_set_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_set_service/transports/grpc.py @@ -118,7 +118,8 @@ class SampleQuerySetServiceGrpcTransport(SampleQuerySetServiceTransport): """gRPC backend transport for SampleQuerySetService. Service for managing - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s, + `SampleQuerySet + `__s, This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -339,7 +340,8 @@ def get_sample_query_set( r"""Return a callable for the get sample query set method over gRPC. Gets a - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]. + `SampleQuerySet + `__. Returns: Callable[[~.GetSampleQuerySetRequest], @@ -369,7 +371,8 @@ def list_sample_query_sets( r"""Return a callable for the list sample query sets method over gRPC. Gets a list of - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s. + `SampleQuerySet + `__s. Returns: Callable[[~.ListSampleQuerySetsRequest], @@ -399,7 +402,8 @@ def create_sample_query_set( r"""Return a callable for the create sample query set method over gRPC. Creates a - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] + `SampleQuerySet + `__ Returns: Callable[[~.CreateSampleQuerySetRequest], @@ -429,7 +433,8 @@ def update_sample_query_set( r"""Return a callable for the update sample query set method over gRPC. Updates a - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]. + `SampleQuerySet + `__. Returns: Callable[[~.UpdateSampleQuerySetRequest], @@ -458,7 +463,8 @@ def delete_sample_query_set( r"""Return a callable for the delete sample query set method over gRPC. Deletes a - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]. + `SampleQuerySet + `__. Returns: Callable[[~.DeleteSampleQuerySetRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_set_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_set_service/transports/grpc_asyncio.py index 8c4096140d25..aef3e5831c42 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_set_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_set_service/transports/grpc_asyncio.py @@ -124,7 +124,8 @@ class SampleQuerySetServiceGrpcAsyncIOTransport(SampleQuerySetServiceTransport): """gRPC AsyncIO backend transport for SampleQuerySetService. Service for managing - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s, + `SampleQuerySet + `__s, This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -347,7 +348,8 @@ def get_sample_query_set( r"""Return a callable for the get sample query set method over gRPC. Gets a - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]. + `SampleQuerySet + `__. Returns: Callable[[~.GetSampleQuerySetRequest], @@ -377,7 +379,8 @@ def list_sample_query_sets( r"""Return a callable for the list sample query sets method over gRPC. Gets a list of - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s. + `SampleQuerySet + `__s. Returns: Callable[[~.ListSampleQuerySetsRequest], @@ -407,7 +410,8 @@ def create_sample_query_set( r"""Return a callable for the create sample query set method over gRPC. Creates a - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] + `SampleQuerySet + `__ Returns: Callable[[~.CreateSampleQuerySetRequest], @@ -437,7 +441,8 @@ def update_sample_query_set( r"""Return a callable for the update sample query set method over gRPC. Updates a - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]. + `SampleQuerySet + `__. Returns: Callable[[~.UpdateSampleQuerySetRequest], @@ -467,7 +472,8 @@ def delete_sample_query_set( r"""Return a callable for the delete sample query set method over gRPC. Deletes a - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]. + `SampleQuerySet + `__. Returns: Callable[[~.DeleteSampleQuerySetRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_set_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_set_service/transports/rest.py index 070b534d65a6..3d9f28ea2244 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_set_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/sample_query_set_service/transports/rest.py @@ -426,7 +426,8 @@ class SampleQuerySetServiceRestTransport(_BaseSampleQuerySetServiceRestTransport """REST backend synchronous transport for SampleQuerySetService. Service for managing - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s, + `SampleQuerySet + `__s, This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -546,7 +547,8 @@ def __call__( Args: request (~.sample_query_set_service.CreateSampleQuerySetRequest): The request object. Request message for - [SampleQuerySetService.CreateSampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySetService.CreateSampleQuerySet] + `SampleQuerySetService.CreateSampleQuerySet + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -708,7 +710,8 @@ def __call__( Args: request (~.sample_query_set_service.DeleteSampleQuerySetRequest): The request object. Request message for - [SampleQuerySetService.DeleteSampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySetService.DeleteSampleQuerySet] + `SampleQuerySetService.DeleteSampleQuerySet + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -821,7 +824,8 @@ def __call__( Args: request (~.sample_query_set_service.GetSampleQuerySetRequest): The request object. Request message for - [SampleQuerySetService.GetSampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySetService.GetSampleQuerySet] + `SampleQuerySetService.GetSampleQuerySet + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -976,7 +980,8 @@ def __call__( Args: request (~.sample_query_set_service.ListSampleQuerySetsRequest): The request object. Request message for - [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1beta.SampleQuerySetService.ListSampleQuerySets] + `SampleQuerySetService.ListSampleQuerySets + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -989,7 +994,8 @@ def __call__( Returns: ~.sample_query_set_service.ListSampleQuerySetsResponse: Response message for - [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1beta.SampleQuerySetService.ListSampleQuerySets] + `SampleQuerySetService.ListSampleQuerySets + `__ method. """ @@ -1135,7 +1141,8 @@ def __call__( Args: request (~.sample_query_set_service.UpdateSampleQuerySetRequest): The request object. Request message for - [SampleQuerySetService.UpdateSampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySetService.UpdateSampleQuerySet] + `SampleQuerySetService.UpdateSampleQuerySet + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/schema_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/schema_service/async_client.py index 5b52e5dfa060..490af9ade21a 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/schema_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/schema_service/async_client.py @@ -71,8 +71,8 @@ class SchemaServiceAsyncClient: - """Service for managing - [Schema][google.cloud.discoveryengine.v1beta.Schema]s. + """Service for managing `Schema + `__s. """ _client: SchemaServiceClient @@ -309,7 +309,8 @@ async def get_schema( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> schema.Schema: - r"""Gets a [Schema][google.cloud.discoveryengine.v1beta.Schema]. + r"""Gets a `Schema + `__. .. code-block:: python @@ -340,11 +341,12 @@ async def sample_get_schema(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.GetSchemaRequest, dict]]): The request object. Request message for - [SchemaService.GetSchema][google.cloud.discoveryengine.v1beta.SchemaService.GetSchema] + `SchemaService.GetSchema + `__ method. name (:class:`str`): - Required. The full resource name of the schema, in the - format of + Required. The full resource name of the + schema, in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}``. This corresponds to the ``name`` field @@ -422,8 +424,8 @@ async def list_schemas( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListSchemasAsyncPager: - r"""Gets a list of - [Schema][google.cloud.discoveryengine.v1beta.Schema]s. + r"""Gets a list of `Schema + `__s. .. code-block:: python @@ -455,11 +457,12 @@ async def sample_list_schemas(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.ListSchemasRequest, dict]]): The request object. Request message for - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas] + `SchemaService.ListSchemas + `__ method. parent (:class:`str`): - Required. The parent data store resource name, in the - format of + Required. The parent data store resource + name, in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}``. This corresponds to the ``parent`` field @@ -476,11 +479,13 @@ async def sample_list_schemas(): Returns: google.cloud.discoveryengine_v1beta.services.schema_service.pagers.ListSchemasAsyncPager: Response message for - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas] - method. + `SchemaService.ListSchemas + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -554,7 +559,8 @@ async def create_schema( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Creates a [Schema][google.cloud.discoveryengine.v1beta.Schema]. + r"""Creates a `Schema + `__. .. code-block:: python @@ -590,33 +596,38 @@ async def sample_create_schema(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.CreateSchemaRequest, dict]]): The request object. Request message for - [SchemaService.CreateSchema][google.cloud.discoveryengine.v1beta.SchemaService.CreateSchema] + `SchemaService.CreateSchema + `__ method. parent (:class:`str`): - Required. The parent data store resource name, in the - format of + Required. The parent data store resource + name, in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. schema (:class:`google.cloud.discoveryengine_v1beta.types.Schema`): - Required. The - [Schema][google.cloud.discoveryengine.v1beta.Schema] to - create. + Required. The `Schema + `__ + to create. This corresponds to the ``schema`` field on the ``request`` instance; if ``request`` is provided, this should not be set. schema_id (:class:`str`): Required. The ID to use for the - [Schema][google.cloud.discoveryengine.v1beta.Schema], + `Schema + `__, which becomes the final component of the - [Schema.name][google.cloud.discoveryengine.v1beta.Schema.name]. + `Schema.name + `__. This field should conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. + `RFC-1034 + `__ + standard with a length limit of 63 + characters. This corresponds to the ``schema_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -631,12 +642,13 @@ async def sample_create_schema(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1beta.types.Schema` - Defines the structure and layout of a type of document - data. + Defines the structure and layout of a + type of document data. """ # Create or coerce a protobuf request object. @@ -708,7 +720,8 @@ async def update_schema( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Updates a [Schema][google.cloud.discoveryengine.v1beta.Schema]. + r"""Updates a `Schema + `__. .. code-block:: python @@ -742,7 +755,8 @@ async def sample_update_schema(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.UpdateSchemaRequest, dict]]): The request object. Request message for - [SchemaService.UpdateSchema][google.cloud.discoveryengine.v1beta.SchemaService.UpdateSchema] + `SchemaService.UpdateSchema + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -754,12 +768,13 @@ async def sample_update_schema(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1beta.types.Schema` - Defines the structure and layout of a type of document - data. + Defines the structure and layout of a + type of document data. """ # Create or coerce a protobuf request object. @@ -813,7 +828,8 @@ async def delete_schema( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Deletes a [Schema][google.cloud.discoveryengine.v1beta.Schema]. + r"""Deletes a `Schema + `__. .. code-block:: python @@ -848,11 +864,12 @@ async def sample_delete_schema(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.DeleteSchemaRequest, dict]]): The request object. Request message for - [SchemaService.DeleteSchema][google.cloud.discoveryengine.v1beta.SchemaService.DeleteSchema] + `SchemaService.DeleteSchema + `__ method. name (:class:`str`): - Required. The full resource name of the schema, in the - format of + Required. The full resource name of the + schema, in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}``. This corresponds to the ``name`` field @@ -868,18 +885,21 @@ async def sample_delete_schema(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/schema_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/schema_service/client.py index 16b56a1408b1..08b62269cd49 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/schema_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/schema_service/client.py @@ -115,8 +115,8 @@ def get_transport_class( class SchemaServiceClient(metaclass=SchemaServiceClientMeta): - """Service for managing - [Schema][google.cloud.discoveryengine.v1beta.Schema]s. + """Service for managing `Schema + `__s. """ @staticmethod @@ -752,7 +752,8 @@ def get_schema( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> schema.Schema: - r"""Gets a [Schema][google.cloud.discoveryengine.v1beta.Schema]. + r"""Gets a `Schema + `__. .. code-block:: python @@ -783,11 +784,12 @@ def sample_get_schema(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.GetSchemaRequest, dict]): The request object. Request message for - [SchemaService.GetSchema][google.cloud.discoveryengine.v1beta.SchemaService.GetSchema] + `SchemaService.GetSchema + `__ method. name (str): - Required. The full resource name of the schema, in the - format of + Required. The full resource name of the + schema, in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}``. This corresponds to the ``name`` field @@ -862,8 +864,8 @@ def list_schemas( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListSchemasPager: - r"""Gets a list of - [Schema][google.cloud.discoveryengine.v1beta.Schema]s. + r"""Gets a list of `Schema + `__s. .. code-block:: python @@ -895,11 +897,12 @@ def sample_list_schemas(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.ListSchemasRequest, dict]): The request object. Request message for - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas] + `SchemaService.ListSchemas + `__ method. parent (str): - Required. The parent data store resource name, in the - format of + Required. The parent data store resource + name, in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}``. This corresponds to the ``parent`` field @@ -916,11 +919,13 @@ def sample_list_schemas(): Returns: google.cloud.discoveryengine_v1beta.services.schema_service.pagers.ListSchemasPager: Response message for - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas] - method. + `SchemaService.ListSchemas + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -991,7 +996,8 @@ def create_schema( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Creates a [Schema][google.cloud.discoveryengine.v1beta.Schema]. + r"""Creates a `Schema + `__. .. code-block:: python @@ -1027,33 +1033,38 @@ def sample_create_schema(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.CreateSchemaRequest, dict]): The request object. Request message for - [SchemaService.CreateSchema][google.cloud.discoveryengine.v1beta.SchemaService.CreateSchema] + `SchemaService.CreateSchema + `__ method. parent (str): - Required. The parent data store resource name, in the - format of + Required. The parent data store resource + name, in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. schema (google.cloud.discoveryengine_v1beta.types.Schema): - Required. The - [Schema][google.cloud.discoveryengine.v1beta.Schema] to - create. + Required. The `Schema + `__ + to create. This corresponds to the ``schema`` field on the ``request`` instance; if ``request`` is provided, this should not be set. schema_id (str): Required. The ID to use for the - [Schema][google.cloud.discoveryengine.v1beta.Schema], + `Schema + `__, which becomes the final component of the - [Schema.name][google.cloud.discoveryengine.v1beta.Schema.name]. + `Schema.name + `__. This field should conform to - `RFC-1034 `__ - standard with a length limit of 63 characters. + `RFC-1034 + `__ + standard with a length limit of 63 + characters. This corresponds to the ``schema_id`` field on the ``request`` instance; if ``request`` is provided, this @@ -1068,12 +1079,13 @@ def sample_create_schema(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1beta.types.Schema` - Defines the structure and layout of a type of document - data. + Defines the structure and layout of a + type of document data. """ # Create or coerce a protobuf request object. @@ -1142,7 +1154,8 @@ def update_schema( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Updates a [Schema][google.cloud.discoveryengine.v1beta.Schema]. + r"""Updates a `Schema + `__. .. code-block:: python @@ -1176,7 +1189,8 @@ def sample_update_schema(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.UpdateSchemaRequest, dict]): The request object. Request message for - [SchemaService.UpdateSchema][google.cloud.discoveryengine.v1beta.SchemaService.UpdateSchema] + `SchemaService.UpdateSchema + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1188,12 +1202,13 @@ def sample_update_schema(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1beta.types.Schema` - Defines the structure and layout of a type of document - data. + Defines the structure and layout of a + type of document data. """ # Create or coerce a protobuf request object. @@ -1245,7 +1260,8 @@ def delete_schema( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Deletes a [Schema][google.cloud.discoveryengine.v1beta.Schema]. + r"""Deletes a `Schema + `__. .. code-block:: python @@ -1280,11 +1296,12 @@ def sample_delete_schema(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.DeleteSchemaRequest, dict]): The request object. Request message for - [SchemaService.DeleteSchema][google.cloud.discoveryengine.v1beta.SchemaService.DeleteSchema] + `SchemaService.DeleteSchema + `__ method. name (str): - Required. The full resource name of the schema, in the - format of + Required. The full resource name of the + schema, in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}``. This corresponds to the ``name`` field @@ -1300,18 +1317,21 @@ def sample_delete_schema(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/schema_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/schema_service/transports/grpc.py index 3bb625e3288e..154a10cd6fca 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/schema_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/schema_service/transports/grpc.py @@ -112,8 +112,8 @@ def intercept_unary_unary(self, continuation, client_call_details, request): class SchemaServiceGrpcTransport(SchemaServiceTransport): """gRPC backend transport for SchemaService. - Service for managing - [Schema][google.cloud.discoveryengine.v1beta.Schema]s. + Service for managing `Schema + `__s. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -345,7 +345,8 @@ def operations_client(self) -> operations_v1.OperationsClient: def get_schema(self) -> Callable[[schema_service.GetSchemaRequest], schema.Schema]: r"""Return a callable for the get schema method over gRPC. - Gets a [Schema][google.cloud.discoveryengine.v1beta.Schema]. + Gets a `Schema + `__. Returns: Callable[[~.GetSchemaRequest], @@ -373,8 +374,8 @@ def list_schemas( ]: r"""Return a callable for the list schemas method over gRPC. - Gets a list of - [Schema][google.cloud.discoveryengine.v1beta.Schema]s. + Gets a list of `Schema + `__s. Returns: Callable[[~.ListSchemasRequest], @@ -400,7 +401,8 @@ def create_schema( ) -> Callable[[schema_service.CreateSchemaRequest], operations_pb2.Operation]: r"""Return a callable for the create schema method over gRPC. - Creates a [Schema][google.cloud.discoveryengine.v1beta.Schema]. + Creates a `Schema + `__. Returns: Callable[[~.CreateSchemaRequest], @@ -426,7 +428,8 @@ def update_schema( ) -> Callable[[schema_service.UpdateSchemaRequest], operations_pb2.Operation]: r"""Return a callable for the update schema method over gRPC. - Updates a [Schema][google.cloud.discoveryengine.v1beta.Schema]. + Updates a `Schema + `__. Returns: Callable[[~.UpdateSchemaRequest], @@ -452,7 +455,8 @@ def delete_schema( ) -> Callable[[schema_service.DeleteSchemaRequest], operations_pb2.Operation]: r"""Return a callable for the delete schema method over gRPC. - Deletes a [Schema][google.cloud.discoveryengine.v1beta.Schema]. + Deletes a `Schema + `__. Returns: Callable[[~.DeleteSchemaRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/schema_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/schema_service/transports/grpc_asyncio.py index bf4829dc9442..ec9344516c29 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/schema_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/schema_service/transports/grpc_asyncio.py @@ -118,8 +118,8 @@ async def intercept_unary_unary(self, continuation, client_call_details, request class SchemaServiceGrpcAsyncIOTransport(SchemaServiceTransport): """gRPC AsyncIO backend transport for SchemaService. - Service for managing - [Schema][google.cloud.discoveryengine.v1beta.Schema]s. + Service for managing `Schema + `__s. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -355,7 +355,8 @@ def get_schema( ) -> Callable[[schema_service.GetSchemaRequest], Awaitable[schema.Schema]]: r"""Return a callable for the get schema method over gRPC. - Gets a [Schema][google.cloud.discoveryengine.v1beta.Schema]. + Gets a `Schema + `__. Returns: Callable[[~.GetSchemaRequest], @@ -384,8 +385,8 @@ def list_schemas( ]: r"""Return a callable for the list schemas method over gRPC. - Gets a list of - [Schema][google.cloud.discoveryengine.v1beta.Schema]s. + Gets a list of `Schema + `__s. Returns: Callable[[~.ListSchemasRequest], @@ -413,7 +414,8 @@ def create_schema( ]: r"""Return a callable for the create schema method over gRPC. - Creates a [Schema][google.cloud.discoveryengine.v1beta.Schema]. + Creates a `Schema + `__. Returns: Callable[[~.CreateSchemaRequest], @@ -441,7 +443,8 @@ def update_schema( ]: r"""Return a callable for the update schema method over gRPC. - Updates a [Schema][google.cloud.discoveryengine.v1beta.Schema]. + Updates a `Schema + `__. Returns: Callable[[~.UpdateSchemaRequest], @@ -469,7 +472,8 @@ def delete_schema( ]: r"""Return a callable for the delete schema method over gRPC. - Deletes a [Schema][google.cloud.discoveryengine.v1beta.Schema]. + Deletes a `Schema + `__. Returns: Callable[[~.DeleteSchemaRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/schema_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/schema_service/transports/rest.py index 872adb10c4ac..c2b74ace904f 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/schema_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/schema_service/transports/rest.py @@ -442,8 +442,8 @@ class SchemaServiceRestStub: class SchemaServiceRestTransport(_BaseSchemaServiceRestTransport): """REST backend synchronous transport for SchemaService. - Service for managing - [Schema][google.cloud.discoveryengine.v1beta.Schema]s. + Service for managing `Schema + `__s. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -727,7 +727,8 @@ def __call__( Args: request (~.schema_service.CreateSchemaRequest): The request object. Request message for - [SchemaService.CreateSchema][google.cloud.discoveryengine.v1beta.SchemaService.CreateSchema] + `SchemaService.CreateSchema + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -879,7 +880,8 @@ def __call__( Args: request (~.schema_service.DeleteSchemaRequest): The request object. Request message for - [SchemaService.DeleteSchema][google.cloud.discoveryengine.v1beta.SchemaService.DeleteSchema] + `SchemaService.DeleteSchema + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1026,7 +1028,8 @@ def __call__( Args: request (~.schema_service.GetSchemaRequest): The request object. Request message for - [SchemaService.GetSchema][google.cloud.discoveryengine.v1beta.SchemaService.GetSchema] + `SchemaService.GetSchema + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1178,7 +1181,8 @@ def __call__( Args: request (~.schema_service.ListSchemasRequest): The request object. Request message for - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas] + `SchemaService.ListSchemas + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1191,7 +1195,8 @@ def __call__( Returns: ~.schema_service.ListSchemasResponse: Response message for - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas] + `SchemaService.ListSchemas + `__ method. """ @@ -1332,7 +1337,8 @@ def __call__( Args: request (~.schema_service.UpdateSchemaRequest): The request object. Request message for - [SchemaService.UpdateSchema][google.cloud.discoveryengine.v1beta.SchemaService.UpdateSchema] + `SchemaService.UpdateSchema + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_service/async_client.py index 9152e7214767..77fa71dacc14 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_service/async_client.py @@ -342,7 +342,8 @@ async def sample_search(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.SearchRequest, dict]]): The request object. Request message for - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] + `SearchService.Search + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -355,11 +356,13 @@ async def sample_search(): Returns: google.cloud.discoveryengine_v1beta.services.search_service.pagers.SearchAsyncPager: Response message for - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] - method. + `SearchService.Search + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -414,20 +417,23 @@ async def search_lite( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.SearchLiteAsyncPager: r"""Performs a search. Similar to the - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] + `SearchService.Search + `__ method, but a lite version that allows API key for - authentication, where OAuth and IAM checks are not required. + authentication, where OAuth and IAM checks are not + required. - Only public website search is supported by this method. If data - stores and engines not associated with public website search are - specified, a ``FAILED_PRECONDITION`` error is returned. + Only public website search is supported by this method. + If data stores and engines not associated with public + website search are specified, a ``FAILED_PRECONDITION`` + error is returned. - This method can be used for easy onboarding without having to - implement an authentication backend. However, it is strongly - recommended to use - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] - instead with required OAuth and IAM checks to provide better - data security. + This method can be used for easy onboarding without + having to implement an authentication backend. However, + it is strongly recommended to use `SearchService.Search + `__ + instead with required OAuth and IAM checks to provide + better data security. .. code-block:: python @@ -459,7 +465,8 @@ async def sample_search_lite(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.SearchRequest, dict]]): The request object. Request message for - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] + `SearchService.Search + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -472,11 +479,13 @@ async def sample_search_lite(): Returns: google.cloud.discoveryengine_v1beta.services.search_service.pagers.SearchLiteAsyncPager: Response message for - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] - method. + `SearchService.Search + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_service/client.py index e4106c33b092..bd469e033bf2 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_service/client.py @@ -877,7 +877,8 @@ def sample_search(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.SearchRequest, dict]): The request object. Request message for - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] + `SearchService.Search + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -890,11 +891,13 @@ def sample_search(): Returns: google.cloud.discoveryengine_v1beta.services.search_service.pagers.SearchPager: Response message for - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] - method. + `SearchService.Search + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -949,20 +952,23 @@ def search_lite( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.SearchLitePager: r"""Performs a search. Similar to the - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] + `SearchService.Search + `__ method, but a lite version that allows API key for - authentication, where OAuth and IAM checks are not required. + authentication, where OAuth and IAM checks are not + required. - Only public website search is supported by this method. If data - stores and engines not associated with public website search are - specified, a ``FAILED_PRECONDITION`` error is returned. + Only public website search is supported by this method. + If data stores and engines not associated with public + website search are specified, a ``FAILED_PRECONDITION`` + error is returned. - This method can be used for easy onboarding without having to - implement an authentication backend. However, it is strongly - recommended to use - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] - instead with required OAuth and IAM checks to provide better - data security. + This method can be used for easy onboarding without + having to implement an authentication backend. However, + it is strongly recommended to use `SearchService.Search + `__ + instead with required OAuth and IAM checks to provide + better data security. .. code-block:: python @@ -994,7 +1000,8 @@ def sample_search_lite(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.SearchRequest, dict]): The request object. Request message for - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] + `SearchService.Search + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1007,11 +1014,13 @@ def sample_search_lite(): Returns: google.cloud.discoveryengine_v1beta.services.search_service.pagers.SearchLitePager: Response message for - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] - method. + `SearchService.Search + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_service/transports/grpc.py index f19b576030c2..2af7b26b99f5 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_service/transports/grpc.py @@ -356,20 +356,23 @@ def search_lite( r"""Return a callable for the search lite method over gRPC. Performs a search. Similar to the - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] + `SearchService.Search + `__ method, but a lite version that allows API key for - authentication, where OAuth and IAM checks are not required. - - Only public website search is supported by this method. If data - stores and engines not associated with public website search are - specified, a ``FAILED_PRECONDITION`` error is returned. - - This method can be used for easy onboarding without having to - implement an authentication backend. However, it is strongly - recommended to use - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] - instead with required OAuth and IAM checks to provide better - data security. + authentication, where OAuth and IAM checks are not + required. + + Only public website search is supported by this method. + If data stores and engines not associated with public + website search are specified, a ``FAILED_PRECONDITION`` + error is returned. + + This method can be used for easy onboarding without + having to implement an authentication backend. However, + it is strongly recommended to use `SearchService.Search + `__ + instead with required OAuth and IAM checks to provide + better data security. Returns: Callable[[~.SearchRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_service/transports/grpc_asyncio.py index c6e20c6cd93a..f00a2706e4cb 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_service/transports/grpc_asyncio.py @@ -368,20 +368,23 @@ def search_lite( r"""Return a callable for the search lite method over gRPC. Performs a search. Similar to the - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] + `SearchService.Search + `__ method, but a lite version that allows API key for - authentication, where OAuth and IAM checks are not required. - - Only public website search is supported by this method. If data - stores and engines not associated with public website search are - specified, a ``FAILED_PRECONDITION`` error is returned. - - This method can be used for easy onboarding without having to - implement an authentication backend. However, it is strongly - recommended to use - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] - instead with required OAuth and IAM checks to provide better - data security. + authentication, where OAuth and IAM checks are not + required. + + Only public website search is supported by this method. + If data stores and engines not associated with public + website search are specified, a ``FAILED_PRECONDITION`` + error is returned. + + This method can be used for easy onboarding without + having to implement an authentication backend. However, + it is strongly recommended to use `SearchService.Search + `__ + instead with required OAuth and IAM checks to provide + better data security. Returns: Callable[[~.SearchRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_service/transports/rest.py index c46e4a992fed..b342938fee26 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_service/transports/rest.py @@ -389,7 +389,8 @@ def __call__( Args: request (~.search_service.SearchRequest): The request object. Request message for - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] + `SearchService.Search + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -402,7 +403,8 @@ def __call__( Returns: ~.search_service.SearchResponse: Response message for - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] + `SearchService.Search + `__ method. """ @@ -548,7 +550,8 @@ def __call__( Args: request (~.search_service.SearchRequest): The request object. Request message for - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] + `SearchService.Search + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -561,7 +564,8 @@ def __call__( Returns: ~.search_service.SearchResponse: Response message for - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] + `SearchService.Search + `__ method. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_tuning_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_tuning_service/async_client.py index 1aa612514291..98e027e505c9 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_tuning_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_tuning_service/async_client.py @@ -351,7 +351,8 @@ async def sample_train_custom_model(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.TrainCustomModelRequest, dict]]): The request object. Request message for - [SearchTuningService.TrainCustomModel][google.cloud.discoveryengine.v1beta.SearchTuningService.TrainCustomModel] + `SearchTuningService.TrainCustomModel + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -363,12 +364,16 @@ async def sample_train_custom_model(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.TrainCustomModelResponse` Response of the - [TrainCustomModelRequest][google.cloud.discoveryengine.v1beta.TrainCustomModelRequest]. - This message is returned by the - google.longrunning.Operations.response field. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.TrainCustomModelResponse` + Response of the `TrainCustomModelRequest + `__. + This message is returned by the + google.longrunning.Operations.response + field. """ # Create or coerce a protobuf request object. @@ -454,7 +459,8 @@ async def sample_list_custom_models(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.ListCustomModelsRequest, dict]]): The request object. Request message for - [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1beta.SearchTuningService.ListCustomModels] + `SearchTuningService.ListCustomModels + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -467,8 +473,9 @@ async def sample_list_custom_models(): Returns: google.cloud.discoveryengine_v1beta.types.ListCustomModelsResponse: Response message for - [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1beta.SearchTuningService.ListCustomModels] - method. + `SearchTuningService.ListCustomModels + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_tuning_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_tuning_service/client.py index 1fc8d798c2e0..9ea21dd0a1c9 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_tuning_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_tuning_service/client.py @@ -791,7 +791,8 @@ def sample_train_custom_model(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.TrainCustomModelRequest, dict]): The request object. Request message for - [SearchTuningService.TrainCustomModel][google.cloud.discoveryengine.v1beta.SearchTuningService.TrainCustomModel] + `SearchTuningService.TrainCustomModel + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -803,12 +804,16 @@ def sample_train_custom_model(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.TrainCustomModelResponse` Response of the - [TrainCustomModelRequest][google.cloud.discoveryengine.v1beta.TrainCustomModelRequest]. - This message is returned by the - google.longrunning.Operations.response field. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.TrainCustomModelResponse` + Response of the `TrainCustomModelRequest + `__. + This message is returned by the + google.longrunning.Operations.response + field. """ # Create or coerce a protobuf request object. @@ -892,7 +897,8 @@ def sample_list_custom_models(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.ListCustomModelsRequest, dict]): The request object. Request message for - [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1beta.SearchTuningService.ListCustomModels] + `SearchTuningService.ListCustomModels + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -905,8 +911,9 @@ def sample_list_custom_models(): Returns: google.cloud.discoveryengine_v1beta.types.ListCustomModelsResponse: Response message for - [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1beta.SearchTuningService.ListCustomModels] - method. + `SearchTuningService.ListCustomModels + `__ + method. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_tuning_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_tuning_service/transports/rest.py index c55d14440fc4..cdbb9bf5ee5a 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_tuning_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/search_tuning_service/transports/rest.py @@ -565,7 +565,8 @@ def __call__( Args: request (~.search_tuning_service.ListCustomModelsRequest): The request object. Request message for - [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1beta.SearchTuningService.ListCustomModels] + `SearchTuningService.ListCustomModels + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -578,7 +579,8 @@ def __call__( Returns: ~.search_tuning_service.ListCustomModelsResponse: Response message for - [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1beta.SearchTuningService.ListCustomModels] + `SearchTuningService.ListCustomModels + `__ method. """ @@ -720,7 +722,8 @@ def __call__( Args: request (~.search_tuning_service.TrainCustomModelRequest): The request object. Request message for - [SearchTuningService.TrainCustomModel][google.cloud.discoveryengine.v1beta.SearchTuningService.TrainCustomModel] + `SearchTuningService.TrainCustomModel + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/serving_config_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/serving_config_service/async_client.py index f25cafc4960d..631e267a50bc 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/serving_config_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/serving_config_service/async_client.py @@ -73,7 +73,8 @@ class ServingConfigServiceAsyncClient: """Service for operations related to - [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig]. + `ServingConfig + `__. """ _client: ServingConfigServiceClient @@ -319,7 +320,8 @@ async def update_serving_config( ) -> gcd_serving_config.ServingConfig: r"""Updates a ServingConfig. - Returns a NOT_FOUND error if the ServingConfig does not exist. + Returns a NOT_FOUND error if the ServingConfig does not + exist. .. code-block:: python @@ -365,12 +367,16 @@ async def sample_update_serving_config(): should not be set. update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): Indicates which fields in the provided - [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] - to update. The following are NOT supported: + `ServingConfig + `__ + to update. The following are NOT + supported: - - [ServingConfig.name][google.cloud.discoveryengine.v1beta.ServingConfig.name] + * `ServingConfig.name + `__ - If not set, all supported fields are updated. + If not set, all supported fields are + updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -492,8 +498,8 @@ async def sample_get_serving_config(): request (Optional[Union[google.cloud.discoveryengine_v1beta.types.GetServingConfigRequest, dict]]): The request object. Request for GetServingConfig method. name (:class:`str`): - Required. The resource name of the ServingConfig to get. - Format: + Required. The resource name of the + ServingConfig to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`` This corresponds to the ``name`` field @@ -611,8 +617,8 @@ async def sample_list_serving_configs(): The request object. Request for ListServingConfigs method. parent (:class:`str`): - Required. Full resource name of the parent resource. - Format: + Required. Full resource name of the + parent resource. Format: ``projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`` This corresponds to the ``parent`` field diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/serving_config_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/serving_config_service/client.py index 37816e60c234..5c91bae17bcb 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/serving_config_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/serving_config_service/client.py @@ -119,7 +119,8 @@ def get_transport_class( class ServingConfigServiceClient(metaclass=ServingConfigServiceClientMeta): """Service for operations related to - [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig]. + `ServingConfig + `__. """ @staticmethod @@ -743,7 +744,8 @@ def update_serving_config( ) -> gcd_serving_config.ServingConfig: r"""Updates a ServingConfig. - Returns a NOT_FOUND error if the ServingConfig does not exist. + Returns a NOT_FOUND error if the ServingConfig does not + exist. .. code-block:: python @@ -789,12 +791,16 @@ def sample_update_serving_config(): should not be set. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] - to update. The following are NOT supported: + `ServingConfig + `__ + to update. The following are NOT + supported: - - [ServingConfig.name][google.cloud.discoveryengine.v1beta.ServingConfig.name] + * `ServingConfig.name + `__ - If not set, all supported fields are updated. + If not set, all supported fields are + updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -913,8 +919,8 @@ def sample_get_serving_config(): request (Union[google.cloud.discoveryengine_v1beta.types.GetServingConfigRequest, dict]): The request object. Request for GetServingConfig method. name (str): - Required. The resource name of the ServingConfig to get. - Format: + Required. The resource name of the + ServingConfig to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`` This corresponds to the ``name`` field @@ -1029,8 +1035,8 @@ def sample_list_serving_configs(): The request object. Request for ListServingConfigs method. parent (str): - Required. Full resource name of the parent resource. - Format: + Required. Full resource name of the + parent resource. Format: ``projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`` This corresponds to the ``parent`` field diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/serving_config_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/serving_config_service/transports/grpc.py index 4da66aaf6a85..2e9a39486078 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/serving_config_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/serving_config_service/transports/grpc.py @@ -117,7 +117,8 @@ class ServingConfigServiceGrpcTransport(ServingConfigServiceTransport): """gRPC backend transport for ServingConfigService. Service for operations related to - [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig]. + `ServingConfig + `__. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -339,7 +340,8 @@ def update_serving_config( Updates a ServingConfig. - Returns a NOT_FOUND error if the ServingConfig does not exist. + Returns a NOT_FOUND error if the ServingConfig does not + exist. Returns: Callable[[~.UpdateServingConfigRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/serving_config_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/serving_config_service/transports/grpc_asyncio.py index f4a00d16bf7e..9a19af86b331 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/serving_config_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/serving_config_service/transports/grpc_asyncio.py @@ -123,7 +123,8 @@ class ServingConfigServiceGrpcAsyncIOTransport(ServingConfigServiceTransport): """gRPC AsyncIO backend transport for ServingConfigService. Service for operations related to - [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig]. + `ServingConfig + `__. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation @@ -347,7 +348,8 @@ def update_serving_config( Updates a ServingConfig. - Returns a NOT_FOUND error if the ServingConfig does not exist. + Returns a NOT_FOUND error if the ServingConfig does not + exist. Returns: Callable[[~.UpdateServingConfigRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/serving_config_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/serving_config_service/transports/rest.py index 8703bf54329f..ea5f8f5450a9 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/serving_config_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/serving_config_service/transports/rest.py @@ -345,7 +345,8 @@ class ServingConfigServiceRestTransport(_BaseServingConfigServiceRestTransport): """REST backend synchronous transport for ServingConfigService. Service for operations related to - [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig]. + `ServingConfig + `__. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/session_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/session_service/async_client.py index 3e1a745dab83..5cb64bd88e0d 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/session_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/session_service/async_client.py @@ -316,8 +316,10 @@ async def create_session( ) -> gcd_session.Session: r"""Creates a Session. - If the [Session][google.cloud.discoveryengine.v1beta.Session] to - create already exists, an ALREADY_EXISTS error is returned. + If the `Session + `__ to + create already exists, an ALREADY_EXISTS error is + returned. .. code-block:: python @@ -349,8 +351,8 @@ async def sample_create_session(): request (Optional[Union[google.cloud.discoveryengine_v1beta.types.CreateSessionRequest, dict]]): The request object. Request for CreateSession method. parent (:class:`str`): - Required. Full resource name of parent data store. - Format: + Required. Full resource name of parent + data store. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field @@ -437,7 +439,8 @@ async def delete_session( ) -> None: r"""Deletes a Session. - If the [Session][google.cloud.discoveryengine.v1beta.Session] to + If the `Session + `__ to delete does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -467,8 +470,8 @@ async def sample_delete_session(): request (Optional[Union[google.cloud.discoveryengine_v1beta.types.DeleteSessionRequest, dict]]): The request object. Request for DeleteSession method. name (:class:`str`): - Required. The resource name of the Session to delete. - Format: + Required. The resource name of the + Session to delete. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` This corresponds to the ``name`` field @@ -542,10 +545,11 @@ async def update_session( ) -> gcd_session.Session: r"""Updates a Session. - [Session][google.cloud.discoveryengine.v1beta.Session] action - type cannot be changed. If the - [Session][google.cloud.discoveryengine.v1beta.Session] to update - does not exist, a NOT_FOUND error is returned. + `Session + `__ action + type cannot be changed. If the `Session + `__ to + update does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -582,12 +586,16 @@ async def sample_update_session(): should not be set. update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): Indicates which fields in the provided - [Session][google.cloud.discoveryengine.v1beta.Session] - to update. The following are NOT supported: + `Session + `__ + to update. The following are NOT + supported: - - [Session.name][google.cloud.discoveryengine.v1beta.Session.name] + * `Session.name + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported + fields are updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -700,8 +708,8 @@ async def sample_get_session(): request (Optional[Union[google.cloud.discoveryengine_v1beta.types.GetSessionRequest, dict]]): The request object. Request for GetSession method. name (:class:`str`): - Required. The resource name of the Session to get. - Format: + Required. The resource name of the + Session to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` This corresponds to the ``name`` field @@ -780,7 +788,8 @@ async def list_sessions( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListSessionsAsyncPager: r"""Lists all Sessions by their parent - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + `DataStore + `__. .. code-block:: python @@ -813,7 +822,8 @@ async def sample_list_sessions(): request (Optional[Union[google.cloud.discoveryengine_v1beta.types.ListSessionsRequest, dict]]): The request object. Request for ListSessions method. parent (:class:`str`): - Required. The data store resource name. Format: + Required. The data store resource name. + Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/session_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/session_service/client.py index 73766d386aeb..66af35244312 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/session_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/session_service/client.py @@ -835,8 +835,10 @@ def create_session( ) -> gcd_session.Session: r"""Creates a Session. - If the [Session][google.cloud.discoveryengine.v1beta.Session] to - create already exists, an ALREADY_EXISTS error is returned. + If the `Session + `__ to + create already exists, an ALREADY_EXISTS error is + returned. .. code-block:: python @@ -868,8 +870,8 @@ def sample_create_session(): request (Union[google.cloud.discoveryengine_v1beta.types.CreateSessionRequest, dict]): The request object. Request for CreateSession method. parent (str): - Required. Full resource name of parent data store. - Format: + Required. Full resource name of parent + data store. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field @@ -953,7 +955,8 @@ def delete_session( ) -> None: r"""Deletes a Session. - If the [Session][google.cloud.discoveryengine.v1beta.Session] to + If the `Session + `__ to delete does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -983,8 +986,8 @@ def sample_delete_session(): request (Union[google.cloud.discoveryengine_v1beta.types.DeleteSessionRequest, dict]): The request object. Request for DeleteSession method. name (str): - Required. The resource name of the Session to delete. - Format: + Required. The resource name of the + Session to delete. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` This corresponds to the ``name`` field @@ -1055,10 +1058,11 @@ def update_session( ) -> gcd_session.Session: r"""Updates a Session. - [Session][google.cloud.discoveryengine.v1beta.Session] action - type cannot be changed. If the - [Session][google.cloud.discoveryengine.v1beta.Session] to update - does not exist, a NOT_FOUND error is returned. + `Session + `__ action + type cannot be changed. If the `Session + `__ to + update does not exist, a NOT_FOUND error is returned. .. code-block:: python @@ -1095,12 +1099,16 @@ def sample_update_session(): should not be set. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [Session][google.cloud.discoveryengine.v1beta.Session] - to update. The following are NOT supported: + `Session + `__ + to update. The following are NOT + supported: - - [Session.name][google.cloud.discoveryengine.v1beta.Session.name] + * `Session.name + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported + fields are updated. This corresponds to the ``update_mask`` field on the ``request`` instance; if ``request`` is provided, this @@ -1210,8 +1218,8 @@ def sample_get_session(): request (Union[google.cloud.discoveryengine_v1beta.types.GetSessionRequest, dict]): The request object. Request for GetSession method. name (str): - Required. The resource name of the Session to get. - Format: + Required. The resource name of the + Session to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` This corresponds to the ``name`` field @@ -1287,7 +1295,8 @@ def list_sessions( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListSessionsPager: r"""Lists all Sessions by their parent - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + `DataStore + `__. .. code-block:: python @@ -1320,7 +1329,8 @@ def sample_list_sessions(): request (Union[google.cloud.discoveryengine_v1beta.types.ListSessionsRequest, dict]): The request object. Request for ListSessions method. parent (str): - Required. The data store resource name. Format: + Required. The data store resource name. + Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` This corresponds to the ``parent`` field diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/session_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/session_service/transports/grpc.py index 68804799730f..d90ede23b4d8 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/session_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/session_service/transports/grpc.py @@ -336,8 +336,10 @@ def create_session( Creates a Session. - If the [Session][google.cloud.discoveryengine.v1beta.Session] to - create already exists, an ALREADY_EXISTS error is returned. + If the `Session + `__ to + create already exists, an ALREADY_EXISTS error is + returned. Returns: Callable[[~.CreateSessionRequest], @@ -367,7 +369,8 @@ def delete_session( Deletes a Session. - If the [Session][google.cloud.discoveryengine.v1beta.Session] to + If the `Session + `__ to delete does not exist, a NOT_FOUND error is returned. Returns: @@ -398,10 +401,11 @@ def update_session( Updates a Session. - [Session][google.cloud.discoveryengine.v1beta.Session] action - type cannot be changed. If the - [Session][google.cloud.discoveryengine.v1beta.Session] to update - does not exist, a NOT_FOUND error is returned. + `Session + `__ action + type cannot be changed. If the `Session + `__ to + update does not exist, a NOT_FOUND error is returned. Returns: Callable[[~.UpdateSessionRequest], @@ -457,7 +461,8 @@ def list_sessions( r"""Return a callable for the list sessions method over gRPC. Lists all Sessions by their parent - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + `DataStore + `__. Returns: Callable[[~.ListSessionsRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/session_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/session_service/transports/grpc_asyncio.py index 7e0ce89dfce1..a1cd5cbc6cdd 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/session_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/session_service/transports/grpc_asyncio.py @@ -345,8 +345,10 @@ def create_session( Creates a Session. - If the [Session][google.cloud.discoveryengine.v1beta.Session] to - create already exists, an ALREADY_EXISTS error is returned. + If the `Session + `__ to + create already exists, an ALREADY_EXISTS error is + returned. Returns: Callable[[~.CreateSessionRequest], @@ -376,7 +378,8 @@ def delete_session( Deletes a Session. - If the [Session][google.cloud.discoveryengine.v1beta.Session] to + If the `Session + `__ to delete does not exist, a NOT_FOUND error is returned. Returns: @@ -408,10 +411,11 @@ def update_session( Updates a Session. - [Session][google.cloud.discoveryengine.v1beta.Session] action - type cannot be changed. If the - [Session][google.cloud.discoveryengine.v1beta.Session] to update - does not exist, a NOT_FOUND error is returned. + `Session + `__ action + type cannot be changed. If the `Session + `__ to + update does not exist, a NOT_FOUND error is returned. Returns: Callable[[~.UpdateSessionRequest], @@ -469,7 +473,8 @@ def list_sessions( r"""Return a callable for the list sessions method over gRPC. Lists all Sessions by their parent - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + `DataStore + `__. Returns: Callable[[~.ListSessionsRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/site_search_engine_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/site_search_engine_service/async_client.py index 89b86b5877ec..4f1e3a4c1c48 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/site_search_engine_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/site_search_engine_service/async_client.py @@ -331,7 +331,8 @@ async def get_site_search_engine( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> site_search_engine.SiteSearchEngine: r"""Gets the - [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine]. + `SiteSearchEngine + `__. .. code-block:: python @@ -362,17 +363,20 @@ async def sample_get_site_search_engine(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.GetSiteSearchEngineRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.GetSiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.GetSiteSearchEngine] + `SiteSearchEngineService.GetSiteSearchEngine + `__ method. name (:class:`str`): Required. Resource name of - [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. - If the caller does not have permission to access the - [SiteSearchEngine], regardless of whether or not it - exists, a PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the [SiteSearchEngine], + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -456,8 +460,8 @@ async def create_target_site( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Creates a - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]. + r"""Creates a `TargetSite + `__. .. code-block:: python @@ -496,11 +500,13 @@ async def sample_create_target_site(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.CreateTargetSiteRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.CreateTargetSite] + `SiteSearchEngineService.CreateTargetSite + `__ method. parent (:class:`str`): Required. Parent resource name of - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. @@ -508,8 +514,8 @@ async def sample_create_target_site(): on the ``request`` instance; if ``request`` is provided, this should not be set. target_site (:class:`google.cloud.discoveryengine_v1beta.types.TargetSite`): - Required. The - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] + Required. The `TargetSite + `__ to create. This corresponds to the ``target_site`` field @@ -525,9 +531,10 @@ async def sample_create_target_site(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1beta.types.TargetSite` A target site for the SiteSearchEngine. @@ -601,9 +608,9 @@ async def batch_create_target_sites( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Creates - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] in - a batch. + r"""Creates `TargetSite + `__ in a + batch. .. code-block:: python @@ -643,7 +650,8 @@ async def sample_batch_create_target_sites(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.BatchCreateTargetSitesRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchCreateTargetSites] + `SiteSearchEngineService.BatchCreateTargetSites + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -655,11 +663,15 @@ async def sample_batch_create_target_sites(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.BatchCreateTargetSitesResponse` Response message for - [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchCreateTargetSites] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.BatchCreateTargetSitesResponse` + Response message for + `SiteSearchEngineService.BatchCreateTargetSites + `__ + method. """ # Create or coerce a protobuf request object. @@ -715,8 +727,8 @@ async def get_target_site( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> site_search_engine.TargetSite: - r"""Gets a - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]. + r"""Gets a `TargetSite + `__. .. code-block:: python @@ -747,22 +759,27 @@ async def sample_get_target_site(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.GetTargetSiteRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.GetTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.GetTargetSite] + `SiteSearchEngineService.GetTargetSite + `__ method. name (:class:`str`): Required. Full resource name of - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}``. - If the caller does not have permission to access the - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `TargetSite + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. If the requested - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] - does not exist, a NOT_FOUND error is returned. + `TargetSite + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -841,8 +858,8 @@ async def update_target_site( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Updates a - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]. + r"""Updates a `TargetSite + `__. .. code-block:: python @@ -880,18 +897,21 @@ async def sample_update_target_site(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.UpdateTargetSiteRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.UpdateTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.UpdateTargetSite] + `SiteSearchEngineService.UpdateTargetSite + `__ method. target_site (:class:`google.cloud.discoveryengine_v1beta.types.TargetSite`): - Required. The target site to update. If the caller does - not have permission to update the - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. - - If the - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] - to update does not exist, a NOT_FOUND error is returned. + Required. The target site to update. + If the caller does not have permission + to update the `TargetSite + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. + + If the `TargetSite + `__ + to update does not exist, a NOT_FOUND + error is returned. This corresponds to the ``target_site`` field on the ``request`` instance; if ``request`` is provided, this @@ -906,9 +926,10 @@ async def sample_update_target_site(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1beta.types.TargetSite` A target site for the SiteSearchEngine. @@ -983,8 +1004,8 @@ async def delete_target_site( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Deletes a - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]. + r"""Deletes a `TargetSite + `__. .. code-block:: python @@ -1019,22 +1040,27 @@ async def sample_delete_target_site(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.DeleteTargetSiteRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DeleteTargetSite] + `SiteSearchEngineService.DeleteTargetSite + `__ method. name (:class:`str`): Required. Full resource name of - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}``. - If the caller does not have permission to access the - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `TargetSite + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. If the requested - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] - does not exist, a NOT_FOUND error is returned. + `TargetSite + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -1049,18 +1075,21 @@ async def sample_delete_target_site(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. @@ -1132,7 +1161,8 @@ async def list_target_sites( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListTargetSitesAsyncPager: r"""Gets a list of - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s. + `TargetSite + `__s. .. code-block:: python @@ -1164,17 +1194,20 @@ async def sample_list_target_sites(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.ListTargetSitesRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.ListTargetSites] + `SiteSearchEngineService.ListTargetSites + `__ method. parent (:class:`str`): - Required. The parent site search engine resource name, - such as + Required. The parent site search engine + resource name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. - If the caller does not have permission to list - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s - under this site search engine, regardless of whether or - not this branch exists, a PERMISSION_DENIED error is + If the caller does not have permission + to list `TargetSite + `__s + under this site search engine, + regardless of whether or not this branch + exists, a PERMISSION_DENIED error is returned. This corresponds to the ``parent`` field @@ -1191,11 +1224,13 @@ async def sample_list_target_sites(): Returns: google.cloud.discoveryengine_v1beta.services.site_search_engine_service.pagers.ListTargetSitesAsyncPager: Response message for - [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.ListTargetSites] - method. + `SiteSearchEngineService.ListTargetSites + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -1270,8 +1305,8 @@ async def create_sitemap( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Creates a - [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap]. + r"""Creates a `Sitemap + `__. .. code-block:: python @@ -1310,11 +1345,13 @@ async def sample_create_sitemap(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.CreateSitemapRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.CreateSitemap][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.CreateSitemap] + `SiteSearchEngineService.CreateSitemap + `__ method. parent (:class:`str`): Required. Parent resource name of the - [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine``. @@ -1322,8 +1359,8 @@ async def sample_create_sitemap(): on the ``request`` instance; if ``request`` is provided, this should not be set. sitemap (:class:`google.cloud.discoveryengine_v1beta.types.Sitemap`): - Required. The - [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap] + Required. The `Sitemap + `__ to create. This corresponds to the ``sitemap`` field @@ -1339,9 +1376,10 @@ async def sample_create_sitemap(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1beta.types.Sitemap` A sitemap for the SiteSearchEngine. @@ -1416,8 +1454,8 @@ async def delete_sitemap( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: - r"""Deletes a - [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap]. + r"""Deletes a `Sitemap + `__. .. code-block:: python @@ -1452,22 +1490,26 @@ async def sample_delete_sitemap(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.DeleteSitemapRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.DeleteSitemap][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DeleteSitemap] + `SiteSearchEngineService.DeleteSitemap + `__ method. name (:class:`str`): Required. Full resource name of - [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap], + `Sitemap + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}``. - If the caller does not have permission to access the - [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `Sitemap + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the requested - [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap] - does not exist, a NOT_FOUND error is returned. + If the requested `Sitemap + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -1482,18 +1524,21 @@ async def sample_delete_sitemap(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. @@ -1564,8 +1609,10 @@ async def fetch_sitemaps( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> site_search_engine_service.FetchSitemapsResponse: - r"""Fetch [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap]s in - a [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + r"""Fetch `Sitemap + `__s in a + `DataStore + `__. .. code-block:: python @@ -1596,11 +1643,13 @@ async def sample_fetch_sitemaps(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.FetchSitemapsRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.FetchSitemaps][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.FetchSitemaps] + `SiteSearchEngineService.FetchSitemaps + `__ method. parent (:class:`str`): Required. Parent resource name of the - [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine``. @@ -1618,8 +1667,9 @@ async def sample_fetch_sitemaps(): Returns: google.cloud.discoveryengine_v1beta.types.FetchSitemapsResponse: Response message for - [SiteSearchEngineService.FetchSitemaps][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.FetchSitemaps] - method. + `SiteSearchEngineService.FetchSitemaps + `__ + method. """ # Create or coerce a protobuf request object. @@ -1717,7 +1767,8 @@ async def sample_enable_advanced_site_search(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.EnableAdvancedSiteSearchRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.EnableAdvancedSiteSearch] + `SiteSearchEngineService.EnableAdvancedSiteSearch + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -1729,11 +1780,15 @@ async def sample_enable_advanced_site_search(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.EnableAdvancedSiteSearchResponse` Response message for - [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.EnableAdvancedSiteSearch] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.EnableAdvancedSiteSearchResponse` + Response message for + `SiteSearchEngineService.EnableAdvancedSiteSearch + `__ + method. """ # Create or coerce a protobuf request object. @@ -1828,7 +1883,8 @@ async def sample_disable_advanced_site_search(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.DisableAdvancedSiteSearchRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DisableAdvancedSiteSearch] + `SiteSearchEngineService.DisableAdvancedSiteSearch + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -1840,11 +1896,15 @@ async def sample_disable_advanced_site_search(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.DisableAdvancedSiteSearchResponse` Response message for - [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DisableAdvancedSiteSearch] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.DisableAdvancedSiteSearchResponse` + Response message for + `SiteSearchEngineService.DisableAdvancedSiteSearch + `__ + method. """ # Create or coerce a protobuf request object. @@ -1939,7 +1999,8 @@ async def sample_recrawl_uris(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.RecrawlUrisRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.RecrawlUris] + `SiteSearchEngineService.RecrawlUris + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -1951,11 +2012,15 @@ async def sample_recrawl_uris(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.RecrawlUrisResponse` Response message for - [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.RecrawlUris] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.RecrawlUrisResponse` + Response message for + `SiteSearchEngineService.RecrawlUris + `__ + method. """ # Create or coerce a protobuf request object. @@ -2047,7 +2112,8 @@ async def sample_batch_verify_target_sites(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.BatchVerifyTargetSitesRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchVerifyTargetSites] + `SiteSearchEngineService.BatchVerifyTargetSites + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -2059,11 +2125,15 @@ async def sample_batch_verify_target_sites(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.BatchVerifyTargetSitesResponse` Response message for - [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchVerifyTargetSites] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.BatchVerifyTargetSitesResponse` + Response message for + `SiteSearchEngineService.BatchVerifyTargetSites + `__ + method. """ # Create or coerce a protobuf request object. @@ -2118,9 +2188,10 @@ async def fetch_domain_verification_status( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.FetchDomainVerificationStatusAsyncPager: - r"""Returns list of target sites with its domain verification - status. This method can only be called under data store with - BASIC_SITE_SEARCH state at the moment. + r"""Returns list of target sites with its domain + verification status. This method can only be called + under data store with BASIC_SITE_SEARCH state at the + moment. .. code-block:: python @@ -2152,7 +2223,8 @@ async def sample_fetch_domain_verification_status(): Args: request (Optional[Union[google.cloud.discoveryengine_v1beta.types.FetchDomainVerificationStatusRequest, dict]]): The request object. Request message for - [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.FetchDomainVerificationStatus] + `SiteSearchEngineService.FetchDomainVerificationStatus + `__ method. retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, should be retried. @@ -2165,11 +2237,13 @@ async def sample_fetch_domain_verification_status(): Returns: google.cloud.discoveryengine_v1beta.services.site_search_engine_service.pagers.FetchDomainVerificationStatusAsyncPager: Response message for - [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.FetchDomainVerificationStatus] - method. + `SiteSearchEngineService.FetchDomainVerificationStatus + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/site_search_engine_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/site_search_engine_service/client.py index e79f570058da..0a1982812f1b 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/site_search_engine_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/site_search_engine_service/client.py @@ -791,7 +791,8 @@ def get_site_search_engine( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> site_search_engine.SiteSearchEngine: r"""Gets the - [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine]. + `SiteSearchEngine + `__. .. code-block:: python @@ -822,17 +823,20 @@ def sample_get_site_search_engine(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.GetSiteSearchEngineRequest, dict]): The request object. Request message for - [SiteSearchEngineService.GetSiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.GetSiteSearchEngine] + `SiteSearchEngineService.GetSiteSearchEngine + `__ method. name (str): Required. Resource name of - [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. - If the caller does not have permission to access the - [SiteSearchEngine], regardless of whether or not it - exists, a PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the [SiteSearchEngine], + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -913,8 +917,8 @@ def create_target_site( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Creates a - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]. + r"""Creates a `TargetSite + `__. .. code-block:: python @@ -953,11 +957,13 @@ def sample_create_target_site(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.CreateTargetSiteRequest, dict]): The request object. Request message for - [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.CreateTargetSite] + `SiteSearchEngineService.CreateTargetSite + `__ method. parent (str): Required. Parent resource name of - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. @@ -965,8 +971,8 @@ def sample_create_target_site(): on the ``request`` instance; if ``request`` is provided, this should not be set. target_site (google.cloud.discoveryengine_v1beta.types.TargetSite): - Required. The - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] + Required. The `TargetSite + `__ to create. This corresponds to the ``target_site`` field @@ -982,9 +988,10 @@ def sample_create_target_site(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1beta.types.TargetSite` A target site for the SiteSearchEngine. @@ -1055,9 +1062,9 @@ def batch_create_target_sites( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Creates - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] in - a batch. + r"""Creates `TargetSite + `__ in a + batch. .. code-block:: python @@ -1097,7 +1104,8 @@ def sample_batch_create_target_sites(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.BatchCreateTargetSitesRequest, dict]): The request object. Request message for - [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchCreateTargetSites] + `SiteSearchEngineService.BatchCreateTargetSites + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1109,11 +1117,15 @@ def sample_batch_create_target_sites(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.BatchCreateTargetSitesResponse` Response message for - [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchCreateTargetSites] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.BatchCreateTargetSitesResponse` + Response message for + `SiteSearchEngineService.BatchCreateTargetSites + `__ + method. """ # Create or coerce a protobuf request object. @@ -1169,8 +1181,8 @@ def get_target_site( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> site_search_engine.TargetSite: - r"""Gets a - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]. + r"""Gets a `TargetSite + `__. .. code-block:: python @@ -1201,22 +1213,27 @@ def sample_get_target_site(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.GetTargetSiteRequest, dict]): The request object. Request message for - [SiteSearchEngineService.GetTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.GetTargetSite] + `SiteSearchEngineService.GetTargetSite + `__ method. name (str): Required. Full resource name of - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}``. - If the caller does not have permission to access the - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `TargetSite + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. If the requested - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] - does not exist, a NOT_FOUND error is returned. + `TargetSite + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -1292,8 +1309,8 @@ def update_target_site( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Updates a - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]. + r"""Updates a `TargetSite + `__. .. code-block:: python @@ -1331,18 +1348,21 @@ def sample_update_target_site(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.UpdateTargetSiteRequest, dict]): The request object. Request message for - [SiteSearchEngineService.UpdateTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.UpdateTargetSite] + `SiteSearchEngineService.UpdateTargetSite + `__ method. target_site (google.cloud.discoveryengine_v1beta.types.TargetSite): - Required. The target site to update. If the caller does - not have permission to update the - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. - - If the - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] - to update does not exist, a NOT_FOUND error is returned. + Required. The target site to update. + If the caller does not have permission + to update the `TargetSite + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. + + If the `TargetSite + `__ + to update does not exist, a NOT_FOUND + error is returned. This corresponds to the ``target_site`` field on the ``request`` instance; if ``request`` is provided, this @@ -1357,9 +1377,10 @@ def sample_update_target_site(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1beta.types.TargetSite` A target site for the SiteSearchEngine. @@ -1431,8 +1452,8 @@ def delete_target_site( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Deletes a - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]. + r"""Deletes a `TargetSite + `__. .. code-block:: python @@ -1467,22 +1488,27 @@ def sample_delete_target_site(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.DeleteTargetSiteRequest, dict]): The request object. Request message for - [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DeleteTargetSite] + `SiteSearchEngineService.DeleteTargetSite + `__ method. name (str): Required. Full resource name of - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}``. - If the caller does not have permission to access the - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `TargetSite + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. If the requested - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] - does not exist, a NOT_FOUND error is returned. + `TargetSite + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -1497,18 +1523,21 @@ def sample_delete_target_site(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. @@ -1577,7 +1606,8 @@ def list_target_sites( metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListTargetSitesPager: r"""Gets a list of - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s. + `TargetSite + `__s. .. code-block:: python @@ -1609,17 +1639,20 @@ def sample_list_target_sites(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.ListTargetSitesRequest, dict]): The request object. Request message for - [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.ListTargetSites] + `SiteSearchEngineService.ListTargetSites + `__ method. parent (str): - Required. The parent site search engine resource name, - such as + Required. The parent site search engine + resource name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. - If the caller does not have permission to list - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s - under this site search engine, regardless of whether or - not this branch exists, a PERMISSION_DENIED error is + If the caller does not have permission + to list `TargetSite + `__s + under this site search engine, + regardless of whether or not this branch + exists, a PERMISSION_DENIED error is returned. This corresponds to the ``parent`` field @@ -1636,11 +1669,13 @@ def sample_list_target_sites(): Returns: google.cloud.discoveryengine_v1beta.services.site_search_engine_service.pagers.ListTargetSitesPager: Response message for - [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.ListTargetSites] - method. + `SiteSearchEngineService.ListTargetSites + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. @@ -1712,8 +1747,8 @@ def create_sitemap( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Creates a - [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap]. + r"""Creates a `Sitemap + `__. .. code-block:: python @@ -1752,11 +1787,13 @@ def sample_create_sitemap(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.CreateSitemapRequest, dict]): The request object. Request message for - [SiteSearchEngineService.CreateSitemap][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.CreateSitemap] + `SiteSearchEngineService.CreateSitemap + `__ method. parent (str): Required. Parent resource name of the - [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine``. @@ -1764,8 +1801,8 @@ def sample_create_sitemap(): on the ``request`` instance; if ``request`` is provided, this should not be set. sitemap (google.cloud.discoveryengine_v1beta.types.Sitemap): - Required. The - [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap] + Required. The `Sitemap + `__ to create. This corresponds to the ``sitemap`` field @@ -1781,9 +1818,10 @@ def sample_create_sitemap(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be + An object representing a long-running + operation. + The result type for the operation will + be :class:`google.cloud.discoveryengine_v1beta.types.Sitemap` A sitemap for the SiteSearchEngine. @@ -1855,8 +1893,8 @@ def delete_sitemap( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation.Operation: - r"""Deletes a - [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap]. + r"""Deletes a `Sitemap + `__. .. code-block:: python @@ -1891,22 +1929,26 @@ def sample_delete_sitemap(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.DeleteSitemapRequest, dict]): The request object. Request message for - [SiteSearchEngineService.DeleteSitemap][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DeleteSitemap] + `SiteSearchEngineService.DeleteSitemap + `__ method. name (str): Required. Full resource name of - [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap], + `Sitemap + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}``. - If the caller does not have permission to access the - [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap], - regardless of whether or not it exists, a - PERMISSION_DENIED error is returned. + If the caller does not have permission + to access the `Sitemap + `__, + regardless of whether or not it exists, + a PERMISSION_DENIED error is returned. - If the requested - [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap] - does not exist, a NOT_FOUND error is returned. + If the requested `Sitemap + `__ + does not exist, a NOT_FOUND error is + returned. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -1921,18 +1963,21 @@ def sample_delete_sitemap(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to - use it as the request or the response type of an API - method. For instance: - - service Foo { - rpc Bar(google.protobuf.Empty) returns - (google.protobuf.Empty); - - } + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.protobuf.empty_pb2.Empty` + A generic empty message that you can + re-use to avoid defining duplicated + empty messages in your APIs. A typical + example is to use it as the request or + the response type of an API method. For + instance: + + service Foo { + rpc Bar(google.protobuf.Empty) + returns (google.protobuf.Empty); } """ # Create or coerce a protobuf request object. @@ -2000,8 +2045,10 @@ def fetch_sitemaps( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> site_search_engine_service.FetchSitemapsResponse: - r"""Fetch [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap]s in - a [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + r"""Fetch `Sitemap + `__s in a + `DataStore + `__. .. code-block:: python @@ -2032,11 +2079,13 @@ def sample_fetch_sitemaps(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.FetchSitemapsRequest, dict]): The request object. Request message for - [SiteSearchEngineService.FetchSitemaps][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.FetchSitemaps] + `SiteSearchEngineService.FetchSitemaps + `__ method. parent (str): Required. Parent resource name of the - [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine``. @@ -2054,8 +2103,9 @@ def sample_fetch_sitemaps(): Returns: google.cloud.discoveryengine_v1beta.types.FetchSitemapsResponse: Response message for - [SiteSearchEngineService.FetchSitemaps][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.FetchSitemaps] - method. + `SiteSearchEngineService.FetchSitemaps + `__ + method. """ # Create or coerce a protobuf request object. @@ -2150,7 +2200,8 @@ def sample_enable_advanced_site_search(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.EnableAdvancedSiteSearchRequest, dict]): The request object. Request message for - [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.EnableAdvancedSiteSearch] + `SiteSearchEngineService.EnableAdvancedSiteSearch + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2162,11 +2213,15 @@ def sample_enable_advanced_site_search(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.EnableAdvancedSiteSearchResponse` Response message for - [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.EnableAdvancedSiteSearch] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.EnableAdvancedSiteSearchResponse` + Response message for + `SiteSearchEngineService.EnableAdvancedSiteSearch + `__ + method. """ # Create or coerce a protobuf request object. @@ -2261,7 +2316,8 @@ def sample_disable_advanced_site_search(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.DisableAdvancedSiteSearchRequest, dict]): The request object. Request message for - [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DisableAdvancedSiteSearch] + `SiteSearchEngineService.DisableAdvancedSiteSearch + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2273,11 +2329,15 @@ def sample_disable_advanced_site_search(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.DisableAdvancedSiteSearchResponse` Response message for - [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DisableAdvancedSiteSearch] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.DisableAdvancedSiteSearchResponse` + Response message for + `SiteSearchEngineService.DisableAdvancedSiteSearch + `__ + method. """ # Create or coerce a protobuf request object. @@ -2372,7 +2432,8 @@ def sample_recrawl_uris(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.RecrawlUrisRequest, dict]): The request object. Request message for - [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.RecrawlUris] + `SiteSearchEngineService.RecrawlUris + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2384,11 +2445,15 @@ def sample_recrawl_uris(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.RecrawlUrisResponse` Response message for - [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.RecrawlUris] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.RecrawlUrisResponse` + Response message for + `SiteSearchEngineService.RecrawlUris + `__ + method. """ # Create or coerce a protobuf request object. @@ -2478,7 +2543,8 @@ def sample_batch_verify_target_sites(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.BatchVerifyTargetSitesRequest, dict]): The request object. Request message for - [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchVerifyTargetSites] + `SiteSearchEngineService.BatchVerifyTargetSites + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2490,11 +2556,15 @@ def sample_batch_verify_target_sites(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.BatchVerifyTargetSitesResponse` Response message for - [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchVerifyTargetSites] - method. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.BatchVerifyTargetSitesResponse` + Response message for + `SiteSearchEngineService.BatchVerifyTargetSites + `__ + method. """ # Create or coerce a protobuf request object. @@ -2549,9 +2619,10 @@ def fetch_domain_verification_status( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.FetchDomainVerificationStatusPager: - r"""Returns list of target sites with its domain verification - status. This method can only be called under data store with - BASIC_SITE_SEARCH state at the moment. + r"""Returns list of target sites with its domain + verification status. This method can only be called + under data store with BASIC_SITE_SEARCH state at the + moment. .. code-block:: python @@ -2583,7 +2654,8 @@ def sample_fetch_domain_verification_status(): Args: request (Union[google.cloud.discoveryengine_v1beta.types.FetchDomainVerificationStatusRequest, dict]): The request object. Request message for - [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.FetchDomainVerificationStatus] + `SiteSearchEngineService.FetchDomainVerificationStatus + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2596,11 +2668,13 @@ def sample_fetch_domain_verification_status(): Returns: google.cloud.discoveryengine_v1beta.services.site_search_engine_service.pagers.FetchDomainVerificationStatusPager: Response message for - [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.FetchDomainVerificationStatus] - method. + `SiteSearchEngineService.FetchDomainVerificationStatus + `__ + method. - Iterating over this object will yield results and - resolve additional pages automatically. + Iterating over this object will yield + results and resolve additional pages + automatically. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/site_search_engine_service/transports/grpc.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/site_search_engine_service/transports/grpc.py index 529aa4ed06cf..2e6a195f3d1e 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/site_search_engine_service/transports/grpc.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/site_search_engine_service/transports/grpc.py @@ -353,7 +353,8 @@ def get_site_search_engine( r"""Return a callable for the get site search engine method over gRPC. Gets the - [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine]. + `SiteSearchEngine + `__. Returns: Callable[[~.GetSiteSearchEngineRequest], @@ -381,8 +382,8 @@ def create_target_site( ]: r"""Return a callable for the create target site method over gRPC. - Creates a - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]. + Creates a `TargetSite + `__. Returns: Callable[[~.CreateTargetSiteRequest], @@ -411,9 +412,9 @@ def batch_create_target_sites( ]: r"""Return a callable for the batch create target sites method over gRPC. - Creates - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] in - a batch. + Creates `TargetSite + `__ in a + batch. Returns: Callable[[~.BatchCreateTargetSitesRequest], @@ -441,8 +442,8 @@ def get_target_site( ]: r"""Return a callable for the get target site method over gRPC. - Gets a - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]. + Gets a `TargetSite + `__. Returns: Callable[[~.GetTargetSiteRequest], @@ -470,8 +471,8 @@ def update_target_site( ]: r"""Return a callable for the update target site method over gRPC. - Updates a - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]. + Updates a `TargetSite + `__. Returns: Callable[[~.UpdateTargetSiteRequest], @@ -499,8 +500,8 @@ def delete_target_site( ]: r"""Return a callable for the delete target site method over gRPC. - Deletes a - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]. + Deletes a `TargetSite + `__. Returns: Callable[[~.DeleteTargetSiteRequest], @@ -530,7 +531,8 @@ def list_target_sites( r"""Return a callable for the list target sites method over gRPC. Gets a list of - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s. + `TargetSite + `__s. Returns: Callable[[~.ListTargetSitesRequest], @@ -558,8 +560,8 @@ def create_sitemap( ]: r"""Return a callable for the create sitemap method over gRPC. - Creates a - [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap]. + Creates a `Sitemap + `__. Returns: Callable[[~.CreateSitemapRequest], @@ -587,8 +589,8 @@ def delete_sitemap( ]: r"""Return a callable for the delete sitemap method over gRPC. - Deletes a - [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap]. + Deletes a `Sitemap + `__. Returns: Callable[[~.DeleteSitemapRequest], @@ -617,8 +619,10 @@ def fetch_sitemaps( ]: r"""Return a callable for the fetch sitemaps method over gRPC. - Fetch [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap]s in - a [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + Fetch `Sitemap + `__s in a + `DataStore + `__. Returns: Callable[[~.FetchSitemapsRequest], @@ -771,9 +775,10 @@ def fetch_domain_verification_status( r"""Return a callable for the fetch domain verification status method over gRPC. - Returns list of target sites with its domain verification - status. This method can only be called under data store with - BASIC_SITE_SEARCH state at the moment. + Returns list of target sites with its domain + verification status. This method can only be called + under data store with BASIC_SITE_SEARCH state at the + moment. Returns: Callable[[~.FetchDomainVerificationStatusRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/site_search_engine_service/transports/grpc_asyncio.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/site_search_engine_service/transports/grpc_asyncio.py index 3416e87016f7..ce7eea7a2ec5 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/site_search_engine_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/site_search_engine_service/transports/grpc_asyncio.py @@ -361,7 +361,8 @@ def get_site_search_engine( r"""Return a callable for the get site search engine method over gRPC. Gets the - [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine]. + `SiteSearchEngine + `__. Returns: Callable[[~.GetSiteSearchEngineRequest], @@ -390,8 +391,8 @@ def create_target_site( ]: r"""Return a callable for the create target site method over gRPC. - Creates a - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]. + Creates a `TargetSite + `__. Returns: Callable[[~.CreateTargetSiteRequest], @@ -420,9 +421,9 @@ def batch_create_target_sites( ]: r"""Return a callable for the batch create target sites method over gRPC. - Creates - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] in - a batch. + Creates `TargetSite + `__ in a + batch. Returns: Callable[[~.BatchCreateTargetSitesRequest], @@ -451,8 +452,8 @@ def get_target_site( ]: r"""Return a callable for the get target site method over gRPC. - Gets a - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]. + Gets a `TargetSite + `__. Returns: Callable[[~.GetTargetSiteRequest], @@ -481,8 +482,8 @@ def update_target_site( ]: r"""Return a callable for the update target site method over gRPC. - Updates a - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]. + Updates a `TargetSite + `__. Returns: Callable[[~.UpdateTargetSiteRequest], @@ -511,8 +512,8 @@ def delete_target_site( ]: r"""Return a callable for the delete target site method over gRPC. - Deletes a - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]. + Deletes a `TargetSite + `__. Returns: Callable[[~.DeleteTargetSiteRequest], @@ -542,7 +543,8 @@ def list_target_sites( r"""Return a callable for the list target sites method over gRPC. Gets a list of - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s. + `TargetSite + `__s. Returns: Callable[[~.ListTargetSitesRequest], @@ -571,8 +573,8 @@ def create_sitemap( ]: r"""Return a callable for the create sitemap method over gRPC. - Creates a - [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap]. + Creates a `Sitemap + `__. Returns: Callable[[~.CreateSitemapRequest], @@ -601,8 +603,8 @@ def delete_sitemap( ]: r"""Return a callable for the delete sitemap method over gRPC. - Deletes a - [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap]. + Deletes a `Sitemap + `__. Returns: Callable[[~.DeleteSitemapRequest], @@ -631,8 +633,10 @@ def fetch_sitemaps( ]: r"""Return a callable for the fetch sitemaps method over gRPC. - Fetch [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap]s in - a [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + Fetch `Sitemap + `__s in a + `DataStore + `__. Returns: Callable[[~.FetchSitemapsRequest], @@ -786,9 +790,10 @@ def fetch_domain_verification_status( r"""Return a callable for the fetch domain verification status method over gRPC. - Returns list of target sites with its domain verification - status. This method can only be called under data store with - BASIC_SITE_SEARCH state at the moment. + Returns list of target sites with its domain + verification status. This method can only be called + under data store with BASIC_SITE_SEARCH state at the + moment. Returns: Callable[[~.FetchDomainVerificationStatusRequest], diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/site_search_engine_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/site_search_engine_service/transports/rest.py index cc9775658ae3..36aa8c1f65a3 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/site_search_engine_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/site_search_engine_service/transports/rest.py @@ -1318,7 +1318,8 @@ def __call__( Args: request (~.site_search_engine_service.BatchCreateTargetSitesRequest): The request object. Request message for - [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchCreateTargetSites] + `SiteSearchEngineService.BatchCreateTargetSites + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1474,7 +1475,8 @@ def __call__( Args: request (~.site_search_engine_service.BatchVerifyTargetSitesRequest): The request object. Request message for - [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchVerifyTargetSites] + `SiteSearchEngineService.BatchVerifyTargetSites + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1630,7 +1632,8 @@ def __call__( Args: request (~.site_search_engine_service.CreateSitemapRequest): The request object. Request message for - [SiteSearchEngineService.CreateSitemap][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.CreateSitemap] + `SiteSearchEngineService.CreateSitemap + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1786,7 +1789,8 @@ def __call__( Args: request (~.site_search_engine_service.CreateTargetSiteRequest): The request object. Request message for - [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.CreateTargetSite] + `SiteSearchEngineService.CreateTargetSite + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -1943,7 +1947,8 @@ def __call__( Args: request (~.site_search_engine_service.DeleteSitemapRequest): The request object. Request message for - [SiteSearchEngineService.DeleteSitemap][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DeleteSitemap] + `SiteSearchEngineService.DeleteSitemap + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2093,7 +2098,8 @@ def __call__( Args: request (~.site_search_engine_service.DeleteTargetSiteRequest): The request object. Request message for - [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DeleteTargetSite] + `SiteSearchEngineService.DeleteTargetSite + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2249,7 +2255,8 @@ def __call__( Args: request (~.site_search_engine_service.DisableAdvancedSiteSearchRequest): The request object. Request message for - [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DisableAdvancedSiteSearch] + `SiteSearchEngineService.DisableAdvancedSiteSearch + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2406,7 +2413,8 @@ def __call__( Args: request (~.site_search_engine_service.EnableAdvancedSiteSearchRequest): The request object. Request message for - [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.EnableAdvancedSiteSearch] + `SiteSearchEngineService.EnableAdvancedSiteSearch + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2564,7 +2572,8 @@ def __call__( Args: request (~.site_search_engine_service.FetchDomainVerificationStatusRequest): The request object. Request message for - [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.FetchDomainVerificationStatus] + `SiteSearchEngineService.FetchDomainVerificationStatus + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2577,7 +2586,8 @@ def __call__( Returns: ~.site_search_engine_service.FetchDomainVerificationStatusResponse: Response message for - [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.FetchDomainVerificationStatus] + `SiteSearchEngineService.FetchDomainVerificationStatus + `__ method. """ @@ -2725,7 +2735,8 @@ def __call__( Args: request (~.site_search_engine_service.FetchSitemapsRequest): The request object. Request message for - [SiteSearchEngineService.FetchSitemaps][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.FetchSitemaps] + `SiteSearchEngineService.FetchSitemaps + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -2738,7 +2749,8 @@ def __call__( Returns: ~.site_search_engine_service.FetchSitemapsResponse: Response message for - [SiteSearchEngineService.FetchSitemaps][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.FetchSitemaps] + `SiteSearchEngineService.FetchSitemaps + `__ method. """ @@ -2881,7 +2893,8 @@ def __call__( Args: request (~.site_search_engine_service.GetSiteSearchEngineRequest): The request object. Request message for - [SiteSearchEngineService.GetSiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.GetSiteSearchEngine] + `SiteSearchEngineService.GetSiteSearchEngine + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -3038,7 +3051,8 @@ def __call__( Args: request (~.site_search_engine_service.GetTargetSiteRequest): The request object. Request message for - [SiteSearchEngineService.GetTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.GetTargetSite] + `SiteSearchEngineService.GetTargetSite + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -3189,7 +3203,8 @@ def __call__( Args: request (~.site_search_engine_service.ListTargetSitesRequest): The request object. Request message for - [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.ListTargetSites] + `SiteSearchEngineService.ListTargetSites + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -3202,7 +3217,8 @@ def __call__( Returns: ~.site_search_engine_service.ListTargetSitesResponse: Response message for - [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.ListTargetSites] + `SiteSearchEngineService.ListTargetSites + `__ method. """ @@ -3348,7 +3364,8 @@ def __call__( Args: request (~.site_search_engine_service.RecrawlUrisRequest): The request object. Request message for - [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.RecrawlUris] + `SiteSearchEngineService.RecrawlUris + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. @@ -3502,7 +3519,8 @@ def __call__( Args: request (~.site_search_engine_service.UpdateTargetSiteRequest): The request object. Request message for - [SiteSearchEngineService.UpdateTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.UpdateTargetSite] + `SiteSearchEngineService.UpdateTargetSite + `__ method. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/user_event_service/async_client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/user_event_service/async_client.py index 44ca653a5bfc..325264cf77c8 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/user_event_service/async_client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/user_event_service/async_client.py @@ -455,52 +455,61 @@ async def sample_collect_user_event(): Returns: google.api.httpbody_pb2.HttpBody: - Message that represents an arbitrary HTTP body. It should only be used for - payload formats that can't be represented as JSON, - such as raw binary or an HTML page. - - This message can be used both in streaming and - non-streaming API methods in the request as well as - the response. - - It can be used as a top-level request field, which is - convenient if one wants to extract parameters from - either the URL or HTTP template into the request - fields and also want access to the raw HTTP body. - - Example: - - message GetResourceRequest { - // A unique request id. string request_id = 1; - - // The raw HTTP body is bound to this field. - google.api.HttpBody http_body = 2; - - } - - service ResourceService { - rpc GetResource(GetResourceRequest) - returns (google.api.HttpBody); - - rpc UpdateResource(google.api.HttpBody) - returns (google.protobuf.Empty); - - } - - Example with streaming methods: - - service CaldavService { - rpc GetCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); - - rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); - - } - - Use of this type only changes how the request and - response bodies are handled, all other features will - continue to work unchanged. + Message that represents an arbitrary + HTTP body. It should only be used for + payload formats that can't be + represented as JSON, such as raw binary + or an HTML page. + + This message can be used both in + streaming and non-streaming API methods + in the request as well as the response. + + It can be used as a top-level request + field, which is convenient if one wants + to extract parameters from either the + URL or HTTP template into the request + fields and also want access to the raw + HTTP body. + + Example: + + message GetResourceRequest { + // A unique request id. + string request_id = 1; + + // The raw HTTP body is bound to + this field. google.api.HttpBody + http_body = 2; + + } + + service ResourceService { + rpc + GetResource(GetResourceRequest) + returns (google.api.HttpBody); + rpc + UpdateResource(google.api.HttpBody) + returns (google.protobuf.Empty); + + } + + Example with streaming methods: + + service CaldavService { + rpc GetCalendar(stream + google.api.HttpBody) returns + (stream google.api.HttpBody); rpc + UpdateCalendar(stream + google.api.HttpBody) returns + (stream google.api.HttpBody); + + } + + Use of this type only changes how the + request and response bodies are handled, + all other features will continue to work + unchanged. """ # Create or coerce a protobuf request object. @@ -594,11 +603,17 @@ async def sample_purge_user_events(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.PurgeUserEventsResponse` Response of the PurgeUserEventsRequest. If the long running operation is - successfully done, then this message is returned by - the google.longrunning.Operations.response field. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.PurgeUserEventsResponse` + Response of the PurgeUserEventsRequest. + If the long running operation is + successfully done, then this message is + returned by the + google.longrunning.Operations.response + field. """ # Create or coerce a protobuf request object. @@ -707,13 +722,17 @@ async def sample_import_user_events(): Returns: google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.ImportUserEventsResponse` Response of the ImportUserEventsRequest. If the long running - operation was successful, then this message is - returned by the - google.longrunning.Operations.response field if the - operation was successful. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.ImportUserEventsResponse` + Response of the ImportUserEventsRequest. + If the long running operation was + successful, then this message is + returned by the + google.longrunning.Operations.response + field if the operation was successful. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/user_event_service/client.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/user_event_service/client.py index 6b36cdf5a50c..bcad3cf5aa95 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/user_event_service/client.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/user_event_service/client.py @@ -923,52 +923,61 @@ def sample_collect_user_event(): Returns: google.api.httpbody_pb2.HttpBody: - Message that represents an arbitrary HTTP body. It should only be used for - payload formats that can't be represented as JSON, - such as raw binary or an HTML page. + Message that represents an arbitrary + HTTP body. It should only be used for + payload formats that can't be + represented as JSON, such as raw binary + or an HTML page. - This message can be used both in streaming and - non-streaming API methods in the request as well as - the response. + This message can be used both in + streaming and non-streaming API methods + in the request as well as the response. - It can be used as a top-level request field, which is - convenient if one wants to extract parameters from - either the URL or HTTP template into the request - fields and also want access to the raw HTTP body. + It can be used as a top-level request + field, which is convenient if one wants + to extract parameters from either the + URL or HTTP template into the request + fields and also want access to the raw + HTTP body. - Example: + Example: - message GetResourceRequest { - // A unique request id. string request_id = 1; + message GetResourceRequest { + // A unique request id. + string request_id = 1; - // The raw HTTP body is bound to this field. - google.api.HttpBody http_body = 2; + // The raw HTTP body is bound to + this field. google.api.HttpBody + http_body = 2; - } - - service ResourceService { - rpc GetResource(GetResourceRequest) - returns (google.api.HttpBody); - - rpc UpdateResource(google.api.HttpBody) - returns (google.protobuf.Empty); + } - } + service ResourceService { + rpc + GetResource(GetResourceRequest) + returns (google.api.HttpBody); + rpc + UpdateResource(google.api.HttpBody) + returns (google.protobuf.Empty); - Example with streaming methods: + } - service CaldavService { - rpc GetCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); + Example with streaming methods: - rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); + service CaldavService { + rpc GetCalendar(stream + google.api.HttpBody) returns + (stream google.api.HttpBody); rpc + UpdateCalendar(stream + google.api.HttpBody) returns + (stream google.api.HttpBody); - } + } - Use of this type only changes how the request and - response bodies are handled, all other features will - continue to work unchanged. + Use of this type only changes how the + request and response bodies are handled, + all other features will continue to work + unchanged. """ # Create or coerce a protobuf request object. @@ -1060,11 +1069,17 @@ def sample_purge_user_events(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.PurgeUserEventsResponse` Response of the PurgeUserEventsRequest. If the long running operation is - successfully done, then this message is returned by - the google.longrunning.Operations.response field. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.PurgeUserEventsResponse` + Response of the PurgeUserEventsRequest. + If the long running operation is + successfully done, then this message is + returned by the + google.longrunning.Operations.response + field. """ # Create or coerce a protobuf request object. @@ -1171,13 +1186,17 @@ def sample_import_user_events(): Returns: google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.discoveryengine_v1beta.types.ImportUserEventsResponse` Response of the ImportUserEventsRequest. If the long running - operation was successful, then this message is - returned by the - google.longrunning.Operations.response field if the - operation was successful. + An object representing a long-running + operation. + The result type for the operation will + be + :class:`google.cloud.discoveryengine_v1beta.types.ImportUserEventsResponse` + Response of the ImportUserEventsRequest. + If the long running operation was + successful, then this message is + returned by the + google.longrunning.Operations.response + field if the operation was successful. """ # Create or coerce a protobuf request object. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/user_event_service/transports/rest.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/user_event_service/transports/rest.py index e95583803a34..4f98af23b3e6 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/user_event_service/transports/rest.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/services/user_event_service/transports/rest.py @@ -692,55 +692,61 @@ def __call__( Returns: ~.httpbody_pb2.HttpBody: - Message that represents an arbitrary HTTP body. It - should only be used for payload formats that can't be - represented as JSON, such as raw binary or an HTML page. - - This message can be used both in streaming and - non-streaming API methods in the request as well as the - response. - - It can be used as a top-level request field, which is - convenient if one wants to extract parameters from - either the URL or HTTP template into the request fields - and also want access to the raw HTTP body. + Message that represents an arbitrary + HTTP body. It should only be used for + payload formats that can't be + represented as JSON, such as raw binary + or an HTML page. + + This message can be used both in + streaming and non-streaming API methods + in the request as well as the response. + + It can be used as a top-level request + field, which is convenient if one wants + to extract parameters from either the + URL or HTTP template into the request + fields and also want access to the raw + HTTP body. Example: - :: - message GetResourceRequest { // A unique request id. string request_id = 1; - // The raw HTTP body is bound to this field. - google.api.HttpBody http_body = 2; + // The raw HTTP body is bound to + this field. google.api.HttpBody + http_body = 2; } service ResourceService { - rpc GetResource(GetResourceRequest) + rpc + GetResource(GetResourceRequest) returns (google.api.HttpBody); - rpc UpdateResource(google.api.HttpBody) - returns (google.protobuf.Empty); + rpc + UpdateResource(google.api.HttpBody) + returns (google.protobuf.Empty); } Example with streaming methods: - :: - service CaldavService { - rpc GetCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); - rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); + rpc GetCalendar(stream + google.api.HttpBody) returns + (stream google.api.HttpBody); rpc + UpdateCalendar(stream + google.api.HttpBody) returns + (stream google.api.HttpBody); } - Use of this type only changes how the request and - response bodies are handled, all other features will - continue to work unchanged. + Use of this type only changes how the + request and response bodies are handled, + all other features will continue to work + unchanged. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/answer.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/answer.py index b4a969b6f684..163b33de1f48 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/answer.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/answer.py @@ -493,11 +493,11 @@ class SearchResult(proto.Message): title (str): Title. snippet_info (MutableSequence[google.cloud.discoveryengine_v1beta.types.Answer.Step.Action.Observation.SearchResult.SnippetInfo]): - If citation_type is DOCUMENT_LEVEL_CITATION, populate - document level snippets. + If citation_type is DOCUMENT_LEVEL_CITATION, + populate document level snippets. chunk_info (MutableSequence[google.cloud.discoveryengine_v1beta.types.Answer.Step.Action.Observation.SearchResult.ChunkInfo]): - If citation_type is CHUNK_LEVEL_CITATION and chunk mode is - on, populate chunk info. + If citation_type is CHUNK_LEVEL_CITATION and + chunk mode is on, populate chunk info. struct_data (google.protobuf.struct_pb2.Struct): Data representation. The structured JSON data for the document. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/chunk.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/chunk.py index 495c1b461a84..a295ec95bdab 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/chunk.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/chunk.py @@ -37,20 +37,24 @@ class Chunk(proto.Message): Attributes: name (str): - The full resource name of the chunk. Format: + The full resource name of the chunk. + Format: + ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}``. - This field must be a UTF-8 encoded string with a length - limit of 1024 characters. + This field must be a UTF-8 encoded string with a + length limit of 1024 characters. id (str): Unique chunk ID of the current chunk. content (str): Content is a string from a document (parsed content). relevance_score (float): - Output only. Represents the relevance score based on - similarity. Higher score indicates higher chunk relevance. - The score is in range [-1.0, 1.0]. Only populated on + Output only. Represents the relevance score + based on similarity. Higher score indicates + higher chunk relevance. The score is in range + [-1.0, 1.0]. + Only populated on [SearchService.SearchResponse][]. This field is a member of `oneof`_ ``_relevance_score``. @@ -58,8 +62,9 @@ class Chunk(proto.Message): Metadata of the document from the current chunk. derived_struct_data (google.protobuf.struct_pb2.Struct): - Output only. This field is OUTPUT_ONLY. It contains derived - data that are not in the original input document. + Output only. This field is OUTPUT_ONLY. + It contains derived data that are not in the + original input document. page_span (google.cloud.discoveryengine_v1beta.types.Chunk.PageSpan): Page span of the chunk. chunk_metadata (google.cloud.discoveryengine_v1beta.types.Chunk.ChunkMetadata): @@ -76,10 +81,11 @@ class DocumentMetadata(proto.Message): title (str): Title of the document. struct_data (google.protobuf.struct_pb2.Struct): - Data representation. The structured JSON data for the - document. It should conform to the registered - [Schema][google.cloud.discoveryengine.v1beta.Schema] or an - ``INVALID_ARGUMENT`` error is thrown. + Data representation. + The structured JSON data for the document. It + should conform to the registered `Schema + `__ + or an ``INVALID_ARGUMENT`` error is thrown. """ uri: str = proto.Field( @@ -117,23 +123,28 @@ class PageSpan(proto.Message): class ChunkMetadata(proto.Message): r"""Metadata of the current chunk. This field is only populated on - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] + `SearchService.Search + `__ API. Attributes: previous_chunks (MutableSequence[google.cloud.discoveryengine_v1beta.types.Chunk]): - The previous chunks of the current chunk. The number is - controlled by - [SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks]. + The previous chunks of the current chunk. The + number is controlled by + `SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks + `__. This field is only populated on - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] + `SearchService.Search + `__ API. next_chunks (MutableSequence[google.cloud.discoveryengine_v1beta.types.Chunk]): - The next chunks of the current chunk. The number is - controlled by - [SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks]. + The next chunks of the current chunk. The number + is controlled by + `SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks + `__. This field is only populated on - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] + `SearchService.Search + `__ API. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/common.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/common.py index 77a3ec8f1d3f..209fa4c13a3e 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/common.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/common.py @@ -38,7 +38,7 @@ class IndustryVertical(proto.Enum): r"""The industry vertical associated with the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + `DataStore `__. Values: INDUSTRY_VERTICAL_UNSPECIFIED (0): @@ -71,10 +71,10 @@ class SolutionType(proto.Enum): Used for use cases related to the Generative AI agent. SOLUTION_TYPE_GENERATIVE_CHAT (4): - Used for use cases related to the Generative Chat agent. - It's used for Generative chat engine only, the associated - data stores must enrolled with ``SOLUTION_TYPE_CHAT`` - solution. + Used for use cases related to the Generative + Chat agent. It's used for Generative chat engine + only, the associated data stores must enrolled + with ``SOLUTION_TYPE_CHAT`` solution. """ SOLUTION_TYPE_UNSPECIFIED = 0 SOLUTION_TYPE_RECOMMENDATION = 1 @@ -84,19 +84,22 @@ class SolutionType(proto.Enum): class SearchUseCase(proto.Enum): - r"""Defines a further subdivision of ``SolutionType``. Specifically - applies to - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH]. + r"""Defines a further subdivision of ``SolutionType``. + Specifically applies to + `SOLUTION_TYPE_SEARCH + `__. Values: SEARCH_USE_CASE_UNSPECIFIED (0): Value used when unset. Will not occur in CSS. SEARCH_USE_CASE_SEARCH (1): - Search use case. Expects the traffic has a non-empty - [query][google.cloud.discoveryengine.v1beta.SearchRequest.query]. + Search use case. Expects the traffic has a + non-empty `query + `__. SEARCH_USE_CASE_BROWSE (2): - Browse use case. Expects the traffic has an empty - [query][google.cloud.discoveryengine.v1beta.SearchRequest.query]. + Browse use case. Expects the traffic has an + empty `query + `__. """ SEARCH_USE_CASE_UNSPECIFIED = 0 SEARCH_USE_CASE_SEARCH = 1 @@ -189,32 +192,39 @@ class Interval(proto.Message): class CustomAttribute(proto.Message): r"""A custom attribute that is not explicitly modeled in a resource, - e.g. [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent]. + e.g. `UserEvent + `__. Attributes: text (MutableSequence[str]): - The textual values of this custom attribute. For example, - ``["yellow", "green"]`` when the key is "color". + The textual values of this custom attribute. For + example, ``["yellow", "green"]`` when the key is + "color". Empty string is not allowed. Otherwise, an ``INVALID_ARGUMENT`` error is returned. Exactly one of - [CustomAttribute.text][google.cloud.discoveryengine.v1beta.CustomAttribute.text] + `CustomAttribute.text + `__ or - [CustomAttribute.numbers][google.cloud.discoveryengine.v1beta.CustomAttribute.numbers] - should be set. Otherwise, an ``INVALID_ARGUMENT`` error is - returned. + `CustomAttribute.numbers + `__ + should be set. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. numbers (MutableSequence[float]): - The numerical values of this custom attribute. For example, - ``[2.3, 15.4]`` when the key is "lengths_cm". + The numerical values of this custom attribute. + For example, ``[2.3, 15.4]`` when the key is + "lengths_cm". Exactly one of - [CustomAttribute.text][google.cloud.discoveryengine.v1beta.CustomAttribute.text] + `CustomAttribute.text + `__ or - [CustomAttribute.numbers][google.cloud.discoveryengine.v1beta.CustomAttribute.numbers] - should be set. Otherwise, an ``INVALID_ARGUMENT`` error is - returned. + `CustomAttribute.numbers + `__ + should be set. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. """ text: MutableSequence[str] = proto.RepeatedField( @@ -232,31 +242,35 @@ class UserInfo(proto.Message): Attributes: user_id (str): - Highly recommended for logged-in users. Unique identifier - for logged-in user, such as a user name. Don't set for - anonymous users. + Highly recommended for logged-in users. Unique + identifier for logged-in user, such as a user + name. Don't set for anonymous users. Always use a hashed value for this ID. - Don't set the field to the same fixed ID for different - users. This mixes the event history of those users together, - which results in degraded model quality. + Don't set the field to the same fixed ID for + different users. This mixes the event history of + those users together, which results in degraded + model quality. - The field must be a UTF-8 encoded string with a length limit - of 128 characters. Otherwise, an ``INVALID_ARGUMENT`` error - is returned. + The field must be a UTF-8 encoded string with a + length limit of 128 characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. user_agent (str): User agent as included in the HTTP header. - The field must be a UTF-8 encoded string with a length limit - of 1,000 characters. Otherwise, an ``INVALID_ARGUMENT`` - error is returned. + The field must be a UTF-8 encoded string with a + length limit of 1,000 characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. - This should not be set when using the client side event - reporting with GTM or JavaScript tag in - [UserEventService.CollectUserEvent][google.cloud.discoveryengine.v1beta.UserEventService.CollectUserEvent] + This should not be set when using the client + side event reporting with GTM or JavaScript tag + in + `UserEventService.CollectUserEvent + `__ or if - [UserEvent.direct_user_request][google.cloud.discoveryengine.v1beta.UserEvent.direct_user_request] + `UserEvent.direct_user_request + `__ is set. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/completion.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/completion.py index 0a8b684bf6a3..88fa88fd0f41 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/completion.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/completion.py @@ -49,10 +49,11 @@ class MatchOperator(proto.Enum): MATCH_OPERATOR_UNSPECIFIED (0): Default value. Should not be used EXACT_MATCH (1): - If the suggestion is an exact match to the block_phrase, - then block it. + If the suggestion is an exact match to the + block_phrase, then block it. CONTAINS (2): - If the suggestion contains the block_phrase, then block it. + If the suggestion contains the block_phrase, + then block it. """ MATCH_OPERATOR_UNSPECIFIED = 0 EXACT_MATCH = 1 diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/completion_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/completion_service.py index e577c83b84f4..84dee5a8ffe7 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/completion_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/completion_service.py @@ -36,58 +36,65 @@ class CompleteQueryRequest(proto.Message): r"""Request message for - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] + `CompletionService.CompleteQuery + `__ method. Attributes: data_store (str): - Required. The parent data store resource name for which the - completion is performed, such as + Required. The parent data store resource name + for which the completion is performed, such as ``projects/*/locations/global/collections/default_collection/dataStores/default_data_store``. query (str): Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. query_model (str): - Specifies the autocomplete data model. This overrides any - model specified in the Configuration > Autocomplete section - of the Cloud console. Currently supported values: - - - ``document`` - Using suggestions generated from - user-imported documents. - - ``search-history`` - Using suggestions generated from the - past history of - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] - API calls. Do not use it when there is no traffic for - Search API. - - ``user-event`` - Using suggestions generated from - user-imported search events. - - ``document-completable`` - Using suggestions taken - directly from user-imported document fields marked as - completable. + Specifies the autocomplete data model. This + overrides any model specified in the + Configuration > Autocomplete section of the + Cloud console. Currently supported values: + + * ``document`` - Using suggestions generated + from user-imported documents. * + ``search-history`` - Using suggestions generated + from the past history of `SearchService.Search + `__ + API calls. Do not use it when there is no + traffic for Search API. + + * ``user-event`` - Using suggestions generated + from user-imported search events. + + * ``document-completable`` - Using suggestions + taken directly from user-imported document + fields marked as completable. Default values: - - ``document`` is the default model for regular dataStores. - - ``search-history`` is the default model for site search - dataStores. + * ``document`` is the default model for regular + dataStores. * ``search-history`` is the default + model for site search dataStores. user_pseudo_id (str): - A unique identifier for tracking visitors. For example, this - could be implemented with an HTTP cookie, which should be - able to uniquely identify a visitor on a single device. This - unique identifier should not change if the visitor logs in - or out of the website. + A unique identifier for tracking visitors. For + example, this could be implemented with an HTTP + cookie, which should be able to uniquely + identify a visitor on a single device. This + unique identifier should not change if the + visitor logs in or out of the website. This field should NOT have a fixed value such as ``unknown_visitor``. This should be the same identifier as - [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id] + `UserEvent.user_pseudo_id + `__ and - [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id]. + `SearchRequest.user_pseudo_id + `__. - The field must be a UTF-8 encoded string with a length limit - of 128 characters. Otherwise, an ``INVALID_ARGUMENT`` error - is returned. + The field must be a UTF-8 encoded string with a + length limit of 128 characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. include_tail_suggestions (bool): Indicates if tail suggestions should be returned if there are no suggestions that match @@ -121,7 +128,8 @@ class CompleteQueryRequest(proto.Message): class CompleteQueryResponse(proto.Message): r"""Response message for - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] + `CompletionService.CompleteQuery + `__ method. Attributes: @@ -130,11 +138,12 @@ class CompleteQueryResponse(proto.Message): result list is ordered and the first result is a top suggestion. tail_match_triggered (bool): - True if the returned suggestions are all tail suggestions. - - For tail matching to be triggered, include_tail_suggestions - in the request must be true and there must be no suggestions - that match the full query. + True if the returned suggestions are all tail + suggestions. + For tail matching to be triggered, + include_tail_suggestions in the request must be + true and there must be no suggestions that match + the full query. """ class QuerySuggestion(proto.Message): @@ -174,73 +183,85 @@ class QuerySuggestion(proto.Message): class AdvancedCompleteQueryRequest(proto.Message): r"""Request message for - [CompletionService.AdvancedCompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.AdvancedCompleteQuery] - method. . + `CompletionService.AdvancedCompleteQuery + `__ + method. + . Attributes: completion_config (str): - Required. The completion_config of the parent dataStore or - engine resource name for which the completion is performed, - such as + Required. The completion_config of the parent + dataStore or engine resource name for which the + completion is performed, such as ``projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig`` ``projects/*/locations/global/collections/default_collection/engines/*/completionConfig``. query (str): - Required. The typeahead input used to fetch suggestions. - Maximum length is 128 characters. - - The query can not be empty for most of the suggestion types. - If it is empty, an ``INVALID_ARGUMENT`` error is returned. - The exception is when the suggestion_types contains only the - type ``RECENT_SEARCH``, the query can be an empty string. - The is called "zero prefix" feature, which returns user's - recently searched queries given the empty query. + Required. The typeahead input used to fetch + suggestions. Maximum length is 128 characters. + + The query can not be empty for most of the + suggestion types. If it is empty, an + ``INVALID_ARGUMENT`` error is returned. The + exception is when the suggestion_types contains + only the type ``RECENT_SEARCH``, the query can + be an empty string. The is called "zero prefix" + feature, which returns user's recently searched + queries given the empty query. query_model (str): - Specifies the autocomplete data model. This overrides any - model specified in the Configuration > Autocomplete section - of the Cloud console. Currently supported values: - - - ``document`` - Using suggestions generated from - user-imported documents. - - ``search-history`` - Using suggestions generated from the - past history of - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] - API calls. Do not use it when there is no traffic for - Search API. - - ``user-event`` - Using suggestions generated from - user-imported search events. - - ``document-completable`` - Using suggestions taken - directly from user-imported document fields marked as - completable. + Specifies the autocomplete data model. This + overrides any model specified in the + Configuration > Autocomplete section of the + Cloud console. Currently supported values: + + * ``document`` - Using suggestions generated + from user-imported documents. * + ``search-history`` - Using suggestions generated + from the past history of `SearchService.Search + `__ + API calls. Do not use it when there is no + traffic for Search API. + + * ``user-event`` - Using suggestions generated + from user-imported search events. + + * ``document-completable`` - Using suggestions + taken directly from user-imported document + fields marked as completable. Default values: - - ``document`` is the default model for regular dataStores. - - ``search-history`` is the default model for site search - dataStores. + * ``document`` is the default model for regular + dataStores. * ``search-history`` is the default + model for site search dataStores. user_pseudo_id (str): - A unique identifier for tracking visitors. For example, this - could be implemented with an HTTP cookie, which should be - able to uniquely identify a visitor on a single device. This - unique identifier should not change if the visitor logs in - or out of the website. + A unique identifier for tracking visitors. For + example, this could be implemented with an HTTP + cookie, which should be able to uniquely + identify a visitor on a single device. This + unique identifier should not change if the + visitor logs in or out of the website. This field should NOT have a fixed value such as ``unknown_visitor``. This should be the same identifier as - [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id] + `UserEvent.user_pseudo_id + `__ and - [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id]. + `SearchRequest.user_pseudo_id + `__. - The field must be a UTF-8 encoded string with a length limit - of 128 + The field must be a UTF-8 encoded string with a + length limit of 128 user_info (google.cloud.discoveryengine_v1beta.types.UserInfo): Optional. Information about the end user. - This should be the same identifier information as - [UserEvent.user_info][google.cloud.discoveryengine.v1beta.UserEvent.user_info] + This should be the same identifier information + as `UserEvent.user_info + `__ and - [SearchRequest.user_info][google.cloud.discoveryengine.v1beta.SearchRequest.user_info]. + `SearchRequest.user_info + `__. include_tail_suggestions (bool): Indicates if tail suggestions should be returned if there are no suggestions that match @@ -304,30 +325,35 @@ class ConditionBoostSpec(proto.Message): Attributes: condition (str): - An expression which specifies a boost condition. The syntax - is the same as `filter expression - syntax `__. - Currently, the only supported condition is a list of BCP-47 - lang codes. + An expression which specifies a boost condition. + The syntax is the same as `filter expression + syntax + `__. + Currently, the only supported condition is a + list of BCP-47 lang codes. Example: - - To boost suggestions in languages ``en`` or ``fr``: - ``(lang_code: ANY("en", "fr"))`` + * To boost suggestions in languages ``en`` or + ``fr``: + + ``(lang_code: ANY("en", "fr"))`` boost (float): - Strength of the boost, which should be in [-1, 1]. Negative - boost means demotion. Default is 0.0. + Strength of the boost, which should be in [-1, + 1]. Negative boost means demotion. Default is + 0.0. - Setting to 1.0 gives the suggestions a big promotion. - However, it does not necessarily mean that the top result - will be a boosted suggestion. + Setting to 1.0 gives the suggestions a big + promotion. However, it does not necessarily mean + that the top result will be a boosted + suggestion. - Setting to -1.0 gives the suggestions a big demotion. - However, other suggestions that are relevant might still be - shown. + Setting to -1.0 gives the suggestions a big + demotion. However, other suggestions that are + relevant might still be shown. - Setting to 0.0 means no boost applied. The boosting - condition is ignored. + Setting to 0.0 means no boost applied. The + boosting condition is ignored. """ condition: str = proto.Field( @@ -386,7 +412,8 @@ class ConditionBoostSpec(proto.Message): class AdvancedCompleteQueryResponse(proto.Message): r"""Response message for - [CompletionService.AdvancedCompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.AdvancedCompleteQuery] + `CompletionService.AdvancedCompleteQuery + `__ method. Attributes: @@ -395,11 +422,12 @@ class AdvancedCompleteQueryResponse(proto.Message): result list is ordered and the first result is a top suggestion. tail_match_triggered (bool): - True if the returned suggestions are all tail suggestions. - - For tail matching to be triggered, include_tail_suggestions - in the request must be true and there must be no suggestions - that match the full query. + True if the returned suggestions are all tail + suggestions. + For tail matching to be triggered, + include_tail_suggestions in the request must be + true and there must be no suggestions that match + the full query. people_suggestions (MutableSequence[google.cloud.discoveryengine_v1beta.types.AdvancedCompleteQueryResponse.PersonSuggestion]): Results of the matched people suggestions. The result list is ordered and the first result @@ -470,7 +498,8 @@ class PersonType(proto.Enum): CLOUD_IDENTITY (1): The suggestion is from a GOOGLE_IDENTITY source. THIRD_PARTY_IDENTITY (2): - The suggestion is from a THIRD_PARTY_IDENTITY source. + The suggestion is from a THIRD_PARTY_IDENTITY + source. """ PERSON_TYPE_UNSPECIFIED = 0 CLOUD_IDENTITY = 1 diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/control.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/control.py index 18f251314407..2414e45714a2 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/control.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/control.py @@ -37,9 +37,11 @@ class Condition(proto.Message): Attributes: query_terms (MutableSequence[google.cloud.discoveryengine_v1beta.types.Condition.QueryTerm]): - Search only A list of terms to match the query on. Cannot be - set when - [Condition.query_regex][google.cloud.discoveryengine.v1beta.Condition.query_regex] + Search only + A list of terms to match the query on. + Cannot be set when + `Condition.query_regex + `__ is set. Maximum of 10 query terms. @@ -48,10 +50,12 @@ class Condition(proto.Message): active. Maximum of 10 time ranges. query_regex (str): - Optional. Query regex to match the whole search query. - Cannot be set when - [Condition.query_terms][google.cloud.discoveryengine.v1beta.Condition.query_terms] - is set. This is currently supporting promotion use case. + Optional. Query regex to match the whole search + query. Cannot be set when + `Condition.query_terms + `__ + is set. This is currently supporting promotion + use case. """ class QueryTerm(proto.Message): @@ -61,9 +65,10 @@ class QueryTerm(proto.Message): value (str): The specific query value to match against - Must be lowercase, must be UTF-8. Can have at most 3 space - separated terms if full_match is true. Cannot be an empty - string. Maximum length of 5000 characters. + Must be lowercase, must be UTF-8. + Can have at most 3 space separated terms if + full_match is true. Cannot be an empty string. + Maximum length of 5000 characters. full_match (bool): Whether the search query needs to exactly match the query term. @@ -121,10 +126,11 @@ class TimeRange(proto.Message): class Control(proto.Message): - r"""Defines a conditioned behavior to employ during serving. Must be - attached to a - [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] - to be considered at serving time. Permitted actions dependent on + r"""Defines a conditioned behavior to employ during serving. + Must be attached to a + `ServingConfig + `__ to be + considered at serving time. Permitted actions dependent on ``SolutionType``. This message has `oneof`_ fields (mutually exclusive fields). @@ -164,21 +170,25 @@ class Control(proto.Message): error is thrown. associated_serving_config_ids (MutableSequence[str]): Output only. List of all - [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] - IDs this control is attached to. May take up to 10 minutes - to update after changes. + `ServingConfig + `__ + IDs this control is attached to. May take up to + 10 minutes to update after changes. solution_type (google.cloud.discoveryengine_v1beta.types.SolutionType): Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. use_cases (MutableSequence[google.cloud.discoveryengine_v1beta.types.SearchUseCase]): - Specifies the use case for the control. Affects what - condition fields can be set. Only applies to - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH]. - Currently only allow one use case per control. Must be set - when solution_type is - [SolutionType.SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH]. + Specifies the use case for the control. + Affects what condition fields can be set. + Only applies to + `SOLUTION_TYPE_SEARCH + `__. + Currently only allow one use case per control. + Must be set when solution_type is + `SolutionType.SOLUTION_TYPE_SEARCH + `__. conditions (MutableSequence[google.cloud.discoveryengine_v1beta.types.Condition]): Determines when the associated action will trigger. @@ -193,8 +203,9 @@ class BoostAction(proto.Message): Attributes: boost (float): - Required. Strength of the boost, which should be in [-1, 1]. - Negative boost means demotion. Default is 0.0 (No-op). + Required. Strength of the boost, which should be + in [-1, 1]. Negative boost means demotion. + Default is 0.0 (No-op). filter (str): Required. Specifies which products to apply the boost to. @@ -205,8 +216,9 @@ class BoostAction(proto.Message): Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. data_store (str): - Required. Specifies which data store's documents can be - boosted by this control. Full data store name e.g. + Required. Specifies which data store's documents + can be boosted by this control. Full data store + name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store """ @@ -238,8 +250,9 @@ class FilterAction(proto.Message): Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. data_store (str): - Required. Specifies which data store's documents can be - filtered by this control. Full data store name e.g. + Required. Specifies which data store's documents + can be filtered by this control. Full data store + name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/control_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/control_service.py index 0f75538cf8ef..5395ef31b8f1 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/control_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/control_service.py @@ -40,18 +40,20 @@ class CreateControlRequest(proto.Message): Attributes: parent (str): - Required. Full resource name of parent data store. Format: + Required. Full resource name of parent data + store. Format: ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`` or ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. control (google.cloud.discoveryengine_v1beta.types.Control): Required. The Control to create. control_id (str): - Required. The ID to use for the Control, which will become - the final component of the Control's resource name. + Required. The ID to use for the Control, which + will become the final component of the Control's + resource name. - This value must be within 1-63 characters. Valid characters - are /[a-z][0-9]-\_/. + This value must be within 1-63 characters. + Valid characters are /`a-z <0-9>`__-_/. """ parent: str = proto.Field( @@ -77,13 +79,17 @@ class UpdateControlRequest(proto.Message): Required. The Control to update. update_mask (google.protobuf.field_mask_pb2.FieldMask): Optional. Indicates which fields in the provided - [Control][google.cloud.discoveryengine.v1beta.Control] to - update. The following are NOT supported: + `Control + `__ + to update. The following are NOT supported: - - [Control.name][google.cloud.discoveryengine.v1beta.Control.name] - - [Control.solution_type][google.cloud.discoveryengine.v1beta.Control.solution_type] + * `Control.name + `__ + * `Control.solution_type + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported fields are + updated. """ control: gcd_control.Control = proto.Field( @@ -103,8 +109,8 @@ class DeleteControlRequest(proto.Message): Attributes: name (str): - Required. The resource name of the Control to delete. - Format: + Required. The resource name of the Control to + delete. Format: ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`` """ @@ -119,7 +125,8 @@ class GetControlRequest(proto.Message): Attributes: name (str): - Required. The resource name of the Control to get. Format: + Required. The resource name of the Control to + get. Format: ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`` """ @@ -144,15 +151,15 @@ class ListControlsRequest(proto.Message): allowed value is 1000. page_token (str): Optional. A page token, received from a previous - ``ListControls`` call. Provide this to retrieve the - subsequent page. + ``ListControls`` call. Provide this to retrieve + the subsequent page. filter (str): - Optional. A filter to apply on the list results. Supported - features: - - - List all the products under the parent branch if - [filter][google.cloud.discoveryengine.v1beta.ListControlsRequest.filter] - is unset. Currently this field is unsupported. + Optional. A filter to apply on the list results. + Supported features: + * List all the products under the parent branch + if `filter + `__ + is unset. Currently this field is unsupported. """ parent: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/conversation.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/conversation.py index 55405fdd47db..386a512b18eb 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/conversation.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/conversation.py @@ -107,7 +107,8 @@ class Reply(proto.Message): Attributes: reply (str): - DEPRECATED: use ``summary`` instead. Text reply. + DEPRECATED: use ``summary`` instead. + Text reply. references (MutableSequence[google.cloud.discoveryengine_v1beta.types.Reply.Reference]): References in the reply. summary (google.cloud.discoveryengine_v1beta.types.SearchResponse.Summary): diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/conversational_search_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/conversational_search_service.py index 17b66604760f..0616e9ad1833 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/conversational_search_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/conversational_search_service.py @@ -51,24 +51,28 @@ class ConverseConversationRequest(proto.Message): r"""Request message for - [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1beta.ConversationalSearchService.ConverseConversation] + `ConversationalSearchService.ConverseConversation + `__ method. Attributes: name (str): - Required. The resource name of the Conversation to get. - Format: + Required. The resource name of the Conversation + to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}``. Use ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-`` - to activate auto session mode, which automatically creates a - new conversation inside a ConverseConversation session. + to activate auto session mode, which + automatically creates a new conversation inside + a ConverseConversation session. query (google.cloud.discoveryengine_v1beta.types.TextInput): Required. Current user input. serving_config (str): - The resource name of the Serving Config to use. Format: + The resource name of the Serving Config to use. + Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`` - If this is not set, the default serving config will be used. + If this is not set, the default serving config + will be used. conversation (google.cloud.discoveryengine_v1beta.types.Conversation): The conversation to be used by auto session only. The name field will be ignored as we @@ -77,55 +81,66 @@ class ConverseConversationRequest(proto.Message): safe_search (bool): Whether to turn on safe search. user_labels (MutableMapping[str, str]): - The user labels applied to a resource must meet the - following requirements: - - - Each resource can have multiple labels, up to a maximum of - 64. - - Each label must be a key-value pair. - - Keys have a minimum length of 1 character and a maximum - length of 63 characters and cannot be empty. Values can be - empty and have a maximum length of 63 characters. - - Keys and values can contain only lowercase letters, - numeric characters, underscores, and dashes. All - characters must use UTF-8 encoding, and international - characters are allowed. - - The key portion of a label must be unique. However, you - can use the same key with multiple resources. - - Keys must start with a lowercase letter or international - character. + The user labels applied to a resource must meet + the following requirements: + * Each resource can have multiple labels, up to + a maximum of 64. + + * Each label must be a key-value pair. + * Keys have a minimum length of 1 character and + a maximum length of 63 characters and cannot + be empty. Values can be empty and have a maximum + length of 63 characters. + + * Keys and values can contain only lowercase + letters, numeric characters, underscores, and + dashes. All characters must use UTF-8 encoding, + and international characters are allowed. + + * The key portion of a label must be unique. + However, you can use the same key with + multiple resources. + + * Keys must start with a lowercase letter or + international character. See `Google Cloud - Document `__ + Document + `__ for more details. summary_spec (google.cloud.discoveryengine_v1beta.types.SearchRequest.ContentSearchSpec.SummarySpec): A specification for configuring the summary returned in the response. filter (str): - The filter syntax consists of an expression language for - constructing a predicate from one or more fields of the - documents being filtered. Filter expression is - case-sensitive. This will be used to filter search results - which may affect the summary response. - - If this field is unrecognizable, an ``INVALID_ARGUMENT`` is - returned. - - Filtering in Vertex AI Search is done by mapping the LHS - filter key to a key property defined in the Vertex AI Search - backend -- this mapping is defined by the customer in their - schema. For example a media customer might have a field - 'name' in their schema. In this case the filter would look - like this: filter --> name:'ANY("king kong")' - - For more information about filtering including syntax and - filter operators, see - `Filter `__ + The filter syntax consists of an expression + language for constructing a predicate from one + or more fields of the documents being filtered. + Filter expression is case-sensitive. This will + be used to filter search results which may + affect the summary response. + + If this field is unrecognizable, an + ``INVALID_ARGUMENT`` is returned. + + Filtering in Vertex AI Search is done by mapping + the LHS filter key to a key property defined in + the Vertex AI Search backend -- this mapping is + defined by the customer in their schema. For + example a media customer might have a field + 'name' in their schema. In this case the filter + would look like this: filter --> name:'ANY("king + kong")' + + For more information about filtering including + syntax and filter operators, see + `Filter + `__ boost_spec (google.cloud.discoveryengine_v1beta.types.SearchRequest.BoostSpec): - Boost specification to boost certain documents in search - results which may affect the converse response. For more - information on boosting, see - `Boosting `__ + Boost specification to boost certain documents + in search results which may affect the converse + response. For more information on boosting, see + `Boosting + `__ """ name: str = proto.Field( @@ -175,7 +190,8 @@ class ConverseConversationRequest(proto.Message): class ConverseConversationResponse(proto.Message): r"""Response message for - [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1beta.ConversationalSearchService.ConverseConversation] + `ConversationalSearchService.ConverseConversation + `__ method. Attributes: @@ -217,7 +233,8 @@ class CreateConversationRequest(proto.Message): Attributes: parent (str): - Required. Full resource name of parent data store. Format: + Required. Full resource name of parent data + store. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` conversation (google.cloud.discoveryengine_v1beta.types.Conversation): Required. The conversation to create. @@ -242,12 +259,15 @@ class UpdateConversationRequest(proto.Message): Required. The Conversation to update. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [Conversation][google.cloud.discoveryengine.v1beta.Conversation] + `Conversation + `__ to update. The following are NOT supported: - - [Conversation.name][google.cloud.discoveryengine.v1beta.Conversation.name] + * `Conversation.name + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported fields are + updated. """ conversation: gcd_conversation.Conversation = proto.Field( @@ -267,8 +287,8 @@ class DeleteConversationRequest(proto.Message): Attributes: name (str): - Required. The resource name of the Conversation to delete. - Format: + Required. The resource name of the Conversation + to delete. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`` """ @@ -283,8 +303,8 @@ class GetConversationRequest(proto.Message): Attributes: name (str): - Required. The resource name of the Conversation to get. - Format: + Required. The resource name of the Conversation + to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`` """ @@ -306,23 +326,30 @@ class ListConversationsRequest(proto.Message): unspecified, defaults to 50. Max allowed value is 1000. page_token (str): - A page token, received from a previous ``ListConversations`` - call. Provide this to retrieve the subsequent page. + A page token, received from a previous + ``ListConversations`` call. Provide this to + retrieve the subsequent page. filter (str): - A filter to apply on the list results. The supported - features are: user_pseudo_id, state. + A filter to apply on the list results. The + supported features are: user_pseudo_id, state. - Example: "user_pseudo_id = some_id". + Example: + + "user_pseudo_id = some_id". order_by (str): - A comma-separated list of fields to order by, sorted in - ascending order. Use "desc" after a field name for - descending. Supported fields: + A comma-separated list of fields to order by, + sorted in ascending order. Use "desc" after a + field name for descending. Supported fields: + + * ``update_time`` + * ``create_time`` + + * ``conversation_name`` - - ``update_time`` - - ``create_time`` - - ``conversation_name`` + Example: - Example: "update_time desc" "create_time". + "update_time desc" + "create_time". """ parent: str = proto.Field( @@ -375,29 +402,31 @@ def raw_page(self): class AnswerQueryRequest(proto.Message): r"""Request message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1beta.ConversationalSearchService.AnswerQuery] + `ConversationalSearchService.AnswerQuery + `__ method. Attributes: serving_config (str): - Required. The resource name of the Search serving config, - such as + Required. The resource name of the Search + serving config, such as ``projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config``, or ``projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config``. - This field is used to identify the serving configuration - name, set of models used to make the search. + This field is used to identify the serving + configuration name, set of models used to make + the search. query (google.cloud.discoveryengine_v1beta.types.Query): Required. Current user query. session (str): The session resource name. Not required. - When session field is not set, the API is in sessionless - mode. + When session field is not set, the API is in + sessionless mode. - We support auto session mode: users can use the wildcard - symbol ``-`` as session ID. A new ID will be automatically - generated and assigned. + We support auto session mode: users can use the + wildcard symbol ``-`` as session ID. A new ID + will be automatically generated and assigned. safety_spec (google.cloud.discoveryengine_v1beta.types.AnswerQueryRequest.SafetySpec): Model specification. related_questions_spec (google.cloud.discoveryengine_v1beta.types.AnswerQueryRequest.RelatedQuestionsSpec): @@ -411,53 +440,62 @@ class AnswerQueryRequest(proto.Message): query_understanding_spec (google.cloud.discoveryengine_v1beta.types.AnswerQueryRequest.QueryUnderstandingSpec): Query understanding specification. asynchronous_mode (bool): - Deprecated: This field is deprecated. Streaming Answer API - will be supported. + Deprecated: This field is deprecated. Streaming + Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with - answer/session resource name without final answer. The API - users need to do the polling to get the latest status of - answer/session by calling - [ConversationalSearchService.GetAnswer][google.cloud.discoveryengine.v1beta.ConversationalSearchService.GetAnswer] + answer/session resource name without final + answer. The API users need to do the polling to + get the latest status of answer/session by + calling `ConversationalSearchService.GetAnswer + `__ or - [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1beta.ConversationalSearchService.GetSession] + `ConversationalSearchService.GetSession + `__ method. user_pseudo_id (str): - A unique identifier for tracking visitors. For example, this - could be implemented with an HTTP cookie, which should be - able to uniquely identify a visitor on a single device. This - unique identifier should not change if the visitor logs in - or out of the website. + A unique identifier for tracking visitors. For + example, this could be implemented with an HTTP + cookie, which should be able to uniquely + identify a visitor on a single device. This + unique identifier should not change if the + visitor logs in or out of the website. This field should NOT have a fixed value such as ``unknown_visitor``. - The field must be a UTF-8 encoded string with a length limit - of 128 characters. Otherwise, an ``INVALID_ARGUMENT`` error - is returned. + The field must be a UTF-8 encoded string with a + length limit of 128 characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. user_labels (MutableMapping[str, str]): - The user labels applied to a resource must meet the - following requirements: - - - Each resource can have multiple labels, up to a maximum of - 64. - - Each label must be a key-value pair. - - Keys have a minimum length of 1 character and a maximum - length of 63 characters and cannot be empty. Values can be - empty and have a maximum length of 63 characters. - - Keys and values can contain only lowercase letters, - numeric characters, underscores, and dashes. All - characters must use UTF-8 encoding, and international - characters are allowed. - - The key portion of a label must be unique. However, you - can use the same key with multiple resources. - - Keys must start with a lowercase letter or international - character. + The user labels applied to a resource must meet + the following requirements: + * Each resource can have multiple labels, up to + a maximum of 64. + + * Each label must be a key-value pair. + * Keys have a minimum length of 1 character and + a maximum length of 63 characters and cannot + be empty. Values can be empty and have a maximum + length of 63 characters. + + * Keys and values can contain only lowercase + letters, numeric characters, underscores, and + dashes. All characters must use UTF-8 encoding, + and international characters are allowed. + + * The key portion of a label must be unique. + However, you can use the same key with + multiple resources. + + * Keys must start with a lowercase letter or + international character. See `Google Cloud - Document `__ + Document + `__ for more details. """ @@ -493,12 +531,13 @@ class GroundingSpec(proto.Message): Attributes: include_grounding_supports (bool): - Optional. Specifies whether to include grounding_supports in - the answer. The default value is ``false``. + Optional. Specifies whether to include + grounding_supports in the answer. The default + value is ``false``. - When this field is set to ``true``, returned answer will - have ``grounding_score`` and will contain GroundingSupports - for each claim. + When this field is set to ``true``, returned + answer will have ``grounding_score`` and will + contain GroundingSupports for each claim. filtering_level (google.cloud.discoveryengine_v1beta.types.AnswerQueryRequest.GroundingSpec.FilteringLevel): Optional. Specifies whether to enable the filtering based on grounding score and at what @@ -543,57 +582,65 @@ class AnswerGenerationSpec(proto.Message): prompt_spec (google.cloud.discoveryengine_v1beta.types.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec): Answer generation prompt specification. include_citations (bool): - Specifies whether to include citation metadata in the - answer. The default value is ``false``. + Specifies whether to include citation metadata + in the answer. The default value is ``false``. answer_language_code (str): - Language code for Answer. Use language tags defined by - `BCP47 `__. + Language code for Answer. Use language tags + defined by `BCP47 + `__. Note: This is an experimental feature. ignore_adversarial_query (bool): - Specifies whether to filter out adversarial queries. The - default value is ``false``. - - Google employs search-query classification to detect - adversarial queries. No answer is returned if the search - query is classified as an adversarial query. For example, a - user might ask a question regarding negative comments about - the company or submit a query designed to generate unsafe, - policy-violating output. If this field is set to ``true``, - we skip generating answers for adversarial queries and - return fallback messages instead. + Specifies whether to filter out adversarial + queries. The default value is ``false``. + + Google employs search-query classification to + detect adversarial queries. No answer is + returned if the search query is classified as an + adversarial query. For example, a user might ask + a question regarding negative comments about the + company or submit a query designed to generate + unsafe, policy-violating output. If this field + is set to ``true``, we skip generating answers + for adversarial queries and return fallback + messages instead. ignore_non_answer_seeking_query (bool): - Specifies whether to filter out queries that are not - answer-seeking. The default value is ``false``. - - Google employs search-query classification to detect - answer-seeking queries. No answer is returned if the search - query is classified as a non-answer seeking query. If this - field is set to ``true``, we skip generating answers for - non-answer seeking queries and return fallback messages - instead. + Specifies whether to filter out queries that are + not answer-seeking. The default value is + ``false``. + + Google employs search-query classification to + detect answer-seeking queries. No answer is + returned if the search query is classified as a + non-answer seeking query. If this field is set + to ``true``, we skip generating answers for + non-answer seeking queries and return fallback + messages instead. ignore_low_relevant_content (bool): - Specifies whether to filter out queries that have low - relevance. - - If this field is set to ``false``, all search results are - used regardless of relevance to generate answers. If set to - ``true`` or unset, the behavior will be determined - automatically by the service. + Specifies whether to filter out queries that + have low relevance. + If this field is set to ``false``, all search + results are used regardless of relevance to + generate answers. If set to ``true`` or unset, + the behavior will be determined automatically by + the service. This field is a member of `oneof`_ ``_ignore_low_relevant_content``. ignore_jail_breaking_query (bool): - Optional. Specifies whether to filter out jail-breaking - queries. The default value is ``false``. - - Google employs search-query classification to detect - jail-breaking queries. No summary is returned if the search - query is classified as a jail-breaking query. A user might - add instructions to the query to change the tone, style, - language, content of the answer, or ask the model to act as - a different entity, e.g. "Reply in the tone of a competing - company's CEO". If this field is set to ``true``, we skip - generating summaries for jail-breaking queries and return - fallback messages instead. + Optional. Specifies whether to filter out + jail-breaking queries. The default value is + ``false``. + + Google employs search-query classification to + detect jail-breaking queries. No summary is + returned if the search query is classified as a + jail-breaking query. A user might add + instructions to the query to change the tone, + style, language, content of the answer, or ask + the model to act as a different entity, e.g. + "Reply in the tone of a competing company's + CEO". If this field is set to ``true``, we skip + generating summaries for jail-breaking queries + and return fallback messages instead. """ class ModelSpec(proto.Message): @@ -689,45 +736,53 @@ class SearchParams(proto.Message): Number of search results to return. The default value is 10. filter (str): - The filter syntax consists of an expression language for - constructing a predicate from one or more fields of the - documents being filtered. Filter expression is - case-sensitive. This will be used to filter search results - which may affect the Answer response. - - If this field is unrecognizable, an ``INVALID_ARGUMENT`` is - returned. - - Filtering in Vertex AI Search is done by mapping the LHS - filter key to a key property defined in the Vertex AI Search - backend -- this mapping is defined by the customer in their - schema. For example a media customers might have a field - 'name' in their schema. In this case the filter would look - like this: filter --> name:'ANY("king kong")' - - For more information about filtering including syntax and - filter operators, see - `Filter `__ + The filter syntax consists of an expression + language for constructing a predicate from one + or more fields of the documents being filtered. + Filter expression is case-sensitive. This will + be used to filter search results which may + affect the Answer response. + + If this field is unrecognizable, an + ``INVALID_ARGUMENT`` is returned. + + Filtering in Vertex AI Search is done by mapping + the LHS filter key to a key property defined in + the Vertex AI Search backend -- this mapping is + defined by the customer in their schema. For + example a media customers might have a field + 'name' in their schema. In this case the filter + would look like this: filter --> name:'ANY("king + kong")' + + For more information about filtering including + syntax and filter operators, see + `Filter + `__ boost_spec (google.cloud.discoveryengine_v1beta.types.SearchRequest.BoostSpec): - Boost specification to boost certain documents in search - results which may affect the answer query response. For more - information on boosting, see - `Boosting `__ + Boost specification to boost certain documents + in search results which may affect the answer + query response. For more information on + boosting, see `Boosting + `__ order_by (str): - The order in which documents are returned. Documents can be - ordered by a field in an - [Document][google.cloud.discoveryengine.v1beta.Document] - object. Leave it unset if ordered by relevance. ``order_by`` - expression is case-sensitive. For more information on - ordering, see - `Ordering `__ - - If this field is unrecognizable, an ``INVALID_ARGUMENT`` is - returned. + The order in which documents are returned. + Documents can be ordered by a field in an + `Document + `__ + object. Leave it unset if ordered by relevance. + ``order_by`` expression is case-sensitive. For + more information on ordering, see `Ordering + `__ + + If this field is unrecognizable, an + ``INVALID_ARGUMENT`` is returned. search_result_mode (google.cloud.discoveryengine_v1beta.types.SearchRequest.ContentSearchSpec.SearchResultMode): - Specifies the search result mode. If unspecified, the search - result mode defaults to ``DOCUMENTS``. See `parse and chunk - documents `__ + Specifies the search result mode. If + unspecified, the search result mode defaults to + ``DOCUMENTS``. See `parse and chunk + documents + `__ data_store_specs (MutableSequence[google.cloud.discoveryengine_v1beta.types.SearchRequest.DataStoreSpec]): Specs defining dataStores to filter on in a search call and configurations for those @@ -823,9 +878,11 @@ class UnstructuredDocumentInfo(proto.Message): extractive_segments (MutableSequence[google.cloud.discoveryengine_v1beta.types.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveSegment]): List of extractive segments. extractive_answers (MutableSequence[google.cloud.discoveryengine_v1beta.types.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveAnswer]): - Deprecated: This field is deprecated and will have no effect - on the Answer generation. Please use document_contexts and - extractive_segments fields. List of extractive answers. + Deprecated: This field is deprecated and will + have no effect on the Answer generation. + Please use document_contexts and + extractive_segments fields. List of extractive + answers. """ class DocumentContext(proto.Message): @@ -850,9 +907,10 @@ class DocumentContext(proto.Message): class ExtractiveSegment(proto.Message): r"""Extractive segment. - `Guide `__ - Answer generation will only use it if document_contexts is empty. - This is supposed to be shorter snippets. + `Guide + `__ + Answer generation will only use it if document_contexts is + empty. This is supposed to be shorter snippets. Attributes: page_identifier (str): @@ -872,7 +930,8 @@ class ExtractiveSegment(proto.Message): class ExtractiveAnswer(proto.Message): r"""Extractive answer. - `Guide `__ + `Guide + `__ Attributes: page_identifier (str): @@ -1149,22 +1208,28 @@ class QueryRephraserSpec(proto.Message): class AnswerQueryResponse(proto.Message): r"""Response message for - [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1beta.ConversationalSearchService.AnswerQuery] + `ConversationalSearchService.AnswerQuery + `__ method. Attributes: answer (google.cloud.discoveryengine_v1beta.types.Answer): - Answer resource object. If - [AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps][google.cloud.discoveryengine.v1beta.AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps] + Answer resource object. + If + `AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps + `__ is greater than 1, use - [Answer.name][google.cloud.discoveryengine.v1beta.Answer.name] + `Answer.name + `__ to fetch answer information using - [ConversationalSearchService.GetAnswer][google.cloud.discoveryengine.v1beta.ConversationalSearchService.GetAnswer] + `ConversationalSearchService.GetAnswer + `__ API. session (google.cloud.discoveryengine_v1beta.types.Session): - Session resource object. It will be only available when - session field is set and valid in the - [AnswerQueryRequest][google.cloud.discoveryengine.v1beta.AnswerQueryRequest] + Session resource object. + It will be only available when session field is + set and valid in the `AnswerQueryRequest + `__ request. answer_query_token (str): A global unique ID used for logging. @@ -1191,7 +1256,8 @@ class GetAnswerRequest(proto.Message): Attributes: name (str): - Required. The resource name of the Answer to get. Format: + Required. The resource name of the Answer to + get. Format: ``projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`` """ @@ -1206,7 +1272,8 @@ class CreateSessionRequest(proto.Message): Attributes: parent (str): - Required. Full resource name of parent data store. Format: + Required. Full resource name of parent data + store. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`` session (google.cloud.discoveryengine_v1beta.types.Session): Required. The session to create. @@ -1231,12 +1298,15 @@ class UpdateSessionRequest(proto.Message): Required. The Session to update. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [Session][google.cloud.discoveryengine.v1beta.Session] to - update. The following are NOT supported: + `Session + `__ + to update. The following are NOT supported: - - [Session.name][google.cloud.discoveryengine.v1beta.Session.name] + * `Session.name + `__ - If not set or empty, all supported fields are updated. + If not set or empty, all supported fields are + updated. """ session: gcd_session.Session = proto.Field( @@ -1256,8 +1326,8 @@ class DeleteSessionRequest(proto.Message): Attributes: name (str): - Required. The resource name of the Session to delete. - Format: + Required. The resource name of the Session to + delete. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` """ @@ -1272,7 +1342,8 @@ class GetSessionRequest(proto.Message): Attributes: name (str): - Required. The resource name of the Session to get. Format: + Required. The resource name of the Session to + get. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`` include_answer_details (bool): Optional. If set to true, the full session @@ -1301,40 +1372,51 @@ class ListSessionsRequest(proto.Message): unspecified, defaults to 50. Max allowed value is 1000. page_token (str): - A page token, received from a previous ``ListSessions`` - call. Provide this to retrieve the subsequent page. + A page token, received from a previous + ``ListSessions`` call. Provide this to retrieve + the subsequent page. filter (str): - A comma-separated list of fields to filter by, in EBNF - grammar. The supported fields are: - - - ``user_pseudo_id`` - - ``state`` - - ``display_name`` - - ``starred`` - - ``is_pinned`` - - ``labels`` - - ``create_time`` - - ``update_time`` - - Examples: "user_pseudo_id = some_id" "display_name = - "some_name"" "starred = true" "is_pinned=true AND (NOT - labels:hidden)" "create_time > "1970-01-01T12:00:00Z"". + A comma-separated list of fields to filter by, + in EBNF grammar. The supported fields are: + + * ``user_pseudo_id`` + * ``state`` + + * ``display_name`` + * ``starred`` + + * ``is_pinned`` + * ``labels`` + + * ``create_time`` + * ``update_time`` + + Examples: + + "user_pseudo_id = some_id" + "display_name = \"some_name\"" + "starred = true" + "is_pinned=true AND (NOT labels:hidden)" + "create_time > \"1970-01-01T12:00:00Z\"". order_by (str): - A comma-separated list of fields to order by, sorted in - ascending order. Use "desc" after a field name for - descending. Supported fields: + A comma-separated list of fields to order by, + sorted in ascending order. Use "desc" after a + field name for descending. Supported fields: - - ``update_time`` - - ``create_time`` - - ``session_name`` - - ``is_pinned`` + * ``update_time`` + * ``create_time`` + + * ``session_name`` + * ``is_pinned`` Example: - - "update_time desc" - - "create_time" - - "is_pinned desc,update_time desc": list sessions by - is_pinned first, then by update_time. + * "update_time desc" + * "create_time" + + * "is_pinned desc,update_time desc": list + sessions by is_pinned first, then by + update_time. """ parent: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/custom_tuning_model.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/custom_tuning_model.py index 6f67d52fa25d..5cd4a04de4e6 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/custom_tuning_model.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/custom_tuning_model.py @@ -33,20 +33,21 @@ class CustomTuningModel(proto.Message): Attributes: name (str): - Required. The fully qualified resource name of the model. - + Required. The fully qualified resource name of + the model. Format: + ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}``. - Model must be an alpha-numerical string with limit of 40 - characters. + Model must be an alpha-numerical string with + limit of 40 characters. display_name (str): The display name of the model. model_version (int): The version of the model. model_state (google.cloud.discoveryengine_v1beta.types.CustomTuningModel.ModelState): - The state that the model is in (e.g.\ ``TRAINING`` or - ``TRAINING_FAILED``). + The state that the model is in (e.g.``TRAINING`` + or ``TRAINING_FAILED``). create_time (google.protobuf.timestamp_pb2.Timestamp): Deprecated: Timestamp the Model was created at. @@ -55,8 +56,8 @@ class CustomTuningModel(proto.Message): metrics (MutableMapping[str, float]): The metrics of the trained model. error_message (str): - Currently this is only populated if the model state is - ``INPUT_VALIDATION_FAILED``. + Currently this is only populated if the model + state is ``INPUT_VALIDATION_FAILED``. """ class ModelState(proto.Enum): diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/data_store.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/data_store.py index 76f64b5352c7..787bf278bcec 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/data_store.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/data_store.py @@ -43,40 +43,45 @@ class DataStore(proto.Message): Attributes: name (str): - Immutable. The full resource name of the data store. Format: + Immutable. The full resource name of the data + store. Format: + ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. - This field must be a UTF-8 encoded string with a length - limit of 1024 characters. + This field must be a UTF-8 encoded string with a + length limit of 1024 characters. display_name (str): Required. The data store display name. - This field must be a UTF-8 encoded string with a length - limit of 128 characters. Otherwise, an INVALID_ARGUMENT - error is returned. + This field must be a UTF-8 encoded string with a + length limit of 128 characters. Otherwise, an + INVALID_ARGUMENT error is returned. industry_vertical (google.cloud.discoveryengine_v1beta.types.IndustryVertical): Immutable. The industry vertical that the data store registers. solution_types (MutableSequence[google.cloud.discoveryengine_v1beta.types.SolutionType]): - The solutions that the data store enrolls. Available - solutions for each - [industry_vertical][google.cloud.discoveryengine.v1beta.DataStore.industry_vertical]: - - - ``MEDIA``: ``SOLUTION_TYPE_RECOMMENDATION`` and - ``SOLUTION_TYPE_SEARCH``. - - ``SITE_SEARCH``: ``SOLUTION_TYPE_SEARCH`` is automatically - enrolled. Other solutions cannot be enrolled. + The solutions that the data store enrolls. + Available solutions for each `industry_vertical + `__: + + * ``MEDIA``: ``SOLUTION_TYPE_RECOMMENDATION`` + and ``SOLUTION_TYPE_SEARCH``. * ``SITE_SEARCH``: + ``SOLUTION_TYPE_SEARCH`` is automatically + enrolled. Other solutions cannot be enrolled. default_schema_id (str): Output only. The id of the default - [Schema][google.cloud.discoveryengine.v1beta.Schema] + `Schema + `__ asscociated to this data store. content_config (google.cloud.discoveryengine_v1beta.types.DataStore.ContentConfig): - Immutable. The content config of the data store. If this - field is unset, the server behavior defaults to - [ContentConfig.NO_CONTENT][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.NO_CONTENT]. + Immutable. The content config of the data store. + If this field is unset, the server behavior + defaults to `ContentConfig.NO_CONTENT + `__. create_time (google.protobuf.timestamp_pb2.Timestamp): Output only. Timestamp the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] + `DataStore + `__ was created at. language_info (google.cloud.discoveryengine_v1beta.types.LanguageInfo): Language info for DataStore. @@ -87,32 +92,37 @@ class DataStore(proto.Message): Output only. Data size estimation for billing. workspace_config (google.cloud.discoveryengine_v1beta.types.WorkspaceConfig): - Config to store data store type configuration for workspace - data. This must be set when - [DataStore.content_config][google.cloud.discoveryengine.v1beta.DataStore.content_config] + Config to store data store type configuration + for workspace data. This must be set when + `DataStore.content_config + `__ is set as - [DataStore.ContentConfig.GOOGLE_WORKSPACE][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.GOOGLE_WORKSPACE]. + `DataStore.ContentConfig.GOOGLE_WORKSPACE + `__. document_processing_config (google.cloud.discoveryengine_v1beta.types.DocumentProcessingConfig): Configuration for Document understanding and enrichment. starting_schema (google.cloud.discoveryengine_v1beta.types.Schema): The start schema to use for this - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] - when provisioning it. If unset, a default vertical - specialized schema will be used. - - This field is only used by [CreateDataStore][] API, and will - be ignored if used in other APIs. This field will be omitted - from all API responses including [CreateDataStore][] API. To - retrieve a schema of a - [DataStore][google.cloud.discoveryengine.v1beta.DataStore], - use - [SchemaService.GetSchema][google.cloud.discoveryengine.v1beta.SchemaService.GetSchema] + `DataStore + `__ + when provisioning it. If unset, a default + vertical specialized schema will be used. + + This field is only used by [CreateDataStore][] + API, and will be ignored if used in other APIs. + This field will be omitted from all API + responses including [CreateDataStore][] API. To + retrieve a schema of a `DataStore + `__, + use `SchemaService.GetSchema + `__ API instead. - The provided schema will be validated against certain rules - on schema. Learn more from `this - doc `__. + The provided schema will be validated against + certain rules on schema. Learn more from `this + doc + `__. serving_config_data_store (google.cloud.discoveryengine_v1beta.types.DataStore.ServingConfigDataStore): Optional. Stores serving config at DataStore level. @@ -126,17 +136,20 @@ class ContentConfig(proto.Enum): Default value. NO_CONTENT (1): Only contains documents without any - [Document.content][google.cloud.discoveryengine.v1beta.Document.content]. + `Document.content + `__. CONTENT_REQUIRED (2): Only contains documents with - [Document.content][google.cloud.discoveryengine.v1beta.Document.content]. + `Document.content + `__. PUBLIC_WEBSITE (3): The data store is used for public website search. GOOGLE_WORKSPACE (4): - The data store is used for workspace search. Details of - workspace data store are specified in the - [WorkspaceConfig][google.cloud.discoveryengine.v1beta.WorkspaceConfig]. + The data store is used for workspace search. + Details of workspace data store are specified in + the `WorkspaceConfig + `__. """ CONTENT_CONFIG_UNSPECIFIED = 0 NO_CONTENT = 1 @@ -283,17 +296,20 @@ class LanguageInfo(proto.Message): language_code (str): The language code for the DataStore. normalized_language_code (str): - Output only. This is the normalized form of language_code. - E.g.: language_code of ``en-GB``, ``en_GB``, ``en-UK`` or - ``en-gb`` will have normalized_language_code of ``en-GB``. + Output only. This is the normalized form of + language_code. E.g.: language_code of ``en-GB``, + ``en_GB``, ``en-UK`` or ``en-gb`` will have + normalized_language_code of ``en-GB``. language (str): - Output only. Language part of normalized_language_code. - E.g.: ``en-US`` -> ``en``, ``zh-Hans-HK`` -> ``zh``, ``en`` - -> ``en``. + Output only. Language part of + normalized_language_code. E.g.: ``en-US`` -> + ``en``, ``zh-Hans-HK`` -> ``zh``, ``en`` -> + ``en``. region (str): - Output only. Region part of normalized_language_code, if - present. E.g.: ``en-US`` -> ``US``, ``zh-Hans-HK`` -> - ``HK``, ``en`` -> \`\`. + Output only. Region part of + normalized_language_code, if present. E.g.: + ``en-US`` -> ``US``, ``zh-Hans-HK`` -> ``HK``, + ``en`` -> ``. """ language_code: str = proto.Field( @@ -319,9 +335,10 @@ class NaturalLanguageQueryUnderstandingConfig(proto.Message): Attributes: mode (google.cloud.discoveryengine_v1beta.types.NaturalLanguageQueryUnderstandingConfig.Mode): - Mode of Natural Language Query Understanding. If this field - is unset, the behavior defaults to - [NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED][google.cloud.discoveryengine.v1beta.NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED]. + Mode of Natural Language Query Understanding. If + this field is unset, the behavior defaults to + `NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED + `__. """ class Mode(proto.Enum): diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/data_store_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/data_store_service.py index faf087d44736..910ec03627f1 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/data_store_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/data_store_service.py @@ -40,7 +40,8 @@ class CreateDataStoreRequest(proto.Message): r"""Request for - [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.CreateDataStore] + `DataStoreService.CreateDataStore + `__ method. Attributes: @@ -48,33 +49,40 @@ class CreateDataStoreRequest(proto.Message): Required. The parent resource name, such as ``projects/{project}/locations/{location}/collections/{collection}``. data_store (google.cloud.discoveryengine_v1beta.types.DataStore): - Required. The - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] + Required. The `DataStore + `__ to create. data_store_id (str): Required. The ID to use for the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore], + `DataStore + `__, which will become the final component of the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]'s + `DataStore + `__'s resource name. - This field must conform to - `RFC-1034 `__ standard - with a length limit of 63 characters. Otherwise, an - INVALID_ARGUMENT error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 characters. + Otherwise, an INVALID_ARGUMENT error is + returned. create_advanced_site_search (bool): - A boolean flag indicating whether user want to directly - create an advanced data store for site search. If the data - store is not configured as site search (GENERIC vertical and - PUBLIC_WEBSITE content_config), this flag will be ignored. + A boolean flag indicating whether user want to + directly create an advanced data store for site + search. If the data store is not configured as + site + search (GENERIC vertical and PUBLIC_WEBSITE + content_config), this flag will be ignored. skip_default_schema_creation (bool): - A boolean flag indicating whether to skip the default schema - creation for the data store. Only enable this flag if you - are certain that the default schema is incompatible with - your use case. + A boolean flag indicating whether to skip the + default schema creation for the data store. Only + enable this flag if you are certain that the + default schema is incompatible with your use + case. - If set to true, you must manually create a schema for the - data store before any documents can be ingested. + If set to true, you must manually create a + schema for the data store before any documents + can be ingested. This flag cannot be specified if ``data_store.starting_schema`` is specified. @@ -105,23 +113,26 @@ class CreateDataStoreRequest(proto.Message): class GetDataStoreRequest(proto.Message): r"""Request message for - [DataStoreService.GetDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.GetDataStore] + `DataStoreService.GetDataStore + `__ method. Attributes: name (str): Required. Full resource name of - [DataStore][google.cloud.discoveryengine.v1beta.DataStore], + `DataStore + `__, such as ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. - If the caller does not have permission to access the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. + If the caller does not have permission to access + the `DataStore + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. - If the requested - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] + If the requested `DataStore + `__ does not exist, a NOT_FOUND error is returned. """ @@ -133,7 +144,8 @@ class GetDataStoreRequest(proto.Message): class CreateDataStoreMetadata(proto.Message): r"""Metadata related to the progress of the - [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.CreateDataStore] + `DataStoreService.CreateDataStore + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -159,39 +171,52 @@ class CreateDataStoreMetadata(proto.Message): class ListDataStoresRequest(proto.Message): r"""Request message for - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores] + `DataStoreService.ListDataStores + `__ method. Attributes: parent (str): - Required. The parent branch resource name, such as + Required. The parent branch resource name, such + as ``projects/{project}/locations/{location}/collections/{collection_id}``. If the caller does not have permission to list - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s - under this location, regardless of whether or not this data - store exists, a PERMISSION_DENIED error is returned. + `DataStore + `__s + under this location, regardless of whether or + not this data store exists, a PERMISSION_DENIED + error is returned. page_size (int): Maximum number of - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s - to return. If unspecified, defaults to 10. The maximum - allowed value is 50. Values above 50 will be coerced to 50. - - If this field is negative, an INVALID_ARGUMENT is returned. + `DataStore + `__s + to return. If unspecified, defaults to 10. The + maximum allowed value is 50. Values above 50 + will be coerced to 50. + + If this field is negative, an INVALID_ARGUMENT + is returned. page_token (str): A page token - [ListDataStoresResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListDataStoresResponse.next_page_token], + `ListDataStoresResponse.next_page_token + `__, received from a previous - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores] - call. Provide this to retrieve the subsequent page. - - When paginating, all other parameters provided to - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores] - must match the call that provided the page token. Otherwise, - an INVALID_ARGUMENT error is returned. + `DataStoreService.ListDataStores + `__ + call. Provide this to retrieve the subsequent + page. + + When paginating, all other parameters provided + to `DataStoreService.ListDataStores + `__ + must match the call that provided the page + token. Otherwise, an INVALID_ARGUMENT error is + returned. filter (str): - Filter by solution type . For example: - ``filter = 'solution_type:SOLUTION_TYPE_SEARCH'`` + Filter by solution type . + For example: ``filter = + 'solution_type:SOLUTION_TYPE_SEARCH'`` """ parent: str = proto.Field( @@ -214,18 +239,21 @@ class ListDataStoresRequest(proto.Message): class ListDataStoresResponse(proto.Message): r"""Response message for - [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores] + `DataStoreService.ListDataStores + `__ method. Attributes: data_stores (MutableSequence[google.cloud.discoveryengine_v1beta.types.DataStore]): All the customer's - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s. + `DataStore + `__s. next_page_token (str): A token that can be sent as - [ListDataStoresRequest.page_token][google.cloud.discoveryengine.v1beta.ListDataStoresRequest.page_token] - to retrieve the next page. If this field is omitted, there - are no subsequent pages. + `ListDataStoresRequest.page_token + `__ + to retrieve the next page. If this field is + omitted, there are no subsequent pages. """ @property @@ -245,24 +273,28 @@ def raw_page(self): class DeleteDataStoreRequest(proto.Message): r"""Request message for - [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.DeleteDataStore] + `DataStoreService.DeleteDataStore + `__ method. Attributes: name (str): Required. Full resource name of - [DataStore][google.cloud.discoveryengine.v1beta.DataStore], + `DataStore + `__, such as ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. - If the caller does not have permission to delete the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. + If the caller does not have permission to delete + the `DataStore + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. - If the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] - to delete does not exist, a NOT_FOUND error is returned. + If the `DataStore + `__ + to delete does not exist, a NOT_FOUND error is + returned. """ name: str = proto.Field( @@ -273,30 +305,34 @@ class DeleteDataStoreRequest(proto.Message): class UpdateDataStoreRequest(proto.Message): r"""Request message for - [DataStoreService.UpdateDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.UpdateDataStore] + `DataStoreService.UpdateDataStore + `__ method. Attributes: data_store (google.cloud.discoveryengine_v1beta.types.DataStore): - Required. The - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] + Required. The `DataStore + `__ to update. - If the caller does not have permission to update the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. + If the caller does not have permission to update + the `DataStore + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. - If the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] - to update does not exist, a NOT_FOUND error is returned. + If the `DataStore + `__ + to update does not exist, a NOT_FOUND error is + returned. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] + `DataStore + `__ to update. - If an unsupported or unknown field is provided, an - INVALID_ARGUMENT error is returned. + If an unsupported or unknown field is provided, + an INVALID_ARGUMENT error is returned. """ data_store: gcd_data_store.DataStore = proto.Field( @@ -313,7 +349,8 @@ class UpdateDataStoreRequest(proto.Message): class DeleteDataStoreMetadata(proto.Message): r"""Metadata related to the progress of the - [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.DeleteDataStore] + `DataStoreService.DeleteDataStore + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/document.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/document.py index d673a125fca2..134322edc26e 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/document.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/document.py @@ -43,63 +43,69 @@ class Document(proto.Message): Attributes: struct_data (google.protobuf.struct_pb2.Struct): - The structured JSON data for the document. It should conform - to the registered - [Schema][google.cloud.discoveryengine.v1beta.Schema] or an - ``INVALID_ARGUMENT`` error is thrown. + The structured JSON data for the document. It + should conform to the registered `Schema + `__ + or an ``INVALID_ARGUMENT`` error is thrown. This field is a member of `oneof`_ ``data``. json_data (str): - The JSON string representation of the document. It should - conform to the registered - [Schema][google.cloud.discoveryengine.v1beta.Schema] or an - ``INVALID_ARGUMENT`` error is thrown. + The JSON string representation of the document. + It should conform to the registered `Schema + `__ + or an ``INVALID_ARGUMENT`` error is thrown. This field is a member of `oneof`_ ``data``. name (str): - Immutable. The full resource name of the document. Format: + Immutable. The full resource name of the + document. Format: + ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}``. - This field must be a UTF-8 encoded string with a length - limit of 1024 characters. + This field must be a UTF-8 encoded string with a + length limit of 1024 characters. id (str): Immutable. The identifier of the document. - Id should conform to - `RFC-1034 `__ standard - with a length limit of 63 characters. + Id should conform to `RFC-1034 + `__ + standard with a length limit of 63 characters. schema_id (str): The identifier of the schema located in the same data store. content (google.cloud.discoveryengine_v1beta.types.Document.Content): - The unstructured data linked to this document. Content must - be set if this document is under a ``CONTENT_REQUIRED`` data - store. + The unstructured data linked to this document. + Content must be set if this document is under a + ``CONTENT_REQUIRED`` data store. parent_document_id (str): - The identifier of the parent document. Currently supports at - most two level document hierarchy. + The identifier of the parent document. Currently + supports at most two level document hierarchy. - Id should conform to - `RFC-1034 `__ standard - with a length limit of 63 characters. + Id should conform to `RFC-1034 + `__ + standard with a length limit of 63 characters. derived_struct_data (google.protobuf.struct_pb2.Struct): - Output only. This field is OUTPUT_ONLY. It contains derived - data that are not in the original input document. + Output only. This field is OUTPUT_ONLY. + It contains derived data that are not in the + original input document. index_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. The last time the document was indexed. If this - field is set, the document could be returned in search - results. + Output only. The last time the document was + indexed. If this field is set, the document + could be returned in search results. - This field is OUTPUT_ONLY. If this field is not populated, - it means the document has never been indexed. + This field is OUTPUT_ONLY. If this field is not + populated, it means the document has never been + indexed. index_status (google.cloud.discoveryengine_v1beta.types.Document.IndexStatus): Output only. The index status of the document. - - If document is indexed successfully, the index_time field - is populated. - - Otherwise, if document is not indexed due to errors, the - error_samples field is populated. - - Otherwise, index_status is unset. + * If document is indexed successfully, the + index_time field is populated. + + * Otherwise, if document is not indexed due to + errors, the error_samples field is populated. + + * Otherwise, index_status is unset. """ class Content(proto.Message): @@ -114,35 +120,40 @@ class Content(proto.Message): Attributes: raw_bytes (bytes): - The content represented as a stream of bytes. The maximum - length is 1,000,000 bytes (1 MB / ~0.95 MiB). - - Note: As with all ``bytes`` fields, this field is - represented as pure binary in Protocol Buffers and - base64-encoded string in JSON. For example, - ``abc123!?$*&()'-=@~`` should be represented as - ``YWJjMTIzIT8kKiYoKSctPUB+`` in JSON. See + The content represented as a stream of bytes. + The maximum length is 1,000,000 bytes (1 MB / + ~0.95 MiB). + + Note: As with all ``bytes`` fields, this field + is represented as pure binary in Protocol + Buffers and base64-encoded string in JSON. For + example, ``abc123!?$*&()'-=@~`` should be + represented as ``YWJjMTIzIT8kKiYoKSctPUB+`` in + JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. This field is a member of `oneof`_ ``content``. uri (str): - The URI of the content. Only Cloud Storage URIs (e.g. - ``gs://bucket-name/path/to/file``) are supported. The - maximum file size is 2.5 MB for text-based formats, 200 MB - for other formats. + The URI of the content. Only Cloud Storage URIs + (e.g. ``gs://bucket-name/path/to/file``) are + supported. The maximum file size is 2.5 MB for + text-based formats, 200 MB for other formats. This field is a member of `oneof`_ ``content``. mime_type (str): The MIME type of the content. Supported types: - - ``application/pdf`` (PDF, only native PDFs are supported - for now) - - ``text/html`` (HTML) - - ``application/vnd.openxmlformats-officedocument.wordprocessingml.document`` - (DOCX) - - ``application/vnd.openxmlformats-officedocument.presentationml.presentation`` - (PPTX) - - ``text/plain`` (TXT) + * ``application/pdf`` (PDF, only native PDFs are + supported for now) + + * ``text/html`` (HTML) + * + ``application/vnd.openxmlformats-officedocument.wordprocessingml.document`` + (DOCX) + + * + ``application/vnd.openxmlformats-officedocument.presentationml.presentation`` + (PPTX) * ``text/plain`` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/document_processing_config.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/document_processing_config.py index d5840f2ac08f..1f865b1c094a 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/document_processing_config.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/document_processing_config.py @@ -29,18 +29,20 @@ class DocumentProcessingConfig(proto.Message): r"""A singleton resource of - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. If it's - empty when - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] is - created and - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] is set to - [DataStore.ContentConfig.CONTENT_REQUIRED][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.CONTENT_REQUIRED], + `DataStore `__. + If it's empty when `DataStore + `__ is created + and `DataStore + `__ is set to + `DataStore.ContentConfig.CONTENT_REQUIRED + `__, the default parser will default to digital parser. Attributes: name (str): - The full resource name of the Document Processing Config. - Format: + The full resource name of the Document + Processing Config. Format: + ``projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig``. chunking_config (google.cloud.discoveryengine_v1beta.types.DocumentProcessingConfig.ChunkingConfig): Whether chunking mode is enabled. @@ -51,22 +53,33 @@ class DocumentProcessingConfig(proto.Message): parsing config will be applied to all file types for Document parsing. parsing_config_overrides (MutableMapping[str, google.cloud.discoveryengine_v1beta.types.DocumentProcessingConfig.ParsingConfig]): - Map from file type to override the default parsing - configuration based on the file type. Supported keys: - - - ``pdf``: Override parsing config for PDF files, either - digital parsing, ocr parsing or layout parsing is - supported. - - ``html``: Override parsing config for HTML files, only - digital parsing and layout parsing are supported. - - ``docx``: Override parsing config for DOCX files, only - digital parsing and layout parsing are supported. - - ``pptx``: Override parsing config for PPTX files, only - digital parsing and layout parsing are supported. - - ``xlsm``: Override parsing config for XLSM files, only - digital parsing and layout parsing are supported. - - ``xlsx``: Override parsing config for XLSX files, only - digital parsing and layout parsing are supported. + Map from file type to override the default + parsing configuration based on the file type. + Supported keys: + + * ``pdf``: Override parsing config for PDF + files, either digital parsing, ocr parsing or + layout parsing is supported. + + * ``html``: Override parsing config for HTML + files, only digital parsing and layout parsing + are supported. + + * ``docx``: Override parsing config for DOCX + files, only digital parsing and layout parsing + are supported. + + * ``pptx``: Override parsing config for PPTX + files, only digital parsing and layout parsing + are supported. + + * ``xlsm``: Override parsing config for XLSM + files, only digital parsing and layout parsing + are supported. + + * ``xlsx``: Override parsing config for XLSX + files, only digital parsing and layout parsing + are supported. """ class ChunkingConfig(proto.Message): @@ -149,8 +162,9 @@ class OcrParsingConfig(proto.Message): Attributes: enhanced_document_elements (MutableSequence[str]): - [DEPRECATED] This field is deprecated. To use the additional - enhanced document elements processing, please switch to + [DEPRECATED] This field is deprecated. To use + the additional enhanced document elements + processing, please switch to ``layout_parsing_config``. use_native_text (bool): If true, will use native text instead of OCR diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/document_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/document_service.py index 35a4e549e55b..25644771f39b 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/document_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/document_service.py @@ -40,24 +40,28 @@ class GetDocumentRequest(proto.Message): r"""Request message for - [DocumentService.GetDocument][google.cloud.discoveryengine.v1beta.DocumentService.GetDocument] + `DocumentService.GetDocument + `__ method. Attributes: name (str): Required. Full resource name of - [Document][google.cloud.discoveryengine.v1beta.Document], + `Document + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}``. - If the caller does not have permission to access the - [Document][google.cloud.discoveryengine.v1beta.Document], + If the caller does not have permission to access + the `Document + `__, regardless of whether or not it exists, a ``PERMISSION_DENIED`` error is returned. - If the requested - [Document][google.cloud.discoveryengine.v1beta.Document] - does not exist, a ``NOT_FOUND`` error is returned. + If the requested `Document + `__ + does not exist, a ``NOT_FOUND`` error is + returned. """ name: str = proto.Field( @@ -68,39 +72,49 @@ class GetDocumentRequest(proto.Message): class ListDocumentsRequest(proto.Message): r"""Request message for - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments] + `DocumentService.ListDocuments + `__ method. Attributes: parent (str): - Required. The parent branch resource name, such as + Required. The parent branch resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. - Use ``default_branch`` as the branch ID, to list documents - under the default branch. + Use ``default_branch`` as the branch ID, to list + documents under the default branch. If the caller does not have permission to list - [Document][google.cloud.discoveryengine.v1beta.Document]s - under this branch, regardless of whether or not this branch - exists, a ``PERMISSION_DENIED`` error is returned. + `Document + `__s + under this branch, regardless of whether or not + this branch exists, a ``PERMISSION_DENIED`` + error is returned. page_size (int): - Maximum number of - [Document][google.cloud.discoveryengine.v1beta.Document]s to - return. If unspecified, defaults to 100. The maximum allowed - value is 1000. Values above 1000 are set to 1000. + Maximum number of `Document + `__s + to return. If unspecified, defaults to 100. The + maximum allowed value is + 1000. Values above 1000 are set to 1000. - If this field is negative, an ``INVALID_ARGUMENT`` error is - returned. + If this field is negative, an + ``INVALID_ARGUMENT`` error is returned. page_token (str): A page token - [ListDocumentsResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListDocumentsResponse.next_page_token], + `ListDocumentsResponse.next_page_token + `__, received from a previous - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments] - call. Provide this to retrieve the subsequent page. - - When paginating, all other parameters provided to - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments] - must match the call that provided the page token. Otherwise, - an ``INVALID_ARGUMENT`` error is returned. + `DocumentService.ListDocuments + `__ + call. Provide this to retrieve the subsequent + page. + + When paginating, all other parameters provided + to `DocumentService.ListDocuments + `__ + must match the call that provided the page + token. Otherwise, an ``INVALID_ARGUMENT`` error + is returned. """ parent: str = proto.Field( @@ -119,18 +133,20 @@ class ListDocumentsRequest(proto.Message): class ListDocumentsResponse(proto.Message): r"""Response message for - [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments] + `DocumentService.ListDocuments + `__ method. Attributes: documents (MutableSequence[google.cloud.discoveryengine_v1beta.types.Document]): - The - [Document][google.cloud.discoveryengine.v1beta.Document]s. + The `Document + `__s. next_page_token (str): A token that can be sent as - [ListDocumentsRequest.page_token][google.cloud.discoveryengine.v1beta.ListDocumentsRequest.page_token] - to retrieve the next page. If this field is omitted, there - are no subsequent pages. + `ListDocumentsRequest.page_token + `__ + to retrieve the next page. If this field is + omitted, there are no subsequent pages. """ @property @@ -150,7 +166,8 @@ def raw_page(self): class CreateDocumentRequest(proto.Message): r"""Request message for - [DocumentService.CreateDocument][google.cloud.discoveryengine.v1beta.DocumentService.CreateDocument] + `DocumentService.CreateDocument + `__ method. Attributes: @@ -158,30 +175,36 @@ class CreateDocumentRequest(proto.Message): Required. The parent resource name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. document (google.cloud.discoveryengine_v1beta.types.Document): - Required. The - [Document][google.cloud.discoveryengine.v1beta.Document] to - create. + Required. The `Document + `__ + to create. document_id (str): Required. The ID to use for the - [Document][google.cloud.discoveryengine.v1beta.Document], + `Document + `__, which becomes the final component of the - [Document.name][google.cloud.discoveryengine.v1beta.Document.name]. + `Document.name + `__. - If the caller does not have permission to create the - [Document][google.cloud.discoveryengine.v1beta.Document], + If the caller does not have permission to create + the `Document + `__, regardless of whether or not it exists, a ``PERMISSION_DENIED`` error is returned. This field must be unique among all - [Document][google.cloud.discoveryengine.v1beta.Document]s - with the same - [parent][google.cloud.discoveryengine.v1beta.CreateDocumentRequest.parent]. - Otherwise, an ``ALREADY_EXISTS`` error is returned. - - This field must conform to - `RFC-1034 `__ standard - with a length limit of 63 characters. Otherwise, an - ``INVALID_ARGUMENT`` error is returned. + `Document + `__s + with the same `parent + `__. + Otherwise, an ``ALREADY_EXISTS`` error is + returned. + + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 characters. + Otherwise, an ``INVALID_ARGUMENT`` error is + returned. """ parent: str = proto.Field( @@ -201,29 +224,33 @@ class CreateDocumentRequest(proto.Message): class UpdateDocumentRequest(proto.Message): r"""Request message for - [DocumentService.UpdateDocument][google.cloud.discoveryengine.v1beta.DocumentService.UpdateDocument] + `DocumentService.UpdateDocument + `__ method. Attributes: document (google.cloud.discoveryengine_v1beta.types.Document): Required. The document to update/create. - If the caller does not have permission to update the - [Document][google.cloud.discoveryengine.v1beta.Document], + If the caller does not have permission to update + the `Document + `__, regardless of whether or not it exists, a ``PERMISSION_DENIED`` error is returned. - If the - [Document][google.cloud.discoveryengine.v1beta.Document] to - update does not exist and - [allow_missing][google.cloud.discoveryengine.v1beta.UpdateDocumentRequest.allow_missing] + If the `Document + `__ + to update does not exist and + `allow_missing + `__ is not set, a ``NOT_FOUND`` error is returned. allow_missing (bool): If set to ``true`` and the - [Document][google.cloud.discoveryengine.v1beta.Document] is - not found, a new - [Document][google.cloud.discoveryengine.v1beta.Document] is - be created. + `Document + `__ + is not found, a new `Document + `__ + is be created. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided imported 'document' to update. If not set, by @@ -248,24 +275,28 @@ class UpdateDocumentRequest(proto.Message): class DeleteDocumentRequest(proto.Message): r"""Request message for - [DocumentService.DeleteDocument][google.cloud.discoveryengine.v1beta.DocumentService.DeleteDocument] + `DocumentService.DeleteDocument + `__ method. Attributes: name (str): Required. Full resource name of - [Document][google.cloud.discoveryengine.v1beta.Document], + `Document + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}``. - If the caller does not have permission to delete the - [Document][google.cloud.discoveryengine.v1beta.Document], + If the caller does not have permission to delete + the `Document + `__, regardless of whether or not it exists, a ``PERMISSION_DENIED`` error is returned. - If the - [Document][google.cloud.discoveryengine.v1beta.Document] to - delete does not exist, a ``NOT_FOUND`` error is returned. + If the `Document + `__ + to delete does not exist, a ``NOT_FOUND`` error + is returned. """ name: str = proto.Field( @@ -276,21 +307,24 @@ class DeleteDocumentRequest(proto.Message): class BatchGetDocumentsMetadataRequest(proto.Message): r"""Request message for - [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1beta.DocumentService.BatchGetDocumentsMetadata] + `DocumentService.BatchGetDocumentsMetadata + `__ method. Attributes: parent (str): - Required. The parent branch resource name, such as + Required. The parent branch resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. matcher (google.cloud.discoveryengine_v1beta.types.BatchGetDocumentsMetadataRequest.Matcher): Required. Matcher for the - [Document][google.cloud.discoveryengine.v1beta.Document]s. + `Document + `__s. """ class UrisMatcher(proto.Message): - r"""Matcher for the - [Document][google.cloud.discoveryengine.v1beta.Document]s by exact + r"""Matcher for the `Document + `__s by exact uris. Attributes: @@ -304,13 +338,15 @@ class UrisMatcher(proto.Message): ) class FhirMatcher(proto.Message): - r"""Matcher for the - [Document][google.cloud.discoveryengine.v1beta.Document]s by FHIR + r"""Matcher for the `Document + `__s by FHIR resource names. Attributes: fhir_resources (MutableSequence[str]): - Required. The FHIR resources to match by. Format: + Required. The FHIR resources to match by. + Format: + projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} """ @@ -320,8 +356,8 @@ class FhirMatcher(proto.Message): ) class Matcher(proto.Message): - r"""Matcher for the - [Document][google.cloud.discoveryengine.v1beta.Document]s. Currently + r"""Matcher for the `Document + `__s. Currently supports matching by exact URIs. This message has `oneof`_ fields (mutually exclusive fields). @@ -368,31 +404,37 @@ class Matcher(proto.Message): class BatchGetDocumentsMetadataResponse(proto.Message): r"""Response message for - [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1beta.DocumentService.BatchGetDocumentsMetadata] + `DocumentService.BatchGetDocumentsMetadata + `__ method. Attributes: documents_metadata (MutableSequence[google.cloud.discoveryengine_v1beta.types.BatchGetDocumentsMetadataResponse.DocumentMetadata]): The metadata of the - [Document][google.cloud.discoveryengine.v1beta.Document]s. + `Document + `__s. """ class State(proto.Enum): - r"""The state of the - [Document][google.cloud.discoveryengine.v1beta.Document]. + r"""The state of the `Document + `__. Values: STATE_UNSPECIFIED (0): Should never be set. INDEXED (1): - The [Document][google.cloud.discoveryengine.v1beta.Document] + The `Document + `__ is indexed. NOT_IN_TARGET_SITE (2): - The [Document][google.cloud.discoveryengine.v1beta.Document] + The `Document + `__ is not indexed because its URI is not in the - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]. + `TargetSite + `__. NOT_IN_INDEX (3): - The [Document][google.cloud.discoveryengine.v1beta.Document] + The `Document + `__ is not indexed. """ STATE_UNSPECIFIED = 0 @@ -401,34 +443,36 @@ class State(proto.Enum): NOT_IN_INDEX = 3 class DocumentMetadata(proto.Message): - r"""The metadata of a - [Document][google.cloud.discoveryengine.v1beta.Document]. + r"""The metadata of a `Document + `__. Attributes: matcher_value (google.cloud.discoveryengine_v1beta.types.BatchGetDocumentsMetadataResponse.DocumentMetadata.MatcherValue): - The value of the matcher that was used to match the - [Document][google.cloud.discoveryengine.v1beta.Document]. + The value of the matcher that was used to match + the `Document + `__. state (google.cloud.discoveryengine_v1beta.types.BatchGetDocumentsMetadataResponse.State): The state of the document. last_refreshed_time (google.protobuf.timestamp_pb2.Timestamp): The timestamp of the last time the - [Document][google.cloud.discoveryengine.v1beta.Document] was - last indexed. + `Document + `__ + was last indexed. data_ingestion_source (str): The data ingestion source of the - [Document][google.cloud.discoveryengine.v1beta.Document]. + `Document + `__. Allowed values are: - - ``batch``: Data ingested via Batch API, e.g., - ImportDocuments. - - ``streaming`` Data ingested via Streaming API, e.g., FHIR - streaming. + * ``batch``: Data ingested via Batch API, e.g., + ImportDocuments. * ``streaming`` Data ingested + via Streaming API, e.g., FHIR streaming. """ class MatcherValue(proto.Message): r"""The value of the matcher that was used to match the - [Document][google.cloud.discoveryengine.v1beta.Document]. + `Document `__. This message has `oneof`_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. @@ -440,11 +484,13 @@ class MatcherValue(proto.Message): Attributes: uri (str): If match by URI, the URI of the - [Document][google.cloud.discoveryengine.v1beta.Document]. + `Document + `__. This field is a member of `oneof`_ ``matcher_value``. fhir_resource (str): Format: + projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} This field is a member of `oneof`_ ``matcher_value``. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/engine.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/engine.py index ae9bd23a98af..896d7fe52521 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/engine.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/engine.py @@ -31,8 +31,8 @@ class Engine(proto.Message): - r"""Metadata that describes the training and serving parameters of an - [Engine][google.cloud.discoveryengine.v1beta.Engine]. + r"""Metadata that describes the training and serving parameters of + an `Engine `__. This message has `oneof`_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. @@ -43,38 +43,46 @@ class Engine(proto.Message): Attributes: chat_engine_config (google.cloud.discoveryengine_v1beta.types.Engine.ChatEngineConfig): - Configurations for the Chat Engine. Only applicable if - [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type] + Configurations for the Chat Engine. Only + applicable if `solution_type + `__ is - [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT]. + `SOLUTION_TYPE_CHAT + `__. This field is a member of `oneof`_ ``engine_config``. search_engine_config (google.cloud.discoveryengine_v1beta.types.Engine.SearchEngineConfig): - Configurations for the Search Engine. Only applicable if - [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type] + Configurations for the Search Engine. Only + applicable if `solution_type + `__ is - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH]. + `SOLUTION_TYPE_SEARCH + `__. This field is a member of `oneof`_ ``engine_config``. chat_engine_metadata (google.cloud.discoveryengine_v1beta.types.Engine.ChatEngineMetadata): - Output only. Additional information of the Chat Engine. Only - applicable if - [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type] + Output only. Additional information of the Chat + Engine. Only applicable if + `solution_type + `__ is - [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT]. + `SOLUTION_TYPE_CHAT + `__. This field is a member of `oneof`_ ``engine_metadata``. name (str): - Immutable. The fully qualified resource name of the engine. - - This field must be a UTF-8 encoded string with a length - limit of 1024 characters. + Immutable. The fully qualified resource name of + the engine. + This field must be a UTF-8 encoded string with a + length limit of 1024 characters. Format: + ``projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`` - engine should be 1-63 characters, and valid characters are - /[a-z0-9][a-z0-9-\_]*/. Otherwise, an INVALID_ARGUMENT error - is returned. + engine should be 1-63 characters, and valid + characters are /`a-z0-9 `__*/. + Otherwise, an INVALID_ARGUMENT error is + returned. display_name (str): Required. The display name of the engine. Should be human readable. UTF-8 encoded string @@ -89,34 +97,41 @@ class Engine(proto.Message): The data stores associated with this engine. For - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH] + `SOLUTION_TYPE_SEARCH + `__ and - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION] - type of engines, they can only associate with at most one - data store. + `SOLUTION_TYPE_RECOMMENDATION + `__ + type of engines, they can only associate with at + most one data store. If - [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type] + `solution_type + `__ is - [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT], - multiple - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s - in the same - [Collection][google.cloud.discoveryengine.v1beta.Collection] + `SOLUTION_TYPE_CHAT + `__, + multiple `DataStore + `__s + in the same `Collection + `__ can be associated here. Note that when used in - [CreateEngineRequest][google.cloud.discoveryengine.v1beta.CreateEngineRequest], - one DataStore id must be provided as the system will use it - for necessary initializations. + `CreateEngineRequest + `__, + one DataStore id must be provided as the system + will use it for necessary initializations. solution_type (google.cloud.discoveryengine_v1beta.types.SolutionType): Required. The solutions of the engine. industry_vertical (google.cloud.discoveryengine_v1beta.types.IndustryVertical): - The industry vertical that the engine registers. The - restriction of the Engine industry vertical is based on - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]: - If unspecified, default to ``GENERIC``. Vertical on Engine - has to match vertical of the DataStore linked to the engine. + The industry vertical that the engine registers. + The restriction of the Engine industry vertical + is based on `DataStore + `__: + If unspecified, default to ``GENERIC``. Vertical + on Engine has to match vertical of the DataStore + linked to the engine. common_config (google.cloud.discoveryengine_v1beta.types.Engine.CommonConfig): Common config spec that specifies the metadata of the engine. @@ -132,11 +147,13 @@ class SearchEngineConfig(proto.Message): search_tier (google.cloud.discoveryengine_v1beta.types.SearchTier): The search feature tier of this engine. - Different tiers might have different pricing. To learn more, - check the pricing documentation. + Different tiers might have different + pricing. To learn more, check the pricing + documentation. Defaults to - [SearchTier.SEARCH_TIER_STANDARD][google.cloud.discoveryengine.v1beta.SearchTier.SEARCH_TIER_STANDARD] + `SearchTier.SEARCH_TIER_STANDARD + `__ if not specified. search_add_ons (MutableSequence[google.cloud.discoveryengine_v1beta.types.SearchAddOn]): The add-on that this search engine enables. @@ -158,44 +175,53 @@ class ChatEngineConfig(proto.Message): Attributes: agent_creation_config (google.cloud.discoveryengine_v1beta.types.Engine.ChatEngineConfig.AgentCreationConfig): - The configurationt generate the Dialogflow agent that is - associated to this Engine. - - Note that these configurations are one-time consumed by and - passed to Dialogflow service. It means they cannot be - retrieved using - [EngineService.GetEngine][google.cloud.discoveryengine.v1beta.EngineService.GetEngine] + The configurationt generate the Dialogflow agent + that is associated to this Engine. + + Note that these configurations are one-time + consumed by and passed to Dialogflow service. It + means they cannot be retrieved using + `EngineService.GetEngine + `__ or - [EngineService.ListEngines][google.cloud.discoveryengine.v1beta.EngineService.ListEngines] + `EngineService.ListEngines + `__ API after engine creation. dialogflow_agent_to_link (str): - The resource name of an exist Dialogflow agent to link to - this Chat Engine. Customers can either provide - ``agent_creation_config`` to create agent or provide an - agent name that links the agent with the Chat engine. - - Format: - ``projects//locations//agents/``. - - Note that the ``dialogflow_agent_to_link`` are one-time - consumed by and passed to Dialogflow service. It means they - cannot be retrieved using - [EngineService.GetEngine][google.cloud.discoveryengine.v1beta.EngineService.GetEngine] + The resource name of an exist Dialogflow agent + to link to this Chat Engine. Customers can + either provide ``agent_creation_config`` to + create agent or provide an agent name that links + the agent with the Chat engine. + + Format: ``projects//locations//agents/``. + + Note that the ``dialogflow_agent_to_link`` are + one-time consumed by and passed to Dialogflow + service. It means they cannot be retrieved using + `EngineService.GetEngine + `__ or - [EngineService.ListEngines][google.cloud.discoveryengine.v1beta.EngineService.ListEngines] + `EngineService.ListEngines + `__ API after engine creation. Use - [ChatEngineMetadata.dialogflow_agent][google.cloud.discoveryengine.v1beta.Engine.ChatEngineMetadata.dialogflow_agent] - for actual agent association after Engine is created. + `ChatEngineMetadata.dialogflow_agent + `__ + for actual agent association after Engine is + created. """ class AgentCreationConfig(proto.Message): r"""Configurations for generating a Dialogflow agent. - Note that these configurations are one-time consumed by and passed - to Dialogflow service. It means they cannot be retrieved using - [EngineService.GetEngine][google.cloud.discoveryengine.v1beta.EngineService.GetEngine] + Note that these configurations are one-time consumed by and + passed to Dialogflow service. It means they cannot be retrieved + using `EngineService.GetEngine + `__ or - [EngineService.ListEngines][google.cloud.discoveryengine.v1beta.EngineService.ListEngines] + `EngineService.ListEngines + `__ API after engine creation. Attributes: @@ -205,13 +231,16 @@ class AgentCreationConfig(proto.Message): knowledge connector LLM prompt and for knowledge search. default_language_code (str): - Required. The default language of the agent as a language - tag. See `Language - Support `__ - for a list of the currently supported language codes. + Required. The default language of the agent as a + language tag. See `Language + Support + `__ + for a list of the currently supported language + codes. time_zone (str): - Required. The time zone of the agent from the `time zone - database `__, e.g., + Required. The time zone of the agent from the + `time zone database + `__, e.g., America/New_York, Europe/Paris. location (str): Agent location for Agent creation, supported @@ -271,11 +300,11 @@ class ChatEngineMetadata(proto.Message): Attributes: dialogflow_agent (str): - The resource name of a Dialogflow agent, that this Chat - Engine refers to. + The resource name of a Dialogflow agent, that + this Chat Engine refers to. - Format: - ``projects//locations//agents/``. + Format: ``projects//locations//agents/``. """ dialogflow_agent: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/engine_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/engine_service.py index da3b04f82745..49fd104b4cde 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/engine_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/engine_service.py @@ -45,7 +45,8 @@ class CreateEngineRequest(proto.Message): r"""Request for - [EngineService.CreateEngine][google.cloud.discoveryengine.v1beta.EngineService.CreateEngine] + `EngineService.CreateEngine + `__ method. Attributes: @@ -53,20 +54,23 @@ class CreateEngineRequest(proto.Message): Required. The parent resource name, such as ``projects/{project}/locations/{location}/collections/{collection}``. engine (google.cloud.discoveryengine_v1beta.types.Engine): - Required. The - [Engine][google.cloud.discoveryengine.v1beta.Engine] to - create. + Required. The `Engine + `__ + to create. engine_id (str): Required. The ID to use for the - [Engine][google.cloud.discoveryengine.v1beta.Engine], which - will become the final component of the - [Engine][google.cloud.discoveryengine.v1beta.Engine]'s + `Engine + `__, + which will become the final component of the + `Engine + `__'s resource name. - This field must conform to - `RFC-1034 `__ standard - with a length limit of 63 characters. Otherwise, an - INVALID_ARGUMENT error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 characters. + Otherwise, an INVALID_ARGUMENT error is + returned. """ parent: str = proto.Field( @@ -86,7 +90,8 @@ class CreateEngineRequest(proto.Message): class CreateEngineMetadata(proto.Message): r"""Metadata related to the progress of the - [EngineService.CreateEngine][google.cloud.discoveryengine.v1beta.EngineService.CreateEngine] + `EngineService.CreateEngine + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -112,23 +117,28 @@ class CreateEngineMetadata(proto.Message): class DeleteEngineRequest(proto.Message): r"""Request message for - [EngineService.DeleteEngine][google.cloud.discoveryengine.v1beta.EngineService.DeleteEngine] + `EngineService.DeleteEngine + `__ method. Attributes: name (str): Required. Full resource name of - [Engine][google.cloud.discoveryengine.v1beta.Engine], such - as + `Engine + `__, + such as ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. - If the caller does not have permission to delete the - [Engine][google.cloud.discoveryengine.v1beta.Engine], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. + If the caller does not have permission to delete + the `Engine + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. - If the [Engine][google.cloud.discoveryengine.v1beta.Engine] - to delete does not exist, a NOT_FOUND error is returned. + If the `Engine + `__ + to delete does not exist, a NOT_FOUND error is + returned. """ name: str = proto.Field( @@ -139,7 +149,8 @@ class DeleteEngineRequest(proto.Message): class DeleteEngineMetadata(proto.Message): r"""Metadata related to the progress of the - [EngineService.DeleteEngine][google.cloud.discoveryengine.v1beta.EngineService.DeleteEngine] + `EngineService.DeleteEngine + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -165,14 +176,16 @@ class DeleteEngineMetadata(proto.Message): class GetEngineRequest(proto.Message): r"""Request message for - [EngineService.GetEngine][google.cloud.discoveryengine.v1beta.EngineService.GetEngine] + `EngineService.GetEngine + `__ method. Attributes: name (str): Required. Full resource name of - [Engine][google.cloud.discoveryengine.v1beta.Engine], such - as + `Engine + `__, + such as ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. """ @@ -184,7 +197,8 @@ class GetEngineRequest(proto.Message): class ListEnginesRequest(proto.Message): r"""Request message for - [EngineService.ListEngines][google.cloud.discoveryengine.v1beta.EngineService.ListEngines] + `EngineService.ListEngines + `__ method. Attributes: @@ -220,13 +234,14 @@ class ListEnginesRequest(proto.Message): class ListEnginesResponse(proto.Message): r"""Response message for - [EngineService.ListEngines][google.cloud.discoveryengine.v1beta.EngineService.ListEngines] + `EngineService.ListEngines + `__ method. Attributes: engines (MutableSequence[google.cloud.discoveryengine_v1beta.types.Engine]): - All the customer's - [Engine][google.cloud.discoveryengine.v1beta.Engine]s. + All the customer's `Engine + `__s. next_page_token (str): Not supported. """ @@ -248,29 +263,34 @@ def raw_page(self): class UpdateEngineRequest(proto.Message): r"""Request message for - [EngineService.UpdateEngine][google.cloud.discoveryengine.v1beta.EngineService.UpdateEngine] + `EngineService.UpdateEngine + `__ method. Attributes: engine (google.cloud.discoveryengine_v1beta.types.Engine): - Required. The - [Engine][google.cloud.discoveryengine.v1beta.Engine] to - update. - - If the caller does not have permission to update the - [Engine][google.cloud.discoveryengine.v1beta.Engine], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. - - If the [Engine][google.cloud.discoveryengine.v1beta.Engine] - to update does not exist, a NOT_FOUND error is returned. + Required. The `Engine + `__ + to update. + + If the caller does not have permission to update + the `Engine + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. + + If the `Engine + `__ + to update does not exist, a NOT_FOUND error is + returned. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [Engine][google.cloud.discoveryengine.v1beta.Engine] to - update. + `Engine + `__ + to update. - If an unsupported or unknown field is provided, an - INVALID_ARGUMENT error is returned. + If an unsupported or unknown field is provided, + an INVALID_ARGUMENT error is returned. """ engine: gcd_engine.Engine = proto.Field( @@ -290,7 +310,9 @@ class PauseEngineRequest(proto.Message): Attributes: name (str): - Required. The name of the engine to pause. Format: + Required. The name of the engine to pause. + Format: + ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`` """ @@ -305,7 +327,9 @@ class ResumeEngineRequest(proto.Message): Attributes: name (str): - Required. The name of the engine to resume. Format: + Required. The name of the engine to resume. + Format: + ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`` """ @@ -321,7 +345,9 @@ class TuneEngineRequest(proto.Message): Attributes: name (str): - Required. The resource name of the engine to tune. Format: + Required. The resource name of the engine to + tune. Format: + ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`` """ @@ -336,8 +362,9 @@ class TuneEngineMetadata(proto.Message): Attributes: engine (str): - Required. The resource name of the engine that this tune - applies to. Format: + Required. The resource name of the engine that + this tune applies to. Format: + ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`` """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/evaluation.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/evaluation.py index 3eaa5a067c45..c3bdcddcb456 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/evaluation.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/evaluation.py @@ -40,23 +40,25 @@ class Evaluation(proto.Message): Attributes: name (str): Identifier. The full resource name of the - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation], + `Evaluation + `__, in the format of ``projects/{project}/locations/{location}/evaluations/{evaluation}``. - This field must be a UTF-8 encoded string with a length - limit of 1024 characters. + This field must be a UTF-8 encoded string with a + length limit of 1024 characters. evaluation_spec (google.cloud.discoveryengine_v1beta.types.Evaluation.EvaluationSpec): Required. The specification of the evaluation. quality_metrics (google.cloud.discoveryengine_v1beta.types.QualityMetrics): - Output only. The metrics produced by the evaluation, - averaged across all - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s - in the - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]. - - Only populated when the evaluation's state is SUCCEEDED. + Output only. The metrics produced by the + evaluation, averaged across all `SampleQuery + `__s + in the `SampleQuerySet + `__. + + Only populated when the evaluation's state is + SUCCEEDED. state (google.cloud.discoveryengine_v1beta.types.Evaluation.State): Output only. The state of the evaluation. error (google.rpc.status_pb2.Status): @@ -65,11 +67,13 @@ class Evaluation(proto.Message): state is FAILED. create_time (google.protobuf.timestamp_pb2.Timestamp): Output only. Timestamp the - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation] + `Evaluation + `__ was created at. end_time (google.protobuf.timestamp_pb2.Timestamp): Output only. Timestamp the - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation] + `Evaluation + `__ was completed at. error_samples (MutableSequence[google.rpc.status_pb2.Status]): Output only. A sample of errors encountered @@ -105,20 +109,29 @@ class EvaluationSpec(proto.Message): Attributes: search_request (google.cloud.discoveryengine_v1beta.types.SearchRequest): - Required. The search request that is used to perform the - evaluation. - - Only the following fields within SearchRequest are - supported; if any other fields are provided, an UNSUPPORTED - error will be returned: - - - [SearchRequest.serving_config][google.cloud.discoveryengine.v1beta.SearchRequest.serving_config] - - [SearchRequest.branch][google.cloud.discoveryengine.v1beta.SearchRequest.branch] - - [SearchRequest.canonical_filter][google.cloud.discoveryengine.v1beta.SearchRequest.canonical_filter] - - [SearchRequest.query_expansion_spec][google.cloud.discoveryengine.v1beta.SearchRequest.query_expansion_spec] - - [SearchRequest.spell_correction_spec][google.cloud.discoveryengine.v1beta.SearchRequest.spell_correction_spec] - - [SearchRequest.content_search_spec][google.cloud.discoveryengine.v1beta.SearchRequest.content_search_spec] - - [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id] + Required. The search request that is used to + perform the evaluation. + Only the following fields within SearchRequest + are supported; if any other fields are provided, + an UNSUPPORTED error will be returned: + + * `SearchRequest.serving_config + `__ + * `SearchRequest.branch + `__ + + * `SearchRequest.canonical_filter + `__ + * `SearchRequest.query_expansion_spec + `__ + + * `SearchRequest.spell_correction_spec + `__ + * `SearchRequest.content_search_spec + `__ + + * `SearchRequest.user_pseudo_id + `__ This field is a member of `oneof`_ ``search_spec``. query_set_spec (google.cloud.discoveryengine_v1beta.types.Evaluation.EvaluationSpec.QuerySetSpec): @@ -131,7 +144,8 @@ class QuerySetSpec(proto.Message): Attributes: sample_query_set (str): Required. The full resource name of the - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] + `SampleQuerySet + `__ used for the evaluation, in the format of ``projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}``. """ @@ -199,81 +213,98 @@ class QualityMetrics(proto.Message): Attributes: doc_recall (google.cloud.discoveryengine_v1beta.types.QualityMetrics.TopkMetrics): - Recall per document, at various top-k cutoff levels. - - Recall is the fraction of relevant documents retrieved out - of all relevant documents. + Recall per document, at various top-k cutoff + levels. + Recall is the fraction of relevant documents + retrieved out of all relevant documents. Example (top-5): - - For a single - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], - If 3 out of 5 relevant documents are retrieved in the - top-5, recall@5 = 3/5 = 0.6 + * For a single + `SampleQuery + `__, + If 3 out of 5 relevant documents are retrieved + in the top-5, recall@5 = 3/5 = 0.6 doc_precision (google.cloud.discoveryengine_v1beta.types.QualityMetrics.TopkMetrics): - Precision per document, at various top-k cutoff levels. - - Precision is the fraction of retrieved documents that are - relevant. + Precision per document, at various top-k cutoff + levels. + Precision is the fraction of retrieved documents + that are relevant. Example (top-5): - - For a single - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], - If 4 out of 5 retrieved documents in the top-5 are - relevant, precision@5 = 4/5 = 0.8 + * For a single + `SampleQuery + `__, + If 4 out of 5 retrieved documents in the top-5 + are relevant, precision@5 = 4/5 = 0.8 doc_ndcg (google.cloud.discoveryengine_v1beta.types.QualityMetrics.TopkMetrics): - Normalized discounted cumulative gain (NDCG) per document, - at various top-k cutoff levels. + Normalized discounted cumulative gain (NDCG) per + document, at various top-k cutoff levels. - NDCG measures the ranking quality, giving higher relevance - to top results. + NDCG measures the ranking quality, giving higher + relevance to top results. - Example (top-3): Suppose - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] - with three retrieved documents (D1, D2, D3) and binary - relevance judgements (1 for relevant, 0 for not relevant): + Example (top-3): - Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), - D3 (0)] + Suppose `SampleQuery + `__ + with three retrieved documents (D1, D2, D3) and + binary relevance judgements (1 for relevant, 0 + for not relevant): - Calculate NDCG@3 for each - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]: - \* DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 \* - Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 - \* NDCG@3: 1.13/1.63 = 0.693 + Retrieved: [D3 (0), D1 (1), D2 (1)] + Ideal: [D1 (1), D2 (1), D3 (0)] + + Calculate NDCG@3 for each + `SampleQuery + `__: + + * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) + = 1.13 * Ideal DCG@3: 1/log2(1+1) + + 1/log2(2+1) + 0/log2(3+1) = 1.63 + + * NDCG@3: 1.13/1.63 = 0.693 page_recall (google.cloud.discoveryengine_v1beta.types.QualityMetrics.TopkMetrics): Recall per page, at various top-k cutoff levels. - Recall is the fraction of relevant pages retrieved out of - all relevant pages. + Recall is the fraction of relevant pages + retrieved out of all relevant pages. Example (top-5): - - For a single - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], - if 3 out of 5 relevant pages are retrieved in the top-5, - recall@5 = 3/5 = 0.6 + * For a single + `SampleQuery + `__, + if 3 out of 5 relevant pages are retrieved in + the top-5, recall@5 = 3/5 = 0.6 page_ndcg (google.cloud.discoveryengine_v1beta.types.QualityMetrics.TopkMetrics): - Normalized discounted cumulative gain (NDCG) per page, at - various top-k cutoff levels. + Normalized discounted cumulative gain (NDCG) per + page, at various top-k cutoff levels. + + NDCG measures the ranking quality, giving higher + relevance to top results. + + Example (top-3): + + Suppose `SampleQuery + `__ + with three retrieved pages (P1, P2, P3) and + binary relevance judgements (1 for relevant, 0 + for not relevant): - NDCG measures the ranking quality, giving higher relevance - to top results. + Retrieved: [P3 (0), P1 (1), P2 (1)] + Ideal: [P1 (1), P2 (1), P3 (0)] - Example (top-3): Suppose - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] - with three retrieved pages (P1, P2, P3) and binary relevance - judgements (1 for relevant, 0 for not relevant): + Calculate NDCG@3 for + `SampleQuery + `__: - Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), - P3 (0)] + * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) + = 1.13 * Ideal DCG@3: 1/log2(1+1) + + 1/log2(2+1) + 0/log2(3+1) = 1.63 - Calculate NDCG@3 for - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]: - \* DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 \* - Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 - \* NDCG@3: 1.13/1.63 = 0.693 + * NDCG@3: 1.13/1.63 = 0.693 """ class TopkMetrics(proto.Message): diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/evaluation_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/evaluation_service.py index 5f46e95ab5ac..f8ebd158ca8f 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/evaluation_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/evaluation_service.py @@ -38,23 +38,27 @@ class GetEvaluationRequest(proto.Message): r"""Request message for - [EvaluationService.GetEvaluation][google.cloud.discoveryengine.v1beta.EvaluationService.GetEvaluation] + `EvaluationService.GetEvaluation + `__ method. Attributes: name (str): Required. Full resource name of - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation], + `Evaluation + `__, such as ``projects/{project}/locations/{location}/evaluations/{evaluation}``. - If the caller does not have permission to access the - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. + If the caller does not have permission to access + the `Evaluation + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. If the requested - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation] + `Evaluation + `__ does not exist, a NOT_FOUND error is returned. """ @@ -66,38 +70,48 @@ class GetEvaluationRequest(proto.Message): class ListEvaluationsRequest(proto.Message): r"""Request message for - [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluations] + `EvaluationService.ListEvaluations + `__ method. Attributes: parent (str): - Required. The parent location resource name, such as + Required. The parent location resource name, + such as ``projects/{project}/locations/{location}``. If the caller does not have permission to list - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]s - under this location, regardless of whether or not this - location exists, a ``PERMISSION_DENIED`` error is returned. + `Evaluation + `__s + under this location, regardless of whether or + not this location exists, a + ``PERMISSION_DENIED`` error is returned. page_size (int): Maximum number of - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]s - to return. If unspecified, defaults to 100. The maximum - allowed value is 1000. Values above 1000 will be coerced to - 1000. - - If this field is negative, an ``INVALID_ARGUMENT`` error is - returned. + `Evaluation + `__s + to return. If unspecified, defaults to 100. The + maximum allowed value is 1000. Values above 1000 + will be coerced to 1000. + + If this field is negative, an + ``INVALID_ARGUMENT`` error is returned. page_token (str): A page token - [ListEvaluationsResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListEvaluationsResponse.next_page_token], + `ListEvaluationsResponse.next_page_token + `__, received from a previous - [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluations] - call. Provide this to retrieve the subsequent page. - - When paginating, all other parameters provided to - [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluations] - must match the call that provided the page token. Otherwise, - an ``INVALID_ARGUMENT`` error is returned. + `EvaluationService.ListEvaluations + `__ + call. Provide this to retrieve the subsequent + page. + + When paginating, all other parameters provided + to `EvaluationService.ListEvaluations + `__ + must match the call that provided the page + token. Otherwise, an ``INVALID_ARGUMENT`` error + is returned. """ parent: str = proto.Field( @@ -116,18 +130,20 @@ class ListEvaluationsRequest(proto.Message): class ListEvaluationsResponse(proto.Message): r"""Response message for - [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluations] + `EvaluationService.ListEvaluations + `__ method. Attributes: evaluations (MutableSequence[google.cloud.discoveryengine_v1beta.types.Evaluation]): - The - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]s. + The `Evaluation + `__s. next_page_token (str): A token that can be sent as - [ListEvaluationsRequest.page_token][google.cloud.discoveryengine.v1beta.ListEvaluationsRequest.page_token] - to retrieve the next page. If this field is omitted, there - are no subsequent pages. + `ListEvaluationsRequest.page_token + `__ + to retrieve the next page. If this field is + omitted, there are no subsequent pages. """ @property @@ -147,7 +163,8 @@ def raw_page(self): class CreateEvaluationRequest(proto.Message): r"""Request message for - [EvaluationService.CreateEvaluation][google.cloud.discoveryengine.v1beta.EvaluationService.CreateEvaluation] + `EvaluationService.CreateEvaluation + `__ method. Attributes: @@ -155,8 +172,8 @@ class CreateEvaluationRequest(proto.Message): Required. The parent resource name, such as ``projects/{project}/locations/{location}``. evaluation (google.cloud.discoveryengine_v1beta.types.Evaluation): - Required. The - [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation] + Required. The `Evaluation + `__ to create. """ @@ -173,7 +190,8 @@ class CreateEvaluationRequest(proto.Message): class CreateEvaluationMetadata(proto.Message): r"""Metadata for - [EvaluationService.CreateEvaluation][google.cloud.discoveryengine.v1beta.EvaluationService.CreateEvaluation] + `EvaluationService.CreateEvaluation + `__ method. """ @@ -181,7 +199,8 @@ class CreateEvaluationMetadata(proto.Message): class ListEvaluationResultsRequest(proto.Message): r"""Request message for - [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults] + `EvaluationService.ListEvaluationResults + `__ method. Attributes: @@ -190,27 +209,34 @@ class ListEvaluationResultsRequest(proto.Message): ``projects/{project}/locations/{location}/evaluations/{evaluation}``. If the caller does not have permission to list - [EvaluationResult][] under this evaluation, regardless of - whether or not this evaluation set exists, a - ``PERMISSION_DENIED`` error is returned. + [EvaluationResult][] under this evaluation, + regardless of whether or not this evaluation set + exists, a ``PERMISSION_DENIED`` error is + returned. page_size (int): - Maximum number of [EvaluationResult][] to return. If - unspecified, defaults to 100. The maximum allowed value is - 1000. Values above 1000 will be coerced to 1000. + Maximum number of [EvaluationResult][] to + return. If unspecified, defaults to 100. The + maximum allowed value is 1000. Values above 1000 + will be coerced to 1000. - If this field is negative, an ``INVALID_ARGUMENT`` error is - returned. + If this field is negative, an + ``INVALID_ARGUMENT`` error is returned. page_token (str): A page token - [ListEvaluationResultsResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListEvaluationResultsResponse.next_page_token], + `ListEvaluationResultsResponse.next_page_token + `__, received from a previous - [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults] - call. Provide this to retrieve the subsequent page. - - When paginating, all other parameters provided to - [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults] - must match the call that provided the page token. Otherwise, - an ``INVALID_ARGUMENT`` error is returned. + `EvaluationService.ListEvaluationResults + `__ + call. Provide this to retrieve the subsequent + page. + + When paginating, all other parameters provided + to `EvaluationService.ListEvaluationResults + `__ + must match the call that provided the page + token. Otherwise, an ``INVALID_ARGUMENT`` error + is returned. """ evaluation: str = proto.Field( @@ -229,33 +255,38 @@ class ListEvaluationResultsRequest(proto.Message): class ListEvaluationResultsResponse(proto.Message): r"""Response message for - [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults] + `EvaluationService.ListEvaluationResults + `__ method. Attributes: evaluation_results (MutableSequence[google.cloud.discoveryengine_v1beta.types.ListEvaluationResultsResponse.EvaluationResult]): The - [EvaluationResult][google.cloud.discoveryengine.v1beta.ListEvaluationResultsResponse.EvaluationResult]s. + `EvaluationResult + `__s. next_page_token (str): A token that can be sent as - [ListEvaluationResultsRequest.page_token][google.cloud.discoveryengine.v1beta.ListEvaluationResultsRequest.page_token] - to retrieve the next page. If this field is omitted, there - are no subsequent pages. + `ListEvaluationResultsRequest.page_token + `__ + to retrieve the next page. If this field is + omitted, there are no subsequent pages. """ class EvaluationResult(proto.Message): r"""Represents the results of an evaluation for a single - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]. + `SampleQuery + `__. Attributes: sample_query (google.cloud.discoveryengine_v1beta.types.SampleQuery): Output only. The - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] + `SampleQuery + `__ that was evaluated. quality_metrics (google.cloud.discoveryengine_v1beta.types.QualityMetrics): - Output only. The metrics produced by the evaluation, for a - given - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]. + Output only. The metrics produced by the + evaluation, for a given `SampleQuery + `__. """ sample_query: gcd_sample_query.SampleQuery = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/grounded_generation_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/grounded_generation_service.py index e17521198310..5f209fe1a0c0 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/grounded_generation_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/grounded_generation_service.py @@ -40,13 +40,13 @@ class GroundedGenerationContent(proto.Message): Attributes: role (str): - Producer of the content. Must be either ``user`` or - ``model``. - - Intended to be used for multi-turn conversations. Otherwise, - it can be left unset. + Producer of the content. Must be either ``user`` + or ``model``. + Intended to be used for multi-turn + conversations. Otherwise, it can be left unset. parts (MutableSequence[google.cloud.discoveryengine_v1beta.types.GroundedGenerationContent.Part]): - Ordered ``Parts`` that constitute a single message. + Ordered ``Parts`` that constitute a single + message. """ class Part(proto.Message): @@ -86,7 +86,8 @@ class GenerateGroundedContentRequest(proto.Message): location (str): Required. Location resource. - Format: ``projects/{project}/locations/{location}``. + Format: + ``projects/{project}/locations/{location}``. system_instruction (google.cloud.discoveryengine_v1beta.types.GroundedGenerationContent): Content of the system instruction for the current API. @@ -105,26 +106,32 @@ class GenerateGroundedContentRequest(proto.Message): grounding_spec (google.cloud.discoveryengine_v1beta.types.GenerateGroundedContentRequest.GroundingSpec): Grounding specification. user_labels (MutableMapping[str, str]): - The user labels applied to a resource must meet the - following requirements: - - - Each resource can have multiple labels, up to a maximum of - 64. - - Each label must be a key-value pair. - - Keys have a minimum length of 1 character and a maximum - length of 63 characters and cannot be empty. Values can be - empty and have a maximum length of 63 characters. - - Keys and values can contain only lowercase letters, - numeric characters, underscores, and dashes. All - characters must use UTF-8 encoding, and international - characters are allowed. - - The key portion of a label must be unique. However, you - can use the same key with multiple resources. - - Keys must start with a lowercase letter or international - character. + The user labels applied to a resource must meet + the following requirements: + * Each resource can have multiple labels, up to + a maximum of 64. + + * Each label must be a key-value pair. + * Keys have a minimum length of 1 character and + a maximum length of 63 characters and cannot + be empty. Values can be empty and have a maximum + length of 63 characters. + + * Keys and values can contain only lowercase + letters, numeric characters, underscores, and + dashes. All characters must use UTF-8 encoding, + and international characters are allowed. + + * The key portion of a label must be unique. + However, you can use the same key with + multiple resources. + + * Keys must start with a lowercase letter or + international character. See `Google Cloud - Document `__ + Document + `__ for more details. """ @@ -138,8 +145,9 @@ class GenerationSpec(proto.Message): Specifies which Vertex model id to use for generation. language_code (str): - Language code for content. Use language tags defined by - `BCP47 `__. + Language code for content. Use language tags + defined by `BCP47 + `__. temperature (float): If specified, custom value for the temperature will be used. @@ -305,9 +313,10 @@ class InlineSource(proto.Message): attributes (MutableMapping[str, str]): Attributes associated with the content. - Common attributes include ``source`` (indicating where the - content was sourced from) and ``author`` (indicating the - author of the content). + Common attributes include ``source`` (indicating + where the content was sourced from) and + ``author`` (indicating the author of the + content). """ grounding_facts: MutableSequence[ @@ -331,6 +340,7 @@ class SearchSource(proto.Message): The resource name of the Engine to use. Format: + ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`` max_result_count (int): Number of search results to return. @@ -341,7 +351,8 @@ class SearchSource(proto.Message): Filter expression to be applied to the search. The syntax is the same as - [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter]. + `SearchRequest.filter + `__. safe_search (bool): If set, safe search is enabled in Vertex AI Search requests. @@ -468,8 +479,8 @@ class Candidate(proto.Message): content (google.cloud.discoveryengine_v1beta.types.GroundedGenerationContent): Content of the candidate. grounding_score (float): - The overall grounding score for the candidate, in the range - of [0, 1]. + The overall grounding score for the candidate, + in the range of [0, 1]. This field is a member of `oneof`_ ``_grounding_score``. grounding_metadata (google.cloud.discoveryengine_v1beta.types.GenerateGroundedContentResponse.Candidate.GroundingMetadata): @@ -570,12 +581,13 @@ class DynamicRetrievalPredictorMetadata(proto.Message): The version of the predictor which was used in dynamic retrieval. prediction (float): - The value of the predictor. This should be between [0, 1] - where a value of 0 means that the query would not benefit - from grounding, while a value of 1.0 means that the query - would benefit the most. In between values allow to - differentiate between different usefulness scores for - grounding. + The value of the predictor. This should be + between [0, 1] where a value of 0 means that the + query would not benefit from grounding, while a + value of 1.0 means that the query would benefit + the most. In between values allow to + differentiate between different usefulness + scores for grounding. This field is a member of `oneof`_ ``_prediction``. """ @@ -636,14 +648,17 @@ class GroundingSupport(proto.Message): Text for the claim in the candidate. Always provided when a support is found. support_chunk_indices (MutableSequence[int]): - A list of indices (into 'support_chunks') specifying the - citations associated with the claim. For instance [1,3,4] - means that support_chunks[1], support_chunks[3], - support_chunks[4] are the chunks attributed to the claim. + A list of indices (into 'support_chunks') + specifying the citations associated with the + claim. For instance [1,3,4] means that + support_chunks[1], support_chunks[3], + support_chunks[4] are the chunks attributed to + the claim. support_score (float): - A score in the range of [0, 1] describing how grounded is a - specific claim in the support chunks indicated. Higher value - means that the claim is better supported by the chunks. + A score in the range of [0, 1] describing how + grounded is a specific claim in the support + chunks indicated. Higher value means that the + claim is better supported by the chunks. This field is a member of `oneof`_ ``_support_score``. """ @@ -725,12 +740,13 @@ class CheckGroundingSpec(proto.Message): Attributes: citation_threshold (float): - The threshold (in [0,1]) used for determining whether a fact - must be cited for a claim in the answer candidate. Choosing - a higher threshold will lead to fewer but very strong - citations, while choosing a lower threshold may lead to more - but somewhat weaker citations. If unset, the threshold will - default to 0.6. + The threshold (in [0,1]) used for determining + whether a fact must be cited for a claim in the + answer candidate. Choosing a higher threshold + will lead to fewer but very strong citations, + while choosing a lower threshold may lead to + more but somewhat weaker citations. If unset, + the threshold will default to 0.6. This field is a member of `oneof`_ ``_citation_threshold``. """ @@ -744,12 +760,14 @@ class CheckGroundingSpec(proto.Message): class CheckGroundingRequest(proto.Message): r"""Request message for - [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1beta.GroundedGenerationService.CheckGrounding] + `GroundedGenerationService.CheckGrounding + `__ method. Attributes: grounding_config (str): - Required. The resource name of the grounding config, such as + Required. The resource name of the grounding + config, such as ``projects/*/locations/global/groundingConfigs/default_grounding_config``. answer_candidate (str): Answer candidate to check. It can have a @@ -760,26 +778,32 @@ class CheckGroundingRequest(proto.Message): grounding_spec (google.cloud.discoveryengine_v1beta.types.CheckGroundingSpec): Configuration of the grounding check. user_labels (MutableMapping[str, str]): - The user labels applied to a resource must meet the - following requirements: - - - Each resource can have multiple labels, up to a maximum of - 64. - - Each label must be a key-value pair. - - Keys have a minimum length of 1 character and a maximum - length of 63 characters and cannot be empty. Values can be - empty and have a maximum length of 63 characters. - - Keys and values can contain only lowercase letters, - numeric characters, underscores, and dashes. All - characters must use UTF-8 encoding, and international - characters are allowed. - - The key portion of a label must be unique. However, you - can use the same key with multiple resources. - - Keys must start with a lowercase letter or international - character. + The user labels applied to a resource must meet + the following requirements: + * Each resource can have multiple labels, up to + a maximum of 64. + + * Each label must be a key-value pair. + * Keys have a minimum length of 1 character and + a maximum length of 63 characters and cannot + be empty. Values can be empty and have a maximum + length of 63 characters. + + * Keys and values can contain only lowercase + letters, numeric characters, underscores, and + dashes. All characters must use UTF-8 encoding, + and international characters are allowed. + + * The key portion of a label must be unique. + However, you can use the same key with + multiple resources. + + * Keys must start with a lowercase letter or + international character. See `Google Cloud - Document `__ + Document + `__ for more details. """ @@ -810,7 +834,8 @@ class CheckGroundingRequest(proto.Message): class CheckGroundingResponse(proto.Message): r"""Response message for the - [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1beta.GroundedGenerationService.CheckGrounding] + `GroundedGenerationService.CheckGrounding + `__ method. @@ -873,21 +898,27 @@ class Claim(proto.Message): Always provided regardless of whether citations or anti-citations are found. citation_indices (MutableSequence[int]): - A list of indices (into 'cited_chunks') specifying the - citations associated with the claim. For instance [1,3,4] - means that cited_chunks[1], cited_chunks[3], cited_chunks[4] - are the facts cited supporting for the claim. A citation to - a fact indicates that the claim is supported by the fact. + A list of indices (into 'cited_chunks') + specifying the citations associated with the + claim. For instance [1,3,4] means that + cited_chunks[1], cited_chunks[3], + cited_chunks[4] are the facts cited supporting + for the claim. A citation to a fact indicates + that the claim is supported by the fact. grounding_check_required (bool): - Indicates that this claim required grounding check. When the - system decided this claim doesn't require - attribution/grounding check, this field will be set to - false. In that case, no grounding check was done for the - claim and therefore - [citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.citation_indices], - [anti_citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.anti_citation_indices], + Indicates that this claim required grounding + check. When the system decided this claim + doesn't require attribution/grounding check, + this field will be set to false. In that case, + no grounding check was done for the claim and + therefore + `citation_indices + `__, + `anti_citation_indices + `__, and - [score][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.score] + `score + `__ should not be returned. This field is a member of `oneof`_ ``_grounding_check_required``. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/grounding.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/grounding.py index c0a16c4c7d73..76515a064d96 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/grounding.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/grounding.py @@ -34,7 +34,8 @@ class GroundingConfig(proto.Message): Attributes: name (str): - Required. Name of the GroundingConfig, of the form + Required. Name of the GroundingConfig, of the + form ``projects/{project}/locations/{location}/groundingConfigs/{grounding_config}``. """ @@ -52,10 +53,10 @@ class GroundingFact(proto.Message): Text content of the fact. Can be at most 10K characters long. attributes (MutableMapping[str, str]): - Attributes associated with the fact. Common attributes - include ``source`` (indicating where the fact was sourced - from), ``author`` (indicating the author of the fact), and - so on. + Attributes associated with the fact. + Common attributes include ``source`` (indicating + where the fact was sourced from), ``author`` + (indicating the author of the fact), and so on. """ fact_text: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/import_config.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/import_config.py index c1458f15a46d..662d0ae0e6aa 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/import_config.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/import_config.py @@ -67,44 +67,56 @@ class GcsSource(proto.Message): Attributes: input_uris (MutableSequence[str]): - Required. Cloud Storage URIs to input files. Each URI can be - up to 2000 characters long. URIs can match the full object - path (for example, ``gs://bucket/directory/object.json``) or - a pattern matching one or more files, such as + Required. Cloud Storage URIs to input files. + Each URI can be up to 2000 characters long. URIs + can match the full object path (for example, + ``gs://bucket/directory/object.json``) or a + pattern matching one or more files, such as ``gs://bucket/directory/*.json``. - A request can contain at most 100 files (or 100,000 files if - ``data_schema`` is ``content``). Each file can be up to 2 GB - (or 100 MB if ``data_schema`` is ``content``). + A request can contain at most 100 files (or + 100,000 files if ``data_schema`` is + ``content``). Each file can be up to 2 GB (or + 100 MB if ``data_schema`` is ``content``). data_schema (str): - The schema to use when parsing the data from the source. - + The schema to use when parsing the data from the + source. Supported values for document imports: - - ``document`` (default): One JSON - [Document][google.cloud.discoveryengine.v1beta.Document] - per line. Each document must have a valid - [Document.id][google.cloud.discoveryengine.v1beta.Document.id]. - - ``content``: Unstructured data (e.g. PDF, HTML). Each file - matched by ``input_uris`` becomes a document, with the ID - set to the first 128 bits of SHA256(URI) encoded as a hex - string. - - ``custom``: One custom data JSON per row in arbitrary - format that conforms to the defined - [Schema][google.cloud.discoveryengine.v1beta.Schema] of - the data store. This can only be used by the GENERIC Data - Store vertical. - - ``csv``: A CSV file with header conforming to the defined - [Schema][google.cloud.discoveryengine.v1beta.Schema] of - the data store. Each entry after the header is imported as - a Document. This can only be used by the GENERIC Data - Store vertical. + * ``document`` (default): One JSON + `Document + `__ + per line. Each document must + have a valid + `Document.id + `__. + + * ``content``: Unstructured data (e.g. PDF, + HTML). Each file matched by ``input_uris`` + becomes a document, with the ID set to the first + 128 bits of SHA256(URI) encoded as a hex + string. + + * ``custom``: One custom data JSON per row in + arbitrary format that conforms to the defined + `Schema + `__ + of the data store. This can only be used by + the GENERIC Data Store vertical. + + * ``csv``: A CSV file with header conforming to + the defined `Schema + `__ + of the data store. Each entry after the header + is imported as a Document. This can only be + used by the GENERIC Data Store vertical. Supported values for user event imports: - - ``user_event`` (default): One JSON - [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] - per line. + * ``user_event`` (default): One JSON + `UserEvent + `__ + per line. """ input_uris: MutableSequence[str] = proto.RepeatedField( @@ -124,8 +136,8 @@ class BigQuerySource(proto.Message): Attributes: partition_date (google.type.date_pb2.Date): - BigQuery time partitioned table's \_PARTITIONDATE in - YYYY-MM-DD format. + BigQuery time partitioned table's _PARTITIONDATE + in YYYY-MM-DD format. This field is a member of `oneof`_ ``partition``. project_id (str): @@ -147,29 +159,36 @@ class BigQuerySource(proto.Message): have the BigQuery export to a specific Cloud Storage directory. data_schema (str): - The schema to use when parsing the data from the source. - + The schema to use when parsing the data from the + source. Supported values for user event imports: - - ``user_event`` (default): One - [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] - per row. + * ``user_event`` (default): One + `UserEvent + `__ + per row. Supported values for document imports: - - ``document`` (default): One - [Document][google.cloud.discoveryengine.v1beta.Document] - format per row. Each document must have a valid - [Document.id][google.cloud.discoveryengine.v1beta.Document.id] - and one of - [Document.json_data][google.cloud.discoveryengine.v1beta.Document.json_data] - or - [Document.struct_data][google.cloud.discoveryengine.v1beta.Document.struct_data]. - - ``custom``: One custom data per row in arbitrary format - that conforms to the defined - [Schema][google.cloud.discoveryengine.v1beta.Schema] of - the data store. This can only be used by the GENERIC Data - Store vertical. + * ``document`` (default): One + `Document + `__ + format per row. Each document must have a + valid + `Document.id + `__ + and one of `Document.json_data + `__ + or + `Document.struct_data + `__. + + * ``custom``: One custom data per row in + arbitrary format that conforms to the defined + `Schema + `__ + of the data store. This can only be used by + the GENERIC Data Store vertical. """ partition_date: date_pb2.Date = proto.Field( @@ -219,9 +238,10 @@ class SpannerSource(proto.Message): Required. The table name of the Spanner database that needs to be imported. enable_data_boost (bool): - Whether to apply data boost on Spanner export. Enabling this - option will incur additional cost. More info can be found - `here `__. + Whether to apply data boost on Spanner export. + Enabling this option will incur additional cost. + More info can be found `here + `__. """ project_id: str = proto.Field( @@ -252,9 +272,9 @@ class BigtableOptions(proto.Message): Attributes: key_field_name (str): - The field name used for saving row key value in the - document. The name has to match the pattern - ``[a-zA-Z0-9][a-zA-Z0-9-_]*``. + The field name used for saving row key value in + the document. The name has to match the pattern + ```a-zA-Z0-9 `__*``. families (MutableMapping[str, google.cloud.discoveryengine_v1beta.types.BigtableOptions.BigtableColumnFamily]): The mapping from family names to an object that contains column families level information @@ -263,9 +283,11 @@ class BigtableOptions(proto.Message): """ class Type(proto.Enum): - r"""The type of values in a Bigtable column or column family. The values - are expected to be encoded using `HBase - Bytes.toBytes `__ + r"""The type of values in a Bigtable column or column family. + The values are expected to be encoded using + `HBase + Bytes.toBytes + `__ function when the encoding value is set to ``BINARY``. Values: @@ -315,25 +337,28 @@ class BigtableColumnFamily(proto.Message): Attributes: field_name (str): - The field name to use for this column family in the - document. The name has to match the pattern - ``[a-zA-Z0-9][a-zA-Z0-9-_]*``. If not set, it is parsed from - the family name with best effort. However, due to different - naming patterns, field name collisions could happen, where - parsing behavior is undefined. + The field name to use for this column family in + the document. The name has to match the pattern + ```a-zA-Z0-9 `__*``. If not set, it + is parsed from the family name with best effort. + However, due to different naming patterns, field + name collisions could happen, where parsing + behavior is undefined. encoding (google.cloud.discoveryengine_v1beta.types.BigtableOptions.Encoding): - The encoding mode of the values when the type is not STRING. - Acceptable encoding values are: - - - ``TEXT``: indicates values are alphanumeric text strings. - - ``BINARY``: indicates values are encoded using - ``HBase Bytes.toBytes`` family of functions. This can be - overridden for a specific column by listing that column in - ``columns`` and specifying an encoding for it. + The encoding mode of the values when the type is + not STRING. Acceptable encoding values are: + + * ``TEXT``: indicates values are alphanumeric + text strings. * ``BINARY``: indicates values are + encoded using ``HBase Bytes.toBytes`` family of + functions. This can be overridden for a specific + column by listing that column in ``columns`` and + specifying an encoding for it. type_ (google.cloud.discoveryengine_v1beta.types.BigtableOptions.Type): - The type of values in this column family. The values are - expected to be encoded using ``HBase Bytes.toBytes`` - function when the encoding value is set to ``BINARY``. + The type of values in this column family. + The values are expected to be encoded using + ``HBase Bytes.toBytes`` function when the + encoding value is set to ``BINARY``. columns (MutableSequence[google.cloud.discoveryengine_v1beta.types.BigtableOptions.BigtableColumn]): The list of objects that contains column level information for each column. If a column @@ -371,25 +396,28 @@ class BigtableColumn(proto.Message): cannot be decoded with utf-8, use a base-64 encoded string instead. field_name (str): - The field name to use for this column in the document. The - name has to match the pattern ``[a-zA-Z0-9][a-zA-Z0-9-_]*``. - If not set, it is parsed from the qualifier bytes with best - effort. However, due to different naming patterns, field - name collisions could happen, where parsing behavior is - undefined. + The field name to use for this column in the + document. The name has to match the pattern + ```a-zA-Z0-9 `__*``. If not set, it + is parsed from the qualifier bytes with best + effort. However, due to different naming + patterns, field name collisions could happen, + where parsing behavior is undefined. encoding (google.cloud.discoveryengine_v1beta.types.BigtableOptions.Encoding): - The encoding mode of the values when the type is not - ``STRING``. Acceptable encoding values are: - - - ``TEXT``: indicates values are alphanumeric text strings. - - ``BINARY``: indicates values are encoded using - ``HBase Bytes.toBytes`` family of functions. This can be - overridden for a specific column by listing that column in - ``columns`` and specifying an encoding for it. + The encoding mode of the values when the type is + not ``STRING``. Acceptable encoding values are: + + * ``TEXT``: indicates values are alphanumeric + text strings. * ``BINARY``: indicates values are + encoded using ``HBase Bytes.toBytes`` family of + functions. This can be overridden for a specific + column by listing that column in ``columns`` and + specifying an encoding for it. type_ (google.cloud.discoveryengine_v1beta.types.BigtableOptions.Type): - The type of values in this column family. The values are - expected to be encoded using ``HBase Bytes.toBytes`` - function when the encoding value is set to ``BINARY``. + The type of values in this column family. + The values are expected to be encoded using + ``HBase Bytes.toBytes`` function when the + encoding value is set to ``BINARY``. """ qualifier: bytes = proto.Field( @@ -469,8 +497,8 @@ class FhirStoreSource(proto.Message): Attributes: fhir_store (str): - Required. The full resource name of the FHIR store to import - data from, in the format of + Required. The full resource name of the FHIR + store to import data from, in the format of ``projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}``. gcs_staging_dir (str): Intermediate Cloud Storage directory used for @@ -479,10 +507,12 @@ class FhirStoreSource(proto.Message): have the FhirStore export to a specific Cloud Storage directory. resource_types (MutableSequence[str]): - The FHIR resource types to import. The resource types should - be a subset of all `supported FHIR resource - types `__. - Default to all supported FHIR resource types if empty. + The FHIR resource types to import. The resource + types should be a subset of all `supported FHIR + resource types + `__. + Default to all supported FHIR resource types if + empty. """ fhir_store: str = proto.Field( @@ -528,9 +558,10 @@ class CloudSqlSource(proto.Message): the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. offload (bool): - Option for serverless export. Enabling this option will - incur additional cost. More info can be found - `here `__. + Option for serverless export. Enabling this + option will incur additional cost. More info can + be found `here + `__. """ project_id: str = proto.Field( @@ -671,10 +702,11 @@ class ImportErrorConfig(proto.Message): Attributes: gcs_prefix (str): - Cloud Storage prefix for import errors. This must be an - empty, existing Cloud Storage directory. Import errors are - written to sharded files in this directory, one per line, as - a JSON-encoded ``google.rpc.Status`` message. + Cloud Storage prefix for import errors. This + must be an empty, existing Cloud Storage + directory. Import errors are written to sharded + files in this directory, one per line, as a + JSON-encoded ``google.rpc.Status`` message. This field is a member of `oneof`_ ``destination``. """ @@ -711,7 +743,8 @@ class ImportUserEventsRequest(proto.Message): This field is a member of `oneof`_ ``source``. parent (str): - Required. Parent DataStore resource name, of the form + Required. Parent DataStore resource name, of the + form ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`` error_config (google.cloud.discoveryengine_v1beta.types.ImportErrorConfig): The desired location of errors incurred @@ -939,92 +972,126 @@ class ImportDocumentsRequest(proto.Message): This field is a member of `oneof`_ ``source``. parent (str): - Required. The parent branch resource name, such as + Required. The parent branch resource name, such + as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. Requires create/update permission. error_config (google.cloud.discoveryengine_v1beta.types.ImportErrorConfig): The desired location of errors incurred during the Import. reconciliation_mode (google.cloud.discoveryengine_v1beta.types.ImportDocumentsRequest.ReconciliationMode): - The mode of reconciliation between existing documents and - the documents to be imported. Defaults to - [ReconciliationMode.INCREMENTAL][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL]. + The mode of reconciliation between existing + documents and the documents to be imported. + Defaults to `ReconciliationMode.INCREMENTAL + `__. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields. auto_generate_ids (bool): - Whether to automatically generate IDs for the documents if - absent. - + Whether to automatically generate IDs for the + documents if absent. If set to ``true``, - [Document.id][google.cloud.discoveryengine.v1beta.Document.id]s - are automatically generated based on the hash of the - payload, where IDs may not be consistent during multiple - imports. In which case - [ReconciliationMode.FULL][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode.FULL] - is highly recommended to avoid duplicate contents. If unset - or set to ``false``, - [Document.id][google.cloud.discoveryengine.v1beta.Document.id]s + `Document.id + `__s + are automatically generated based on the hash of + the payload, where IDs may not be consistent + during multiple imports. In which case + `ReconciliationMode.FULL + `__ + is highly recommended to avoid duplicate + contents. If unset or set to ``false``, + `Document.id + `__s have to be specified using - [id_field][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.id_field], - otherwise, documents without IDs fail to be imported. + `id_field + `__, + otherwise, documents without IDs fail to be + imported. Supported data sources: - - [GcsSource][google.cloud.discoveryengine.v1beta.GcsSource]. - [GcsSource.data_schema][google.cloud.discoveryengine.v1beta.GcsSource.data_schema] - must be ``custom`` or ``csv``. Otherwise, an - INVALID_ARGUMENT error is thrown. - - [BigQuerySource][google.cloud.discoveryengine.v1beta.BigQuerySource]. - [BigQuerySource.data_schema][google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema] - must be ``custom`` or ``csv``. Otherwise, an - INVALID_ARGUMENT error is thrown. - - [SpannerSource][google.cloud.discoveryengine.v1beta.SpannerSource]. - - [CloudSqlSource][google.cloud.discoveryengine.v1beta.CloudSqlSource]. - - [FirestoreSource][google.cloud.discoveryengine.v1beta.FirestoreSource]. - - [BigtableSource][google.cloud.discoveryengine.v1beta.BigtableSource]. + * `GcsSource + `__. + `GcsSource.data_schema + `__ + must be ``custom`` or ``csv``. Otherwise, an + INVALID_ARGUMENT error is thrown. + + * `BigQuerySource + `__. + `BigQuerySource.data_schema + `__ + must be ``custom`` or ``csv``. Otherwise, an + INVALID_ARGUMENT error is thrown. + + * `SpannerSource + `__. + * `CloudSqlSource + `__. + + * `FirestoreSource + `__. + * `BigtableSource + `__. id_field (str): - The field indicates the ID field or column to be used as - unique IDs of the documents. - - For - [GcsSource][google.cloud.discoveryengine.v1beta.GcsSource] - it is the key of the JSON field. For instance, ``my_id`` for - JSON ``{"my_id": "some_uuid"}``. For others, it may be the - column name of the table where the unique ids are stored. - - The values of the JSON field or the table column are used as - the - [Document.id][google.cloud.discoveryengine.v1beta.Document.id]s. - The JSON field or the table column must be of string type, - and the values must be set as valid strings conform to - `RFC-1034 `__ with 1-63 - characters. Otherwise, documents without valid IDs fail to - be imported. + The field indicates the ID field or column to be + used as unique IDs of the documents. + + For `GcsSource + `__ + it is the key of the JSON field. For instance, + ``my_id`` for JSON ``{"my_id": + + "some_uuid"}``. For others, it may be the column + name of the table where the unique ids are + stored. + + The values of the JSON field or the table column + are used as the `Document.id + `__s. + The JSON field or the table column must be of + string type, and the values must be set as valid + strings conform to + `RFC-1034 + `__ with + 1-63 characters. Otherwise, documents without + valid IDs fail to be imported. Only set this field when - [auto_generate_ids][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.auto_generate_ids] - is unset or set as ``false``. Otherwise, an INVALID_ARGUMENT - error is thrown. + `auto_generate_ids + `__ + is unset or set as ``false``. Otherwise, an + INVALID_ARGUMENT error is thrown. - If it is unset, a default value ``_id`` is used when - importing from the allowed data sources. + If it is unset, a default value ``_id`` is used + when importing from the allowed data sources. Supported data sources: - - [GcsSource][google.cloud.discoveryengine.v1beta.GcsSource]. - [GcsSource.data_schema][google.cloud.discoveryengine.v1beta.GcsSource.data_schema] - must be ``custom`` or ``csv``. Otherwise, an - INVALID_ARGUMENT error is thrown. - - [BigQuerySource][google.cloud.discoveryengine.v1beta.BigQuerySource]. - [BigQuerySource.data_schema][google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema] - must be ``custom`` or ``csv``. Otherwise, an - INVALID_ARGUMENT error is thrown. - - [SpannerSource][google.cloud.discoveryengine.v1beta.SpannerSource]. - - [CloudSqlSource][google.cloud.discoveryengine.v1beta.CloudSqlSource]. - - [FirestoreSource][google.cloud.discoveryengine.v1beta.FirestoreSource]. - - [BigtableSource][google.cloud.discoveryengine.v1beta.BigtableSource]. + * `GcsSource + `__. + `GcsSource.data_schema + `__ + must be ``custom`` or ``csv``. Otherwise, an + INVALID_ARGUMENT error is thrown. + + * `BigQuerySource + `__. + `BigQuerySource.data_schema + `__ + must be ``custom`` or ``csv``. Otherwise, an + INVALID_ARGUMENT error is thrown. + + * `SpannerSource + `__. + * `CloudSqlSource + `__. + + * `FirestoreSource + `__. + * `BigtableSource + `__. """ class ReconciliationMode(proto.Enum): @@ -1053,9 +1120,9 @@ class InlineSource(proto.Message): Attributes: documents (MutableSequence[google.cloud.discoveryengine_v1beta.types.Document]): - Required. A list of documents to update/create. Each - document must have a valid - [Document.id][google.cloud.discoveryengine.v1beta.Document.id]. + Required. A list of documents to update/create. + Each document must have a valid `Document.id + `__. Recommended max of 100 items. """ @@ -1150,10 +1217,11 @@ class InlineSource(proto.Message): class ImportDocumentsResponse(proto.Message): r"""Response of the - [ImportDocumentsRequest][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest]. - If the long running operation is done, then this message is returned - by the google.longrunning.Operations.response field if the operation - was successful. + `ImportDocumentsRequest + `__. + If the long running operation is done, then this message is + returned by the google.longrunning.Operations.response field if + the operation was successful. Attributes: error_samples (MutableSequence[google.rpc.status_pb2.Status]): @@ -1178,7 +1246,8 @@ class ImportDocumentsResponse(proto.Message): class ImportSuggestionDenyListEntriesRequest(proto.Message): r"""Request message for - [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1beta.CompletionService.ImportSuggestionDenyListEntries] + `CompletionService.ImportSuggestionDenyListEntries + `__ method. This message has `oneof`_ fields (mutually exclusive fields). @@ -1197,17 +1266,19 @@ class ImportSuggestionDenyListEntriesRequest(proto.Message): gcs_source (google.cloud.discoveryengine_v1beta.types.GcsSource): Cloud Storage location for the input content. - Only 1 file can be specified that contains all entries to - import. Supported values ``gcs_source.schema`` for - autocomplete suggestion deny list entry imports: + Only 1 file can be specified that contains all + entries to import. Supported values + ``gcs_source.schema`` for autocomplete + suggestion deny list entry imports: - - ``suggestion_deny_list`` (default): One JSON - [SuggestionDenyListEntry] per line. + * ``suggestion_deny_list`` (default): One JSON + [SuggestionDenyListEntry] per line. This field is a member of `oneof`_ ``source``. parent (str): - Required. The parent data store resource name for which to - import denylist entries. Follows pattern + Required. The parent data store resource name + for which to import denylist entries. Follows + pattern projects/*/locations/*/collections/*/dataStores/*. """ @@ -1248,7 +1319,8 @@ class InlineSource(proto.Message): class ImportSuggestionDenyListEntriesResponse(proto.Message): r"""Response message for - [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1beta.CompletionService.ImportSuggestionDenyListEntries] + `CompletionService.ImportSuggestionDenyListEntries + `__ method. Attributes: @@ -1305,7 +1377,8 @@ class ImportSuggestionDenyListEntriesMetadata(proto.Message): class ImportCompletionSuggestionsRequest(proto.Message): r"""Request message for - [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1beta.CompletionService.ImportCompletionSuggestions] + `CompletionService.ImportCompletionSuggestions + `__ method. This message has `oneof`_ fields (mutually exclusive fields). @@ -1329,8 +1402,9 @@ class ImportCompletionSuggestionsRequest(proto.Message): This field is a member of `oneof`_ ``source``. parent (str): - Required. The parent data store resource name for which to - import customer autocomplete suggestions. + Required. The parent data store resource name + for which to import customer autocomplete + suggestions. Follows pattern ``projects/*/locations/*/collections/*/dataStores/*`` @@ -1387,10 +1461,11 @@ class InlineSource(proto.Message): class ImportCompletionSuggestionsResponse(proto.Message): r"""Response of the - [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1beta.CompletionService.ImportCompletionSuggestions] + `CompletionService.ImportCompletionSuggestions + `__ method. If the long running operation is done, this message is - returned by the google.longrunning.Operations.response field if the - operation is successful. + returned by the google.longrunning.Operations.response field if + the operation is successful. Attributes: error_samples (MutableSequence[google.rpc.status_pb2.Status]): @@ -1426,11 +1501,13 @@ class ImportCompletionSuggestionsMetadata(proto.Message): is done, this is also the finish time. success_count (int): Count of - [CompletionSuggestion][google.cloud.discoveryengine.v1beta.CompletionSuggestion]s + `CompletionSuggestion + `__s successfully imported. failure_count (int): Count of - [CompletionSuggestion][google.cloud.discoveryengine.v1beta.CompletionSuggestion]s + `CompletionSuggestion + `__s that failed to be imported. """ @@ -1456,7 +1533,8 @@ class ImportCompletionSuggestionsMetadata(proto.Message): class ImportSampleQueriesRequest(proto.Message): r"""Request message for - [SampleQueryService.ImportSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ImportSampleQueries] + `SampleQueryService.ImportSampleQueries + `__ method. This message has `oneof`_ fields (mutually exclusive fields). @@ -1480,14 +1558,16 @@ class ImportSampleQueriesRequest(proto.Message): This field is a member of `oneof`_ ``source``. parent (str): - Required. The parent sample query set resource name, such as + Required. The parent sample query set resource + name, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}``. If the caller does not have permission to list - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s - under this sample query set, regardless of whether or not - this sample query set exists, a ``PERMISSION_DENIED`` error - is returned. + `SampleQuery + `__s + under this sample query set, regardless of + whether or not this sample query set exists, a + ``PERMISSION_DENIED`` error is returned. error_config (google.cloud.discoveryengine_v1beta.types.ImportErrorConfig): The desired location of errors incurred during the Import. @@ -1495,12 +1575,14 @@ class ImportSampleQueriesRequest(proto.Message): class InlineSource(proto.Message): r"""The inline source for - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s. + `SampleQuery + `__s. Attributes: sample_queries (MutableSequence[google.cloud.discoveryengine_v1beta.types.SampleQuery]): Required. A list of - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s + `SampleQuery + `__s to import. Max of 1000 items. """ @@ -1541,10 +1623,11 @@ class InlineSource(proto.Message): class ImportSampleQueriesResponse(proto.Message): r"""Response of the - [SampleQueryService.ImportSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ImportSampleQueries] + `SampleQueryService.ImportSampleQueries + `__ method. If the long running operation is done, this message is - returned by the google.longrunning.Operations.response field if the - operation is successful. + returned by the google.longrunning.Operations.response field if + the operation is successful. Attributes: error_samples (MutableSequence[google.rpc.status_pb2.Status]): @@ -1580,16 +1663,17 @@ class ImportSampleQueriesMetadata(proto.Message): time. If the operation is done, this is also the finish time. success_count (int): - Count of - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s + Count of `SampleQuery + `__s successfully imported. failure_count (int): - Count of - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s + Count of `SampleQuery + `__s that failed to be imported. total_count (int): Total count of - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s + `SampleQuery + `__s that were processed. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/project.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/project.py index 63d811e112e3..cdbe8f7d8d61 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/project.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/project.py @@ -34,9 +34,10 @@ class Project(proto.Message): Attributes: name (str): - Output only. Full resource name of the project, for example - ``projects/{project}``. Note that when making requests, - project number and project id are both acceptable, but the + Output only. Full resource name of the project, + for example ``projects/{project}``. + Note that when making requests, project number + and project id are both acceptable, but the server will always respond in project number. create_time (google.protobuf.timestamp_pb2.Timestamp): Output only. The timestamp when this project @@ -47,9 +48,9 @@ class Project(proto.Message): this project is still provisioning and is not ready for use. service_terms_map (MutableMapping[str, google.cloud.discoveryengine_v1beta.types.Project.ServiceTerms]): - Output only. A map of terms of services. The key is the - ``id`` of - [ServiceTerms][google.cloud.discoveryengine.v1beta.Project.ServiceTerms]. + Output only. A map of terms of services. The key + is the ``id`` of `ServiceTerms + `__. """ class ServiceTerms(proto.Message): @@ -57,18 +58,21 @@ class ServiceTerms(proto.Message): Attributes: id (str): - The unique identifier of this terms of service. Available - terms: + The unique identifier of this terms of service. + Available terms: - - ``GA_DATA_USE_TERMS``: `Terms for data - use `__. - When using this as ``id``, the acceptable - [version][google.cloud.discoveryengine.v1beta.Project.ServiceTerms.version] - to provide is ``2022-11-23``. + * ``GA_DATA_USE_TERMS``: `Terms for data + use + `__. + When using this as ``id``, the acceptable + `version + `__ + to provide is ``2022-11-23``. version (str): - The version string of the terms of service. For acceptable - values, see the comments for - [id][google.cloud.discoveryengine.v1beta.Project.ServiceTerms.id] + The version string of the terms of service. + For acceptable values, see the comments for + `id + `__ above. state (google.cloud.discoveryengine_v1beta.types.Project.ServiceTerms.State): Whether the project has accepted/rejected the diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/project_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/project_service.py index 45ddb4a7693e..9cff599f2e85 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/project_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/project_service.py @@ -30,25 +30,30 @@ class ProvisionProjectRequest(proto.Message): r"""Request for - [ProjectService.ProvisionProject][google.cloud.discoveryengine.v1beta.ProjectService.ProvisionProject] + `ProjectService.ProvisionProject + `__ method. Attributes: name (str): Required. Full resource name of a - [Project][google.cloud.discoveryengine.v1beta.Project], such - as ``projects/{project_id_or_number}``. + `Project + `__, + such as ``projects/{project_id_or_number}``. accept_data_use_terms (bool): - Required. Set to ``true`` to specify that caller has read - and would like to give consent to the `Terms for data - use `__. + Required. Set to ``true`` to specify that caller + has read and would like to give consent to the + `Terms for data use + `__. data_use_terms_version (str): Required. The version of the `Terms for data - use `__ that - caller has read and would like to give consent to. + use + `__ + that caller has read and would like to give + consent to. - Acceptable version is ``2022-11-23``, and this may change - over time. + Acceptable version is ``2022-11-23``, and this + may change over time. """ name: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/purge_config.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/purge_config.py index 56a18e79d469..a8db81523a32 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/purge_config.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/purge_config.py @@ -48,39 +48,59 @@ class PurgeUserEventsRequest(proto.Message): Attributes: parent (str): - Required. The resource name of the catalog under which the - events are created. The format is + Required. The resource name of the catalog under + which the events are created. The format is ``projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}``. filter (str): - Required. The filter string to specify the events to be - deleted with a length limit of 5,000 characters. The - eligible fields for filtering are: - - - ``eventType``: Double quoted - [UserEvent.event_type][google.cloud.discoveryengine.v1beta.UserEvent.event_type] - string. - - ``eventTime``: in ISO 8601 "zulu" format. - - ``userPseudoId``: Double quoted string. Specifying this - will delete all events associated with a visitor. - - ``userId``: Double quoted string. Specifying this will - delete all events associated with a user. + Required. The filter string to specify the + events to be deleted with a length limit of + 5,000 characters. The eligible fields for + filtering are: + + * ``eventType``: Double quoted + `UserEvent.event_type + `__ + string. + + * ``eventTime``: in ISO 8601 "zulu" format. + * ``userPseudoId``: Double quoted string. + Specifying this will delete all events + associated with a visitor. + + * ``userId``: Double quoted string. Specifying + this will delete all events associated with a + user. Examples: - - Deleting all events in a time range: - ``eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"`` - - Deleting specific eventType: ``eventType = "search"`` - - Deleting all events for a specific visitor: + * Deleting all events in a time range: + + ``eventTime > "2012-04-23T18:25:43.511Z" + eventTime < "2012-04-23T18:30:43.511Z"`` + + * Deleting specific eventType: + + ``eventType = "search"`` + + * Deleting all events for a specific visitor: + ``userPseudoId = "visitor1024"`` - - Deleting all events inside a DataStore: ``*`` - The filtering fields are assumed to have an implicit AND. + * Deleting all events inside a DataStore: + + ``*`` + + The filtering fields are assumed to have an + implicit AND. force (bool): - The ``force`` field is currently not supported. Purge user - event requests will permanently delete all purgeable events. - Once the development is complete: If ``force`` is set to - false, the method will return the expected purge count - without deleting any user events. This field will default to + The ``force`` field is currently not supported. + Purge user event requests will permanently + delete all purgeable events. Once the + development is complete: + + If ``force`` is set to false, the method will + return the expected purge count without deleting + any user events. This field will default to false if not included in the request. """ @@ -161,10 +181,11 @@ class PurgeErrorConfig(proto.Message): Attributes: gcs_prefix (str): - Cloud Storage prefix for purge errors. This must be an - empty, existing Cloud Storage directory. Purge errors are - written to sharded files in this directory, one per line, as - a JSON-encoded ``google.rpc.Status`` message. + Cloud Storage prefix for purge errors. This must + be an empty, existing Cloud Storage directory. + Purge errors are written to sharded files in + this directory, one per line, as a JSON-encoded + ``google.rpc.Status`` message. This field is a member of `oneof`_ ``destination``. """ @@ -178,7 +199,8 @@ class PurgeErrorConfig(proto.Message): class PurgeDocumentsRequest(proto.Message): r"""Request message for - [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments] + `DocumentService.PurgeDocuments + `__ method. This message has `oneof`_ fields (mutually exclusive fields). @@ -190,12 +212,13 @@ class PurgeDocumentsRequest(proto.Message): Attributes: gcs_source (google.cloud.discoveryengine_v1beta.types.GcsSource): - Cloud Storage location for the input content. Supported - ``data_schema``: + Cloud Storage location for the input content. + Supported ``data_schema``: - - ``document_id``: One valid - [Document.id][google.cloud.discoveryengine.v1beta.Document.id] - per line. + * ``document_id``: One valid + `Document.id + `__ + per line. This field is a member of `oneof`_ ``source``. inline_source (google.cloud.discoveryengine_v1beta.types.PurgeDocumentsRequest.InlineSource): @@ -207,26 +230,28 @@ class PurgeDocumentsRequest(proto.Message): Required. The parent resource name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}``. filter (str): - Required. Filter matching documents to purge. Only currently - supported value is ``*`` (all items). + Required. Filter matching documents to purge. + Only currently supported value is + ``*`` (all items). error_config (google.cloud.discoveryengine_v1beta.types.PurgeErrorConfig): The desired location of errors incurred during the purge. force (bool): - Actually performs the purge. If ``force`` is set to false, - return the expected purge count without deleting any - documents. + Actually performs the purge. If ``force`` is set + to false, return the expected purge count + without deleting any documents. """ class InlineSource(proto.Message): r"""The inline source for the input config for - [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments] + `DocumentService.PurgeDocuments + `__ method. Attributes: documents (MutableSequence[str]): - Required. A list of full resource name of documents to - purge. In the format + Required. A list of full resource name of + documents to purge. In the format ``projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*``. Recommended max of 100 items. """ @@ -269,7 +294,8 @@ class InlineSource(proto.Message): class PurgeDocumentsResponse(proto.Message): r"""Response message for - [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments] + `DocumentService.PurgeDocuments + `__ method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field. @@ -279,9 +305,10 @@ class PurgeDocumentsResponse(proto.Message): The total count of documents purged as a result of the operation. purge_sample (MutableSequence[str]): - A sample of document names that will be deleted. Only - populated if ``force`` is set to false. A max of 100 names - will be returned and the names are chosen at random. + A sample of document names that will be deleted. + Only populated if ``force`` is set to false. A + max of 100 names will be returned and the names + are chosen at random. """ purge_count: int = proto.Field( @@ -342,13 +369,15 @@ class PurgeDocumentsMetadata(proto.Message): class PurgeSuggestionDenyListEntriesRequest(proto.Message): r"""Request message for - [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1beta.CompletionService.PurgeSuggestionDenyListEntries] + `CompletionService.PurgeSuggestionDenyListEntries + `__ method. Attributes: parent (str): - Required. The parent data store resource name for which to - import denylist entries. Follows pattern + Required. The parent data store resource name + for which to import denylist entries. Follows + pattern projects/*/locations/*/collections/*/dataStores/*. """ @@ -360,7 +389,8 @@ class PurgeSuggestionDenyListEntriesRequest(proto.Message): class PurgeSuggestionDenyListEntriesResponse(proto.Message): r"""Response message for - [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1beta.CompletionService.PurgeSuggestionDenyListEntries] + `CompletionService.PurgeSuggestionDenyListEntries + `__ method. Attributes: @@ -410,13 +440,15 @@ class PurgeSuggestionDenyListEntriesMetadata(proto.Message): class PurgeCompletionSuggestionsRequest(proto.Message): r"""Request message for - [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1beta.CompletionService.PurgeCompletionSuggestions] + `CompletionService.PurgeCompletionSuggestions + `__ method. Attributes: parent (str): - Required. The parent data store resource name for which to - purge completion suggestions. Follows pattern + Required. The parent data store resource name + for which to purge completion suggestions. + Follows pattern projects/*/locations/*/collections/*/dataStores/*. """ @@ -428,7 +460,8 @@ class PurgeCompletionSuggestionsRequest(proto.Message): class PurgeCompletionSuggestionsResponse(proto.Message): r"""Response message for - [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1beta.CompletionService.PurgeCompletionSuggestions] + `CompletionService.PurgeCompletionSuggestions + `__ method. Attributes: diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/rank_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/rank_service.py index 8ef6ba5911c0..de153a694fab 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/rank_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/rank_service.py @@ -31,24 +31,31 @@ class RankingRecord(proto.Message): r"""Record message for - [RankService.Rank][google.cloud.discoveryengine.v1beta.RankService.Rank] + `RankService.Rank + `__ method. Attributes: id (str): The unique ID to represent the record. title (str): - The title of the record. Empty by default. At least one of - [title][google.cloud.discoveryengine.v1beta.RankingRecord.title] - or - [content][google.cloud.discoveryengine.v1beta.RankingRecord.content] - should be set otherwise an INVALID_ARGUMENT error is thrown. + The title of the record. Empty by default. + At least one of + `title + `__ + or `content + `__ + should be set otherwise an INVALID_ARGUMENT + error is thrown. content (str): - The content of the record. Empty by default. At least one of - [title][google.cloud.discoveryengine.v1beta.RankingRecord.title] - or - [content][google.cloud.discoveryengine.v1beta.RankingRecord.content] - should be set otherwise an INVALID_ARGUMENT error is thrown. + The content of the record. Empty by default. + At least one of + `title + `__ + or `content + `__ + should be set otherwise an INVALID_ARGUMENT + error is thrown. score (float): The score of this record based on the given query and selected model. @@ -74,22 +81,23 @@ class RankingRecord(proto.Message): class RankRequest(proto.Message): r"""Request message for - [RankService.Rank][google.cloud.discoveryengine.v1beta.RankService.Rank] + `RankService.Rank + `__ method. Attributes: ranking_config (str): - Required. The resource name of the rank service config, such - as + Required. The resource name of the rank service + config, such as ``projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config``. model (str): - The identifier of the model to use. It is one of: + The identifier of the model to use. It is one + of: + * ``semantic-ranker-512@latest``: Semantic + ranking model with maxiumn input token size 512. - - ``semantic-ranker-512@latest``: Semantic ranking model - with maxiumn input token size 512. - - It is set to ``semantic-ranker-512@latest`` by default if - unspecified. + It is set to ``semantic-ranker-512@latest`` by + default if unspecified. top_n (int): The number of results to return. If this is unset or no bigger than zero, returns all @@ -104,26 +112,32 @@ class RankRequest(proto.Message): record ID and score. By default, it is false, the response will contain record details. user_labels (MutableMapping[str, str]): - The user labels applied to a resource must meet the - following requirements: - - - Each resource can have multiple labels, up to a maximum of - 64. - - Each label must be a key-value pair. - - Keys have a minimum length of 1 character and a maximum - length of 63 characters and cannot be empty. Values can be - empty and have a maximum length of 63 characters. - - Keys and values can contain only lowercase letters, - numeric characters, underscores, and dashes. All - characters must use UTF-8 encoding, and international - characters are allowed. - - The key portion of a label must be unique. However, you - can use the same key with multiple resources. - - Keys must start with a lowercase letter or international - character. + The user labels applied to a resource must meet + the following requirements: + * Each resource can have multiple labels, up to + a maximum of 64. + + * Each label must be a key-value pair. + * Keys have a minimum length of 1 character and + a maximum length of 63 characters and cannot + be empty. Values can be empty and have a maximum + length of 63 characters. + + * Keys and values can contain only lowercase + letters, numeric characters, underscores, and + dashes. All characters must use UTF-8 encoding, + and international characters are allowed. + + * The key portion of a label must be unique. + However, you can use the same key with + multiple resources. + + * Keys must start with a lowercase letter or + international character. See `Google Cloud - Document `__ + Document + `__ for more details. """ @@ -161,7 +175,8 @@ class RankRequest(proto.Message): class RankResponse(proto.Message): r"""Response message for - [RankService.Rank][google.cloud.discoveryengine.v1beta.RankService.Rank] + `RankService.Rank + `__ method. Attributes: diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/recommendation_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/recommendation_service.py index 51d09981d87b..d90ed6720bd3 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/recommendation_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/recommendation_service.py @@ -38,38 +38,48 @@ class RecommendRequest(proto.Message): Attributes: serving_config (str): Required. Full resource name of a - [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig]: + `ServingConfig + `__: + ``projects/*/locations/global/collections/*/engines/*/servingConfigs/*``, or ``projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`` - One default serving config is created along with your - recommendation engine creation. The engine ID is used as the - ID of the default serving config. For example, for Engine + One default serving config is created along with + your recommendation engine creation. The engine + ID is used as the ID of the default serving + config. For example, for Engine ``projects/*/locations/global/collections/*/engines/my-engine``, you can use ``projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`` for your - [RecommendationService.Recommend][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend] + `RecommendationService.Recommend + `__ requests. user_event (google.cloud.discoveryengine_v1beta.types.UserEvent): - Required. Context about the user, what they are looking at - and what action they took to trigger the Recommend request. - Note that this user event detail won't be ingested to - userEvent logs. Thus, a separate userEvent write request is + Required. Context about the user, what they are + looking at and what action they took to trigger + the Recommend request. Note that this user event + detail won't be ingested to userEvent logs. + Thus, a separate userEvent write request is required for event logging. Don't set - [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id] + `UserEvent.user_pseudo_id + `__ or - [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id] - to the same fixed ID for different users. If you are trying - to receive non-personalized recommendations (not - recommended; this can negatively impact model performance), - instead set - [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id] + `UserEvent.user_info.user_id + `__ + to the same fixed ID for different users. If you + are trying to receive non-personalized + recommendations (not recommended; this can + negatively impact model performance), instead + set + `UserEvent.user_pseudo_id + `__ to a random unique ID and leave - [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id] + `UserEvent.user_info.user_id + `__ unset. page_size (int): Maximum number of results to return. Set this @@ -78,95 +88,120 @@ class RecommendRequest(proto.Message): reasonable default. The maximum allowed value is 100. Values above 100 are set to 100. filter (str): - Filter for restricting recommendation results with a length - limit of 5,000 characters. Currently, only filter - expressions on the ``filter_tags`` attribute is supported. + Filter for restricting recommendation results + with a length limit of 5,000 characters. + Currently, only filter expressions on the + ``filter_tags`` attribute is supported. Examples: - - ``(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))`` - - ``(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))`` - - If ``attributeFilteringSyntax`` is set to true under the - ``params`` field, then attribute-based expressions are - expected instead of the above described tag-based syntax. - Examples: - - - (launguage: ANY("en", "es")) AND NOT (categories: - ANY("Movie")) - - (available: true) AND (launguage: ANY("en", "es")) OR - (categories: ANY("Movie")) - - If your filter blocks all results, the API returns generic - (unfiltered) popular Documents. If you only want results - strictly matching the filters, set ``strictFiltering`` to - ``true`` in - [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params] + * ``(filter_tags: ANY("Red", "Blue") OR + filter_tags: ANY("Hot", "Cold"))`` * + ``(filter_tags: ANY("Red", "Blue")) AND NOT + (filter_tags: ANY("Green"))`` + + If ``attributeFilteringSyntax`` is set to true + under the ``params`` field, then attribute-based + expressions are expected instead of the above + described tag-based syntax. Examples: + + * (launguage: ANY("en", "es")) AND NOT + (categories: ANY("Movie")) * (available: true) + AND + (launguage: ANY("en", "es")) OR (categories: + ANY("Movie")) + + If your filter blocks all results, the API + returns generic (unfiltered) popular Documents. + If you only want results strictly matching the + filters, set ``strictFiltering`` to ``true`` in + `RecommendRequest.params + `__ to receive empty results instead. Note that the API never returns - [Document][google.cloud.discoveryengine.v1beta.Document]s - with ``storageStatus`` as ``EXPIRED`` or ``DELETED`` - regardless of filter choices. + `Document + `__s + with ``storageStatus`` as ``EXPIRED`` or + ``DELETED`` regardless of filter choices. validate_only (bool): - Use validate only mode for this recommendation query. If set - to ``true``, a fake model is used that returns arbitrary - Document IDs. Note that the validate only mode should only - be used for testing the API, or if the model is not ready. + Use validate only mode for this recommendation + query. If set to ``true``, a fake model is used + that returns arbitrary Document IDs. Note that + the validate only mode should only be used for + testing the API, or if the model is not ready. params (MutableMapping[str, google.protobuf.struct_pb2.Value]): Additional domain specific parameters for the recommendations. - Allowed values: - - ``returnDocument``: Boolean. If set to ``true``, the - associated Document object is returned in - [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document]. - - ``returnScore``: Boolean. If set to true, the - recommendation score corresponding to each returned - Document is set in - [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata]. - The given score indicates the probability of a Document - conversion given the user's context and history. - - ``strictFiltering``: Boolean. True by default. If set to - ``false``, the service returns generic (unfiltered) - popular Documents instead of empty if your filter blocks - all recommendation results. - - ``diversityLevel``: String. Default empty. If set to be - non-empty, then it needs to be one of: - - - ``no-diversity`` - - ``low-diversity`` - - ``medium-diversity`` - - ``high-diversity`` - - ``auto-diversity`` This gives request-level control and - adjusts recommendation results based on Document - category. - - - ``attributeFilteringSyntax``: Boolean. False by default. - If set to true, the ``filter`` field is interpreted - according to the new, attribute-based syntax. + * ``returnDocument``: Boolean. If set to + ``true``, the associated Document object is + returned in + `RecommendResponse.RecommendationResult.document + `__. + + * ``returnScore``: Boolean. If set to true, the + recommendation score corresponding to each + returned Document is set in + `RecommendResponse.RecommendationResult.metadata + `__. + The given score indicates the probability of a + Document conversion given the user's context + and history. + + * ``strictFiltering``: Boolean. True by default. + If set to ``false``, the service + returns generic (unfiltered) popular + Documents instead of empty if your filter + blocks all recommendation results. + + * ``diversityLevel``: String. Default empty. If + set to be non-empty, then it needs to be one + of: + + * ``no-diversity`` + * ``low-diversity`` + + * ``medium-diversity`` + * ``high-diversity`` + + * ``auto-diversity`` + This gives request-level control and adjusts + recommendation results based on Document + category. + + * ``attributeFilteringSyntax``: Boolean. False + by default. If set to true, the ``filter`` + field is interpreted according to the new, + attribute-based syntax. user_labels (MutableMapping[str, str]): - The user labels applied to a resource must meet the - following requirements: - - - Each resource can have multiple labels, up to a maximum of - 64. - - Each label must be a key-value pair. - - Keys have a minimum length of 1 character and a maximum - length of 63 characters and cannot be empty. Values can be - empty and have a maximum length of 63 characters. - - Keys and values can contain only lowercase letters, - numeric characters, underscores, and dashes. All - characters must use UTF-8 encoding, and international - characters are allowed. - - The key portion of a label must be unique. However, you - can use the same key with multiple resources. - - Keys must start with a lowercase letter or international - character. + The user labels applied to a resource must meet + the following requirements: + * Each resource can have multiple labels, up to + a maximum of 64. + + * Each label must be a key-value pair. + * Keys have a minimum length of 1 character and + a maximum length of 63 characters and cannot + be empty. Values can be empty and have a maximum + length of 63 characters. + + * Keys and values can contain only lowercase + letters, numeric characters, underscores, and + dashes. All characters must use UTF-8 encoding, + and international characters are allowed. + + * The key portion of a label must be unique. + However, you can use the same key with + multiple resources. + + * Keys must start with a lowercase letter or + international character. See `Requirements for - labels `__ + labels + `__ for more details. """ @@ -213,17 +248,20 @@ class RecommendResponse(proto.Message): represents the ranking (from the most relevant Document to the least). attribution_token (str): - A unique attribution token. This should be included in the - [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] - logs resulting from this recommendation, which enables - accurate attribution of recommendation model performance. + A unique attribution token. This should be + included in the `UserEvent + `__ + logs resulting from this recommendation, which + enables accurate attribution of recommendation + model performance. missing_ids (MutableSequence[str]): IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig. validate_only (bool): True if - [RecommendRequest.validate_only][google.cloud.discoveryengine.v1beta.RecommendRequest.validate_only] + `RecommendRequest.validate_only + `__ was set. """ @@ -236,15 +274,18 @@ class RecommendationResult(proto.Message): Resource ID of the recommended Document. document (google.cloud.discoveryengine_v1beta.types.Document): Set if ``returnDocument`` is set to true in - [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params]. + `RecommendRequest.params + `__. metadata (MutableMapping[str, google.protobuf.struct_pb2.Value]): Additional Document metadata or annotations. Possible values: - - ``score``: Recommendation score in double value. Is set if - ``returnScore`` is set to true in - [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params]. + * ``score``: Recommendation score in double + value. Is set if ``returnScore`` is set to + true in + `RecommendRequest.params + `__. """ id: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/sample_query.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/sample_query.py index 90d23995902d..8d69c24cf01a 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/sample_query.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/sample_query.py @@ -39,15 +39,16 @@ class SampleQuery(proto.Message): This field is a member of `oneof`_ ``content``. name (str): - Identifier. The full resource name of the sample query, in - the format of + Identifier. The full resource name of the sample + query, in the format of ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}``. - This field must be a UTF-8 encoded string with a length - limit of 1024 characters. + This field must be a UTF-8 encoded string with a + length limit of 1024 characters. create_time (google.protobuf.timestamp_pb2.Timestamp): Output only. Timestamp the - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] + `SampleQuery + `__ was created at. """ @@ -71,10 +72,11 @@ class Target(proto.Message): uri (str): Expected uri of the target. - This field must be a UTF-8 encoded string with a length - limit of 2048 characters. + This field must be a UTF-8 encoded string with a + length limit of 2048 characters. - Example of valid uris: ``https://example.com/abc``, + Example of valid uris: + ``https://example.com/abc``, ``gcs://example/example.pdf``. page_numbers (MutableSequence[int]): Expected page numbers of the target. diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/sample_query_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/sample_query_service.py index 44db4975b6ce..51b2d161e4a5 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/sample_query_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/sample_query_service.py @@ -37,23 +37,27 @@ class GetSampleQueryRequest(proto.Message): r"""Request message for - [SampleQueryService.GetSampleQuery][google.cloud.discoveryengine.v1beta.SampleQueryService.GetSampleQuery] + `SampleQueryService.GetSampleQuery + `__ method. Attributes: name (str): Required. Full resource name of - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], + `SampleQuery + `__, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}``. - If the caller does not have permission to access the - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. + If the caller does not have permission to access + the `SampleQuery + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. If the requested - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] + `SampleQuery + `__ does not exist, a NOT_FOUND error is returned. """ @@ -65,39 +69,48 @@ class GetSampleQueryRequest(proto.Message): class ListSampleQueriesRequest(proto.Message): r"""Request message for - [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ListSampleQueries] + `SampleQueryService.ListSampleQueries + `__ method. Attributes: parent (str): - Required. The parent sample query set resource name, such as + Required. The parent sample query set resource + name, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}``. If the caller does not have permission to list - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s - under this sample query set, regardless of whether or not - this sample query set exists, a ``PERMISSION_DENIED`` error - is returned. + `SampleQuery + `__s + under this sample query set, regardless of + whether or not this sample query set exists, a + ``PERMISSION_DENIED`` error is returned. page_size (int): Maximum number of - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s - to return. If unspecified, defaults to 100. The maximum - allowed value is 1000. Values above 1000 will be coerced to - 1000. + `SampleQuery + `__s + to return. If unspecified, defaults to 100. The + maximum allowed value is 1000. Values above 1000 + will be coerced to 1000. - If this field is negative, an ``INVALID_ARGUMENT`` error is - returned. + If this field is negative, an + ``INVALID_ARGUMENT`` error is returned. page_token (str): A page token - [ListSampleQueriesResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListSampleQueriesResponse.next_page_token], + `ListSampleQueriesResponse.next_page_token + `__, received from a previous - [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ListSampleQueries] - call. Provide this to retrieve the subsequent page. - - When paginating, all other parameters provided to - [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ListSampleQueries] - must match the call that provided the page token. Otherwise, - an ``INVALID_ARGUMENT`` error is returned. + `SampleQueryService.ListSampleQueries + `__ + call. Provide this to retrieve the subsequent + page. + + When paginating, all other parameters provided + to `SampleQueryService.ListSampleQueries + `__ + must match the call that provided the page + token. Otherwise, an ``INVALID_ARGUMENT`` error + is returned. """ parent: str = proto.Field( @@ -116,18 +129,20 @@ class ListSampleQueriesRequest(proto.Message): class ListSampleQueriesResponse(proto.Message): r"""Response message for - [SampleQueryService.ListSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ListSampleQueries] + `SampleQueryService.ListSampleQueries + `__ method. Attributes: sample_queries (MutableSequence[google.cloud.discoveryengine_v1beta.types.SampleQuery]): - The - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s. + The `SampleQuery + `__s. next_page_token (str): A token that can be sent as - [ListSampleQueriesRequest.page_token][google.cloud.discoveryengine.v1beta.ListSampleQueriesRequest.page_token] - to retrieve the next page. If this field is omitted, there - are no subsequent pages. + `ListSampleQueriesRequest.page_token + `__ + to retrieve the next page. If this field is + omitted, there are no subsequent pages. """ @property @@ -147,7 +162,8 @@ def raw_page(self): class CreateSampleQueryRequest(proto.Message): r"""Request message for - [SampleQueryService.CreateSampleQuery][google.cloud.discoveryengine.v1beta.SampleQueryService.CreateSampleQuery] + `SampleQueryService.CreateSampleQuery + `__ method. Attributes: @@ -156,29 +172,37 @@ class CreateSampleQueryRequest(proto.Message): ``projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}``. sample_query (google.cloud.discoveryengine_v1beta.types.SampleQuery): Required. The - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] + `SampleQuery + `__ to create. sample_query_id (str): Required. The ID to use for the - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], + `SampleQuery + `__, which will become the final component of the - [SampleQuery.name][google.cloud.discoveryengine.v1beta.SampleQuery.name]. + `SampleQuery.name + `__. - If the caller does not have permission to create the - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], + If the caller does not have permission to create + the `SampleQuery + `__, regardless of whether or not it exists, a ``PERMISSION_DENIED`` error is returned. This field must be unique among all - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s + `SampleQuery + `__s with the same - [parent][google.cloud.discoveryengine.v1beta.CreateSampleQueryRequest.parent]. - Otherwise, an ``ALREADY_EXISTS`` error is returned. + `parent + `__. + Otherwise, an ``ALREADY_EXISTS`` error is + returned. - This field must conform to - `RFC-1034 `__ standard - with a length limit of 63 characters. Otherwise, an - ``INVALID_ARGUMENT`` error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 characters. + Otherwise, an ``INVALID_ARGUMENT`` error is + returned. """ parent: str = proto.Field( @@ -198,21 +222,24 @@ class CreateSampleQueryRequest(proto.Message): class UpdateSampleQueryRequest(proto.Message): r"""Request message for - [SampleQueryService.UpdateSampleQuery][google.cloud.discoveryengine.v1beta.SampleQueryService.UpdateSampleQuery] + `SampleQueryService.UpdateSampleQuery + `__ method. Attributes: sample_query (google.cloud.discoveryengine_v1beta.types.SampleQuery): Required. The simple query to update. - If the caller does not have permission to update the - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], + If the caller does not have permission to update + the `SampleQuery + `__, regardless of whether or not it exists, a ``PERMISSION_DENIED`` error is returned. - If the - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] - to update does not exist a ``NOT_FOUND`` error is returned. + If the `SampleQuery + `__ + to update does not exist a ``NOT_FOUND`` error + is returned. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided imported 'simple query' to update. If not set, @@ -233,24 +260,28 @@ class UpdateSampleQueryRequest(proto.Message): class DeleteSampleQueryRequest(proto.Message): r"""Request message for - [SampleQueryService.DeleteSampleQuery][google.cloud.discoveryengine.v1beta.SampleQueryService.DeleteSampleQuery] + `SampleQueryService.DeleteSampleQuery + `__ method. Attributes: name (str): Required. Full resource name of - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], + `SampleQuery + `__, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}``. - If the caller does not have permission to delete the - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], + If the caller does not have permission to delete + the `SampleQuery + `__, regardless of whether or not it exists, a ``PERMISSION_DENIED`` error is returned. - If the - [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] - to delete does not exist, a ``NOT_FOUND`` error is returned. + If the `SampleQuery + `__ + to delete does not exist, a ``NOT_FOUND`` error + is returned. """ name: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/sample_query_set.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/sample_query_set.py index 83ae097221ad..0051d4e33441 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/sample_query_set.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/sample_query_set.py @@ -35,12 +35,13 @@ class SampleQuerySet(proto.Message): Attributes: name (str): Identifier. The full resource name of the - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], + `SampleQuerySet + `__, in the format of ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}``. - This field must be a UTF-8 encoded string with a length - limit of 1024 characters. + This field must be a UTF-8 encoded string with a + length limit of 1024 characters. display_name (str): Required. The sample query set display name. @@ -48,11 +49,13 @@ class SampleQuerySet(proto.Message): length limit of 128 characters. create_time (google.protobuf.timestamp_pb2.Timestamp): Output only. Timestamp the - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] + `SampleQuerySet + `__ was created at. description (str): The description of the - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]. + `SampleQuerySet + `__. """ name: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/sample_query_set_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/sample_query_set_service.py index 1dab3c6377bd..ce705be33c6e 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/sample_query_set_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/sample_query_set_service.py @@ -39,23 +39,27 @@ class GetSampleQuerySetRequest(proto.Message): r"""Request message for - [SampleQuerySetService.GetSampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySetService.GetSampleQuerySet] + `SampleQuerySetService.GetSampleQuerySet + `__ method. Attributes: name (str): Required. Full resource name of - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], + `SampleQuerySet + `__, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}``. - If the caller does not have permission to access the - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. + If the caller does not have permission to access + the `SampleQuerySet + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. If the requested - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] + `SampleQuerySet + `__ does not exist, a NOT_FOUND error is returned. """ @@ -67,38 +71,48 @@ class GetSampleQuerySetRequest(proto.Message): class ListSampleQuerySetsRequest(proto.Message): r"""Request message for - [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1beta.SampleQuerySetService.ListSampleQuerySets] + `SampleQuerySetService.ListSampleQuerySets + `__ method. Attributes: parent (str): - Required. The parent location resource name, such as + Required. The parent location resource name, + such as ``projects/{project}/locations/{location}``. If the caller does not have permission to list - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s - under this location, regardless of whether or not this - location exists, a ``PERMISSION_DENIED`` error is returned. + `SampleQuerySet + `__s + under this location, regardless of whether or + not this location exists, a + ``PERMISSION_DENIED`` error is returned. page_size (int): Maximum number of - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s - to return. If unspecified, defaults to 100. The maximum - allowed value is 1000. Values above 1000 will be coerced to - 1000. + `SampleQuerySet + `__s + to return. If unspecified, defaults to 100. The + maximum allowed value is 1000. Values above 1000 + will be coerced to 1000. - If this field is negative, an ``INVALID_ARGUMENT`` error is - returned. + If this field is negative, an + ``INVALID_ARGUMENT`` error is returned. page_token (str): A page token - [ListSampleQuerySetsResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListSampleQuerySetsResponse.next_page_token], + `ListSampleQuerySetsResponse.next_page_token + `__, received from a previous - [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1beta.SampleQuerySetService.ListSampleQuerySets] - call. Provide this to retrieve the subsequent page. - - When paginating, all other parameters provided to - [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1beta.SampleQuerySetService.ListSampleQuerySets] - must match the call that provided the page token. Otherwise, - an ``INVALID_ARGUMENT`` error is returned. + `SampleQuerySetService.ListSampleQuerySets + `__ + call. Provide this to retrieve the subsequent + page. + + When paginating, all other parameters provided + to `SampleQuerySetService.ListSampleQuerySets + `__ + must match the call that provided the page + token. Otherwise, an ``INVALID_ARGUMENT`` error + is returned. """ parent: str = proto.Field( @@ -117,18 +131,20 @@ class ListSampleQuerySetsRequest(proto.Message): class ListSampleQuerySetsResponse(proto.Message): r"""Response message for - [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1beta.SampleQuerySetService.ListSampleQuerySets] + `SampleQuerySetService.ListSampleQuerySets + `__ method. Attributes: sample_query_sets (MutableSequence[google.cloud.discoveryengine_v1beta.types.SampleQuerySet]): - The - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s. + The `SampleQuerySet + `__s. next_page_token (str): A token that can be sent as - [ListSampleQuerySetsRequest.page_token][google.cloud.discoveryengine.v1beta.ListSampleQuerySetsRequest.page_token] - to retrieve the next page. If this field is omitted, there - are no subsequent pages. + `ListSampleQuerySetsRequest.page_token + `__ + to retrieve the next page. If this field is + omitted, there are no subsequent pages. """ @property @@ -150,7 +166,8 @@ def raw_page(self): class CreateSampleQuerySetRequest(proto.Message): r"""Request message for - [SampleQuerySetService.CreateSampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySetService.CreateSampleQuerySet] + `SampleQuerySetService.CreateSampleQuerySet + `__ method. Attributes: @@ -159,29 +176,37 @@ class CreateSampleQuerySetRequest(proto.Message): ``projects/{project}/locations/{location}``. sample_query_set (google.cloud.discoveryengine_v1beta.types.SampleQuerySet): Required. The - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] + `SampleQuerySet + `__ to create. sample_query_set_id (str): Required. The ID to use for the - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], + `SampleQuerySet + `__, which will become the final component of the - [SampleQuerySet.name][google.cloud.discoveryengine.v1beta.SampleQuerySet.name]. + `SampleQuerySet.name + `__. - If the caller does not have permission to create the - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], + If the caller does not have permission to create + the `SampleQuerySet + `__, regardless of whether or not it exists, a ``PERMISSION_DENIED`` error is returned. This field must be unique among all - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s + `SampleQuerySet + `__s with the same - [parent][google.cloud.discoveryengine.v1beta.CreateSampleQuerySetRequest.parent]. - Otherwise, an ``ALREADY_EXISTS`` error is returned. + `parent + `__. + Otherwise, an ``ALREADY_EXISTS`` error is + returned. - This field must conform to - `RFC-1034 `__ standard - with a length limit of 63 characters. Otherwise, an - ``INVALID_ARGUMENT`` error is returned. + This field must conform to `RFC-1034 + `__ + standard with a length limit of 63 characters. + Otherwise, an ``INVALID_ARGUMENT`` error is + returned. """ parent: str = proto.Field( @@ -201,21 +226,24 @@ class CreateSampleQuerySetRequest(proto.Message): class UpdateSampleQuerySetRequest(proto.Message): r"""Request message for - [SampleQuerySetService.UpdateSampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySetService.UpdateSampleQuerySet] + `SampleQuerySetService.UpdateSampleQuerySet + `__ method. Attributes: sample_query_set (google.cloud.discoveryengine_v1beta.types.SampleQuerySet): Required. The sample query set to update. - If the caller does not have permission to update the - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], + If the caller does not have permission to update + the `SampleQuerySet + `__, regardless of whether or not it exists, a ``PERMISSION_DENIED`` error is returned. - If the - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] - to update does not exist a ``NOT_FOUND`` error is returned. + If the `SampleQuerySet + `__ + to update does not exist a ``NOT_FOUND`` error + is returned. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided imported 'sample query set' to update. If not @@ -236,24 +264,28 @@ class UpdateSampleQuerySetRequest(proto.Message): class DeleteSampleQuerySetRequest(proto.Message): r"""Request message for - [SampleQuerySetService.DeleteSampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySetService.DeleteSampleQuerySet] + `SampleQuerySetService.DeleteSampleQuerySet + `__ method. Attributes: name (str): Required. Full resource name of - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], + `SampleQuerySet + `__, such as ``projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}``. - If the caller does not have permission to delete the - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], + If the caller does not have permission to delete + the `SampleQuerySet + `__, regardless of whether or not it exists, a ``PERMISSION_DENIED`` error is returned. - If the - [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] - to delete does not exist, a ``NOT_FOUND`` error is returned. + If the `SampleQuerySet + `__ + to delete does not exist, a ``NOT_FOUND`` error + is returned. """ name: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/schema.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/schema.py index 26a07ce369a8..6a89ca01f3a1 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/schema.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/schema.py @@ -48,12 +48,12 @@ class Schema(proto.Message): This field is a member of `oneof`_ ``schema``. name (str): - Immutable. The full resource name of the schema, in the - format of + Immutable. The full resource name of the schema, + in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}``. - This field must be a UTF-8 encoded string with a length - limit of 1024 characters. + This field must be a UTF-8 encoded string with a + length limit of 1024 characters. """ struct_schema: struct_pb2.Struct = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/schema_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/schema_service.py index 42437b4bf244..59dd7ec353f3 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/schema_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/schema_service.py @@ -40,13 +40,14 @@ class GetSchemaRequest(proto.Message): r"""Request message for - [SchemaService.GetSchema][google.cloud.discoveryengine.v1beta.SchemaService.GetSchema] + `SchemaService.GetSchema + `__ method. Attributes: name (str): - Required. The full resource name of the schema, in the - format of + Required. The full resource name of the schema, + in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}``. """ @@ -58,33 +59,40 @@ class GetSchemaRequest(proto.Message): class ListSchemasRequest(proto.Message): r"""Request message for - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas] + `SchemaService.ListSchemas + `__ method. Attributes: parent (str): - Required. The parent data store resource name, in the format - of + Required. The parent data store resource name, + in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}``. page_size (int): - The maximum number of - [Schema][google.cloud.discoveryengine.v1beta.Schema]s to - return. The service may return fewer than this value. + The maximum number of `Schema + `__s + to return. The service may return fewer than + this value. If unspecified, at most 100 - [Schema][google.cloud.discoveryengine.v1beta.Schema]s are - returned. + `Schema + `__s + are returned. - The maximum value is 1000; values above 1000 are set to - 1000. + The maximum value is 1000; values above 1000 are + set to 1000. page_token (str): A page token, received from a previous - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas] - call. Provide this to retrieve the subsequent page. - - When paginating, all other parameters provided to - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas] - must match the call that provided the page token. + `SchemaService.ListSchemas + `__ + call. Provide this to retrieve the subsequent + page. + + When paginating, all other parameters provided + to `SchemaService.ListSchemas + `__ + must match the call that provided the page + token. """ parent: str = proto.Field( @@ -103,17 +111,20 @@ class ListSchemasRequest(proto.Message): class ListSchemasResponse(proto.Message): r"""Response message for - [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas] + `SchemaService.ListSchemas + `__ method. Attributes: schemas (MutableSequence[google.cloud.discoveryengine_v1beta.types.Schema]): - The [Schema][google.cloud.discoveryengine.v1beta.Schema]s. + The `Schema + `__s. next_page_token (str): A token that can be sent as - [ListSchemasRequest.page_token][google.cloud.discoveryengine.v1beta.ListSchemasRequest.page_token] - to retrieve the next page. If this field is omitted, there - are no subsequent pages. + `ListSchemasRequest.page_token + `__ + to retrieve the next page. If this field is + omitted, there are no subsequent pages. """ @property @@ -133,27 +144,31 @@ def raw_page(self): class CreateSchemaRequest(proto.Message): r"""Request message for - [SchemaService.CreateSchema][google.cloud.discoveryengine.v1beta.SchemaService.CreateSchema] + `SchemaService.CreateSchema + `__ method. Attributes: parent (str): - Required. The parent data store resource name, in the format - of + Required. The parent data store resource name, + in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}``. schema (google.cloud.discoveryengine_v1beta.types.Schema): - Required. The - [Schema][google.cloud.discoveryengine.v1beta.Schema] to - create. + Required. The `Schema + `__ + to create. schema_id (str): Required. The ID to use for the - [Schema][google.cloud.discoveryengine.v1beta.Schema], which - becomes the final component of the - [Schema.name][google.cloud.discoveryengine.v1beta.Schema.name]. + `Schema + `__, + which becomes the final component of the + `Schema.name + `__. This field should conform to - `RFC-1034 `__ standard - with a length limit of 63 characters. + `RFC-1034 + `__ + standard with a length limit of 63 characters. """ parent: str = proto.Field( @@ -173,20 +188,23 @@ class CreateSchemaRequest(proto.Message): class UpdateSchemaRequest(proto.Message): r"""Request message for - [SchemaService.UpdateSchema][google.cloud.discoveryengine.v1beta.SchemaService.UpdateSchema] + `SchemaService.UpdateSchema + `__ method. Attributes: schema (google.cloud.discoveryengine_v1beta.types.Schema): - Required. The - [Schema][google.cloud.discoveryengine.v1beta.Schema] to - update. + Required. The `Schema + `__ + to update. allow_missing (bool): If set to true, and the - [Schema][google.cloud.discoveryengine.v1beta.Schema] is not - found, a new - [Schema][google.cloud.discoveryengine.v1beta.Schema] is - created. In this situation, ``update_mask`` is ignored. + `Schema + `__ + is not found, a new `Schema + `__ + is created. In this situation, ``update_mask`` + is ignored. """ schema: gcd_schema.Schema = proto.Field( @@ -202,13 +220,14 @@ class UpdateSchemaRequest(proto.Message): class DeleteSchemaRequest(proto.Message): r"""Request message for - [SchemaService.DeleteSchema][google.cloud.discoveryengine.v1beta.SchemaService.DeleteSchema] + `SchemaService.DeleteSchema + `__ method. Attributes: name (str): - Required. The full resource name of the schema, in the - format of + Required. The full resource name of the schema, + in the format of ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}``. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/search_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/search_service.py index a8bd37079766..28da78a5b630 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/search_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/search_service.py @@ -35,63 +35,72 @@ class SearchRequest(proto.Message): r"""Request message for - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] + `SearchService.Search + `__ method. Attributes: serving_config (str): - Required. The resource name of the Search serving config, - such as + Required. The resource name of the Search + serving config, such as ``projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config``, or ``projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config``. - This field is used to identify the serving configuration - name, set of models used to make the search. + This field is used to identify the serving + configuration name, set of models used to make + the search. branch (str): The branch resource name, such as ``projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0``. - Use ``default_branch`` as the branch ID or leave this field - empty, to search documents under the default branch. + Use ``default_branch`` as the branch ID or leave + this field empty, to search documents under the + default branch. query (str): Raw search query. image_query (google.cloud.discoveryengine_v1beta.types.SearchRequest.ImageQuery): Raw image query. page_size (int): - Maximum number of - [Document][google.cloud.discoveryengine.v1beta.Document]s to - return. The maximum allowed value depends on the data type. - Values above the maximum value are coerced to the maximum - value. - - - Websites with basic indexing: Default ``10``, Maximum - ``25``. - - Websites with advanced indexing: Default ``25``, Maximum - ``50``. - - Other: Default ``50``, Maximum ``100``. - - If this field is negative, an ``INVALID_ARGUMENT`` is - returned. + Maximum number of `Document + `__s + to return. The maximum allowed value depends on + the data type. Values above the maximum value + are coerced to the maximum value. + + * Websites with basic indexing: Default ``10``, + Maximum ``25``. * Websites with advanced + indexing: Default ``25``, Maximum ``50``. + + * Other: Default ``50``, Maximum ``100``. + + If this field is negative, an + ``INVALID_ARGUMENT`` is returned. page_token (str): A page token received from a previous - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] - call. Provide this to retrieve the subsequent page. - - When paginating, all other parameters provided to - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] - must match the call that provided the page token. Otherwise, - an ``INVALID_ARGUMENT`` error is returned. + `SearchService.Search + `__ + call. Provide this to retrieve the subsequent + page. + + When paginating, all other parameters provided + to `SearchService.Search + `__ + must match the call that provided the page + token. Otherwise, an ``INVALID_ARGUMENT`` + error is returned. offset (int): - A 0-indexed integer that specifies the current offset (that - is, starting result location, amongst the - [Document][google.cloud.discoveryengine.v1beta.Document]s - deemed by the API as relevant) in search results. This field - is only considered if - [page_token][google.cloud.discoveryengine.v1beta.SearchRequest.page_token] + A 0-indexed integer that specifies the current + offset (that is, starting result location, + amongst the `Document + `__s + deemed by the API as relevant) in search + results. This field is only considered if + `page_token + `__ is unset. - If this field is negative, an ``INVALID_ARGUMENT`` is - returned. + If this field is negative, an + ``INVALID_ARGUMENT`` is returned. one_box_page_size (int): The maximum number of results to return for OneBox. This applies to each OneBox type @@ -104,98 +113,115 @@ class SearchRequest(proto.Message): dataStore within an engine, they should use the specs at the top level. filter (str): - The filter syntax consists of an expression language for - constructing a predicate from one or more fields of the - documents being filtered. Filter expression is - case-sensitive. - - If this field is unrecognizable, an ``INVALID_ARGUMENT`` is - returned. - - Filtering in Vertex AI Search is done by mapping the LHS - filter key to a key property defined in the Vertex AI Search - backend -- this mapping is defined by the customer in their - schema. For example a media customer might have a field - 'name' in their schema. In this case the filter would look - like this: filter --> name:'ANY("king kong")' - - For more information about filtering including syntax and - filter operators, see - `Filter `__ + The filter syntax consists of an expression + language for constructing a predicate from one + or more fields of the documents being filtered. + Filter expression is case-sensitive. + + If this field is unrecognizable, an + ``INVALID_ARGUMENT`` is returned. + + Filtering in Vertex AI Search is done by mapping + the LHS filter key to a key property defined in + the Vertex AI Search backend -- this mapping is + defined by the customer in their schema. For + example a media customer might have a field + 'name' in their schema. In this case the filter + would look like this: filter --> name:'ANY("king + kong")' + + For more information about filtering including + syntax and filter operators, see + `Filter + `__ canonical_filter (str): - The default filter that is applied when a user performs a - search without checking any filters on the search page. - - The filter applied to every search request when quality - improvement such as query expansion is needed. In the case a - query does not have a sufficient amount of results this - filter will be used to determine whether or not to enable - the query expansion flow. The original filter will still be - used for the query expanded search. This field is strongly - recommended to achieve high search quality. + The default filter that is applied when a user + performs a search without checking any filters + on the search page. + + The filter applied to every search request when + quality improvement such as query expansion is + needed. In the case a query does not have a + sufficient amount of results this filter will be + used to determine whether or not to enable the + query expansion flow. The original filter will + still be used for the query expanded search. + This field is strongly recommended to achieve + high search quality. For more information about filter syntax, see - [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter]. + `SearchRequest.filter + `__. order_by (str): - The order in which documents are returned. Documents can be - ordered by a field in an - [Document][google.cloud.discoveryengine.v1beta.Document] - object. Leave it unset if ordered by relevance. ``order_by`` - expression is case-sensitive. - - For more information on ordering the website search results, - see `Order web search - results `__. - For more information on ordering the healthcare search - results, see `Order healthcare search - results `__. - If this field is unrecognizable, an ``INVALID_ARGUMENT`` is - returned. + The order in which documents are returned. + Documents can be ordered by a field in an + `Document + `__ + object. Leave it unset if ordered by relevance. + ``order_by`` expression is case-sensitive. + + For more information on ordering the website + search results, see `Order web search + results + `__. + For more information on ordering the healthcare + search results, see `Order healthcare search + results + `__. + If this field is unrecognizable, an + ``INVALID_ARGUMENT`` is returned. user_info (google.cloud.discoveryengine_v1beta.types.UserInfo): - Information about the end user. Highly recommended for - analytics. - [UserInfo.user_agent][google.cloud.discoveryengine.v1beta.UserInfo.user_agent] + Information about the end user. + Highly recommended for analytics. + `UserInfo.user_agent + `__ is used to deduce ``device_type`` for analytics. language_code (str): - The BCP-47 language code, such as "en-US" or "sr-Latn". For - more information, see `Standard - fields `__. - This field helps to better interpret the query. If a value - isn't specified, the query language code is automatically - detected, which may not be accurate. + The BCP-47 language code, such as "en-US" or + "sr-Latn". For more information, see `Standard + fields + `__. + This field helps to better interpret the query. + If a value isn't specified, the query language + code is automatically detected, which may not be + accurate. region_code (str): - The Unicode country/region code (CLDR) of a location, such - as "US" and "419". For more information, see `Standard - fields `__. - If set, then results will be boosted based on the - region_code provided. + The Unicode country/region code (CLDR) of a + location, such as "US" and "419". For more + information, see `Standard fields + `__. + If set, then results will be boosted based on + the region_code provided. facet_specs (MutableSequence[google.cloud.discoveryengine_v1beta.types.SearchRequest.FacetSpec]): - Facet specifications for faceted search. If empty, no facets - are returned. - - A maximum of 100 values are allowed. Otherwise, an - ``INVALID_ARGUMENT`` error is returned. + Facet specifications for faceted search. If + empty, no facets are returned. + A maximum of 100 values are allowed. Otherwise, + an ``INVALID_ARGUMENT`` error is returned. boost_spec (google.cloud.discoveryengine_v1beta.types.SearchRequest.BoostSpec): - Boost specification to boost certain documents. For more - information on boosting, see - `Boosting `__ + Boost specification to boost certain documents. + For more information on boosting, see + `Boosting + `__ params (MutableMapping[str, google.protobuf.struct_pb2.Value]): Additional search parameters. - For public website search only, supported values are: + For public website search only, supported values + are: - - ``user_country_code``: string. Default empty. If set to - non-empty, results are restricted or boosted based on the - location provided. For example, - ``user_country_code: "au"`` + * ``user_country_code``: string. Default empty. + If set to non-empty, results are restricted + or boosted based on the location provided. + For example, ``user_country_code: "au"`` - For available codes see `Country - Codes `__ + For available codes see `Country + Codes + `__ - - ``search_type``: double. Default empty. Enables - non-webpage searching depending on the value. The only - valid non-default value is 1, which enables image - searching. For example, ``search_type: 1`` + * ``search_type``: double. Default empty. + Enables non-webpage searching depending on + the value. The only valid non-default value is + 1, which enables image searching. + For example, ``search_type: 1`` query_expansion_spec (google.cloud.discoveryengine_v1beta.types.SearchRequest.QueryExpansionSpec): The query expansion specification that specifies the conditions under which query @@ -205,68 +231,62 @@ class SearchRequest(proto.Message): specifies the mode under which spell correction takes effect. user_pseudo_id (str): - A unique identifier for tracking visitors. For example, this - could be implemented with an HTTP cookie, which should be - able to uniquely identify a visitor on a single device. This - unique identifier should not change if the visitor logs in - or out of the website. + A unique identifier for tracking visitors. For + example, this could be implemented with an HTTP + cookie, which should be able to uniquely + identify a visitor on a single device. This + unique identifier should not change if the + visitor logs in or out of the website. This field should NOT have a fixed value such as ``unknown_visitor``. This should be the same identifier as - [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id] + `UserEvent.user_pseudo_id + `__ and - [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.CompleteQueryRequest.user_pseudo_id] + `CompleteQueryRequest.user_pseudo_id + `__ - The field must be a UTF-8 encoded string with a length limit - of 128 characters. Otherwise, an ``INVALID_ARGUMENT`` error - is returned. + The field must be a UTF-8 encoded string with a + length limit of 128 characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. content_search_spec (google.cloud.discoveryengine_v1beta.types.SearchRequest.ContentSearchSpec): A specification for configuring the behavior of content search. embedding_spec (google.cloud.discoveryengine_v1beta.types.SearchRequest.EmbeddingSpec): - Uses the provided embedding to do additional semantic - document retrieval. The retrieval is based on the dot - product of - [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector] + Uses the provided embedding to do additional + semantic document retrieval. The retrieval is + based on the dot product of + `SearchRequest.EmbeddingSpec.EmbeddingVector.vector + `__ and the document embedding that is provided in - [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path]. + `SearchRequest.EmbeddingSpec.EmbeddingVector.field_path + `__. If - [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path] + `SearchRequest.EmbeddingSpec.EmbeddingVector.field_path + `__ is not provided, it will use - [ServingConfig.EmbeddingConfig.field_path][google.cloud.discoveryengine.v1beta.ServingConfig.embedding_config]. + `ServingConfig.EmbeddingConfig.field_path + `__. ranking_expression (str): - The ranking expression controls the customized ranking on - retrieval documents. This overrides - [ServingConfig.ranking_expression][google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression]. - The syntax and supported features depend on the - ``ranking_expression_backend`` value. If - ``ranking_expression_backend`` is not provided, it defaults - to ``RANK_BY_EMBEDDING``. + The ranking expression controls the customized ranking on retrieval documents. This overrides [ServingConfig.ranking_expression][google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression]. The syntax and supported features depend on the ``ranking_expression_backend`` value. If ``ranking_expression_backend`` is not provided, it defaults to ``RANK_BY_EMBEDDING``. - If - [ranking_expression_backend][google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend] - is not provided or set to ``RANK_BY_EMBEDDING``, it should - be a single function or multiple functions that are joined - by "+". + If [ranking_expression_backend][google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend] is not provided or set to ``RANK_BY_EMBEDDING``, it should be a single function or multiple functions that are joined by "+". - - ranking_expression = function, { " + ", function }; + - ranking_expression = function, { " + ", function }; Supported functions: - - double \* relevance_score - - double \* dotProduct(embedding_field_path) + - double \* relevance_score + - double \* dotProduct(embedding_field_path) Function variables: - - ``relevance_score``: pre-defined keywords, used for - measure relevance between query and document. - - ``embedding_field_path``: the document embedding field - used with query embedding vector. - - ``dotProduct``: embedding function between - ``embedding_field_path`` and query embedding vector. + - ``relevance_score``: pre-defined keywords, used for measure relevance between query and document. + - ``embedding_field_path``: the document embedding field used with query embedding vector. + - ``dotProduct``: embedding function between ``embedding_field_path`` and query embedding vector. Example ranking expression: @@ -275,71 +295,34 @@ class SearchRequest(proto.Message): If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. - If - [ranking_expression_backend][google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend] - is set to ``RANK_BY_FORMULA``, the following expression - types (and combinations of those chained using + or - - - operators) are supported: - - - ``double`` - - ``signal`` - - ``log(signal)`` - - ``exp(signal)`` - - ``rr(signal, double > 0)`` -- reciprocal rank - transformation with second argument being a denominator - constant. - - ``is_nan(signal)`` -- returns 0 if signal is NaN, 1 - otherwise. - - ``fill_nan(signal1, signal2 | double)`` -- if signal1 is - NaN, returns signal2 \| double, else returns signal1. - - Here are a few examples of ranking formulas that use the - supported ranking expression types: - - - ``0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`` - -- mostly rank by the logarithm of - ``keyword_similarity_score`` with slight - ``semantic_smilarity_score`` adjustment. - - ``0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)`` - -- rank by the exponent of ``semantic_similarity_score`` - filling the value with 0 if it's NaN, also add constant - 0.3 adjustment to the final score if - ``semantic_similarity_score`` is NaN. - - ``0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)`` - -- mostly rank by the reciprocal rank of - ``keyword_similarity_score`` with slight adjustment of - reciprocal rank of ``semantic_smilarity_score``. + If [ranking_expression_backend][google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend] is set to ``RANK_BY_FORMULA``, the following expression types (and combinations of those chained using + or + + - operators) are supported: + + - ``double`` + - ``signal`` + - ``log(signal)`` + - ``exp(signal)`` + - ``rr(signal, double > 0)`` -- reciprocal rank transformation with second argument being a denominator constant. + - ``is_nan(signal)`` -- returns 0 if signal is NaN, 1 otherwise. + - ``fill_nan(signal1, signal2 | double)`` -- if signal1 is NaN, returns signal2 \| double, else returns signal1. + + Here are a few examples of ranking formulas that use the supported ranking expression types: + + - ``0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`` -- mostly rank by the logarithm of ``keyword_similarity_score`` with slight ``semantic_smilarity_score`` adjustment. + - ``0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)`` -- rank by the exponent of ``semantic_similarity_score`` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if ``semantic_similarity_score`` is NaN. + - ``0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)`` -- mostly rank by the reciprocal rank of ``keyword_similarity_score`` with slight adjustment of reciprocal rank of ``semantic_smilarity_score``. The following signals are supported: - - ``semantic_similarity_score``: semantic similarity - adjustment that is calculated using the embeddings - generated by a proprietary Google model. This score - determines how semantically similar a search query is to a - document. - - ``keyword_similarity_score``: keyword match adjustment - uses the Best Match 25 (BM25) ranking function. This score - is calculated using a probabilistic model to estimate the - probability that a document is relevant to a given query. - - ``relevance_score``: semantic relevance adjustment that - uses a proprietary Google model to determine the meaning - and intent behind a user's query in context with the - content in the documents. - - ``pctr_rank``: predicted conversion rate adjustment as a - rank use predicted Click-through rate (pCTR) to gauge the - relevance and attractiveness of a search result from a - user's perspective. A higher pCTR suggests that the result - is more likely to satisfy the user's query and intent, - making it a valuable signal for ranking. - - ``freshness_rank``: freshness adjustment as a rank - - ``document_age``: The time in hours elapsed since the - document was last updated, a floating-point number (e.g., - 0.25 means 15 minutes). - - ``topicality_rank``: topicality adjustment as a rank. Uses - proprietary Google model to determine the keyword-based - overlap between the query and the document. - - ``base_rank``: the default rank of the result + - ``semantic_similarity_score``: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. + - ``keyword_similarity_score``: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. + - ``relevance_score``: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. + - ``pctr_rank``: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. + - ``freshness_rank``: freshness adjustment as a rank + - ``document_age``: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). + - ``topicality_rank``: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. + - ``base_rank``: the default rank of the result ranking_expression_backend (google.cloud.discoveryengine_v1beta.types.SearchRequest.RankingExpressionBackend): The backend to use for the ranking expression evaluation. @@ -347,34 +330,41 @@ class SearchRequest(proto.Message): Whether to turn on safe search. This is only supported for website search. user_labels (MutableMapping[str, str]): - The user labels applied to a resource must meet the - following requirements: - - - Each resource can have multiple labels, up to a maximum of - 64. - - Each label must be a key-value pair. - - Keys have a minimum length of 1 character and a maximum - length of 63 characters and cannot be empty. Values can be - empty and have a maximum length of 63 characters. - - Keys and values can contain only lowercase letters, - numeric characters, underscores, and dashes. All - characters must use UTF-8 encoding, and international - characters are allowed. - - The key portion of a label must be unique. However, you - can use the same key with multiple resources. - - Keys must start with a lowercase letter or international - character. + The user labels applied to a resource must meet + the following requirements: + * Each resource can have multiple labels, up to + a maximum of 64. + + * Each label must be a key-value pair. + * Keys have a minimum length of 1 character and + a maximum length of 63 characters and cannot + be empty. Values can be empty and have a maximum + length of 63 characters. + + * Keys and values can contain only lowercase + letters, numeric characters, underscores, and + dashes. All characters must use UTF-8 encoding, + and international characters are allowed. + + * The key portion of a label must be unique. + However, you can use the same key with + multiple resources. + + * Keys must start with a lowercase letter or + international character. See `Google Cloud - Document `__ + Document + `__ for more details. natural_language_query_understanding_spec (google.cloud.discoveryengine_v1beta.types.SearchRequest.NaturalLanguageQueryUnderstandingSpec): - If ``naturalLanguageQueryUnderstandingSpec`` is not - specified, no additional natural language query - understanding will be done. + If ``naturalLanguageQueryUnderstandingSpec`` is + not specified, no additional natural language + query understanding will be done. search_as_you_type_spec (google.cloud.discoveryengine_v1beta.types.SearchRequest.SearchAsYouTypeSpec): - Search as you type configuration. Only supported for the - [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1beta.IndustryVertical.MEDIA] + Search as you type configuration. Only supported + for the `IndustryVertical.MEDIA + `__ vertical. session (str): The session resource name. Optional. @@ -421,13 +411,17 @@ class SearchRequest(proto.Message): The specification for personalization. Notice that if both - [ServingConfig.personalization_spec][google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec] + `ServingConfig.personalization_spec + `__ and - [SearchRequest.personalization_spec][google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec] + `SearchRequest.personalization_spec + `__ are set, - [SearchRequest.personalization_spec][google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec] + `SearchRequest.personalization_spec + `__ overrides - [ServingConfig.personalization_spec][google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec]. + `ServingConfig.personalization_spec + `__. """ class RelevanceThreshold(proto.Enum): @@ -498,14 +492,16 @@ class DataStoreSpec(proto.Message): Attributes: data_store (str): Required. Full resource name of - [DataStore][google.cloud.discoveryengine.v1beta.DataStore], + `DataStore + `__, such as ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. filter (str): - Optional. Filter specification to filter documents in the - data store specified by data_store field. For more - information on filtering, see - `Filtering `__ + Optional. Filter specification to filter + documents in the data store specified by + data_store field. For more information on + filtering, see `Filtering + `__ """ data_store: str = proto.Field( @@ -524,80 +520,91 @@ class FacetSpec(proto.Message): facet_key (google.cloud.discoveryengine_v1beta.types.SearchRequest.FacetSpec.FacetKey): Required. The facet key specification. limit (int): - Maximum facet values that are returned for this facet. If - unspecified, defaults to 20. The maximum allowed value is - 300. Values above 300 are coerced to 300. For aggregation in - healthcare search, when the [FacetKey.key] is - "healthcare_aggregation_key", the limit will be overridden - to 10,000 internally, regardless of the value set here. - - If this field is negative, an ``INVALID_ARGUMENT`` is - returned. + Maximum facet values that are returned for this + facet. If unspecified, defaults to 20. The + maximum allowed value is 300. Values above 300 + are coerced to 300. + For aggregation in healthcare search, when the + [FacetKey.key] is "healthcare_aggregation_key", + the limit will be overridden to 10,000 + internally, regardless of the value set here. + + If this field is negative, an + ``INVALID_ARGUMENT`` is returned. excluded_filter_keys (MutableSequence[str]): List of keys to exclude when faceting. By default, - [FacetKey.key][google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey.key] - is not excluded from the filter unless it is listed in this - field. - - Listing a facet key in this field allows its values to - appear as facet results, even when they are filtered out of - search results. Using this field does not affect what search - results are returned. - - For example, suppose there are 100 documents with the color - facet "Red" and 200 documents with the color facet "Blue". A - query containing the filter "color:ANY("Red")" and having - "color" as - [FacetKey.key][google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey.key] - would by default return only "Red" documents in the search - results, and also return "Red" with count 100 as the only - color facet. Although there are also blue documents - available, "Blue" would not be shown as an available facet - value. - - If "color" is listed in "excludedFilterKeys", then the query - returns the facet values "Red" with count 100 and "Blue" - with count 200, because the "color" key is now excluded from - the filter. Because this field doesn't affect search - results, the search results are still correctly filtered to - return only "Red" documents. - - A maximum of 100 values are allowed. Otherwise, an - ``INVALID_ARGUMENT`` error is returned. + `FacetKey.key + `__ + is not excluded from the filter unless it is + listed in this field. + + Listing a facet key in this field allows its + values to appear as facet results, even when + they are filtered out of search results. Using + this field does not affect what search results + are returned. + + For example, suppose there are 100 documents + with the color facet "Red" and 200 documents + with the color facet "Blue". A query containing + the filter "color:ANY("Red")" and having "color" + as `FacetKey.key + `__ + would by default return only "Red" documents in + the search results, and also return "Red" with + count 100 as the only color facet. Although + there are also blue documents available, "Blue" + would not be shown as an available facet value. + + If "color" is listed in "excludedFilterKeys", + then the query returns the facet values "Red" + with count 100 and "Blue" with count 200, + because the "color" key is now excluded from the + filter. Because this field doesn't affect search + results, the search results are still correctly + filtered to return only "Red" documents. + + A maximum of 100 values are allowed. Otherwise, + an ``INVALID_ARGUMENT`` error is returned. enable_dynamic_position (bool): - Enables dynamic position for this facet. If set to true, the - position of this facet among all facets in the response is - determined automatically. If dynamic facets are enabled, it - is ordered together. If set to false, the position of this - facet in the response is the same as in the request, and it - is ranked before the facets with dynamic position enable and - all dynamic facets. - - For example, you may always want to have rating facet - returned in the response, but it's not necessarily to always - display the rating facet at the top. In that case, you can - set enable_dynamic_position to true so that the position of - rating facet in response is determined automatically. - - Another example, assuming you have the following facets in - the request: - - - "rating", enable_dynamic_position = true - - - "price", enable_dynamic_position = false - - - "brands", enable_dynamic_position = false - - And also you have a dynamic facets enabled, which generates - a facet ``gender``. Then the final order of the facets in - the response can be ("price", "brands", "rating", "gender") - or ("price", "brands", "gender", "rating") depends on how - API orders "gender" and "rating" facets. However, notice - that "price" and "brands" are always ranked at first and - second position because their enable_dynamic_position is - false. + Enables dynamic position for this facet. If set + to true, the position of this facet among all + facets in the response is determined + automatically. If dynamic facets are enabled, it + is ordered together. If set to false, the + position of this facet in the response is the + same as in the request, and it is ranked before + the facets with dynamic position enable and all + dynamic facets. + + For example, you may always want to have rating + facet returned in the response, but it's not + necessarily to always display the rating facet + at the top. In that case, you can set + enable_dynamic_position to true so that the + position of rating facet in response is + determined automatically. + + Another example, assuming you have the following + facets in the request: + + * "rating", enable_dynamic_position = true + + * "price", enable_dynamic_position = false + + * "brands", enable_dynamic_position = false + + And also you have a dynamic facets enabled, + which generates a facet ``gender``. Then the + final order of the facets in the response can be + ("price", "brands", "rating", "gender") or + ("price", "brands", "gender", "rating") depends + on how API orders "gender" and "rating" facets. + However, notice that "price" and "brands" are + always ranked at first and second position + because their enable_dynamic_position is false. """ class FacetKey(proto.Message): @@ -605,21 +612,23 @@ class FacetKey(proto.Message): Attributes: key (str): - Required. Supported textual and numerical facet keys in - [Document][google.cloud.discoveryengine.v1beta.Document] - object, over which the facet values are computed. Facet key - is case-sensitive. + Required. Supported textual and numerical facet + keys in `Document + `__ + object, over which the facet values are + computed. Facet key is case-sensitive. intervals (MutableSequence[google.cloud.discoveryengine_v1beta.types.Interval]): Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30. restricted_values (MutableSequence[str]): - Only get facet for the given restricted values. Only - supported on textual fields. For example, suppose "category" - has three values "Action > 2022", "Action > 2021" and - "Sci-Fi > 2022". If set "restricted_values" to "Action > - 2022", the "category" facet only contains "Action > 2022". + Only get facet for the given restricted values. + Only supported on textual fields. For example, + suppose "category" has three values "Action > + 2022", "Action > 2021" and "Sci-Fi > 2022". If + set "restricted_values" to "Action > 2022", the + "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10. prefixes (MutableSequence[str]): Only get facet values that start with the @@ -647,18 +656,24 @@ class FacetKey(proto.Message): Allowed values are: - - "count desc", which means order by - [SearchResponse.Facet.values.count][google.cloud.discoveryengine.v1beta.SearchResponse.Facet.FacetValue.count] - descending. - - - "value desc", which means order by - [SearchResponse.Facet.values.value][google.cloud.discoveryengine.v1beta.SearchResponse.Facet.FacetValue.value] - descending. Only applies to textual facets. - - If not set, textual values are sorted in `natural - order `__; - numerical intervals are sorted in the order given by - [FacetSpec.FacetKey.intervals][google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey.intervals]. + * "count desc", which means order by + `SearchResponse.Facet.values.count + `__ + descending. + + * "value desc", which means order by + `SearchResponse.Facet.values.value + `__ + descending. + Only applies to textual facets. + + If not set, textual values are sorted in + `natural order + `__; + numerical intervals are sorted in the order + given by + `FacetSpec.FacetKey.intervals + `__. """ key: str = proto.Field( @@ -727,39 +742,46 @@ class ConditionBoostSpec(proto.Message): Attributes: condition (str): - An expression which specifies a boost condition. The syntax - and supported fields are the same as a filter expression. - See - [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter] + An expression which specifies a boost condition. + The syntax and supported fields are the same as + a filter expression. See `SearchRequest.filter + `__ for detail syntax and limitations. Examples: - - To boost documents with document ID "doc_1" or "doc_2", - and color "Red" or "Blue": - ``(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`` + * To boost documents with document ID "doc_1" or + "doc_2", and color "Red" or "Blue": + + ``(document_id: ANY("doc_1", "doc_2")) AND + (color: ANY("Red", "Blue"))`` boost (float): - Strength of the condition boost, which should be in [-1, 1]. - Negative boost means demotion. Default is 0.0. - - Setting to 1.0 gives the document a big promotion. However, - it does not necessarily mean that the boosted document will - be the top result at all times, nor that other documents - will be excluded. Results could still be shown even when - none of them matches the condition. And results that are - significantly more relevant to the search query can still - trump your heavily favored but irrelevant documents. - - Setting to -1.0 gives the document a big demotion. However, - results that are deeply relevant might still be shown. The - document will have an upstream battle to get a fairly high + Strength of the condition boost, which should be + in [-1, 1]. Negative boost means demotion. + Default is 0.0. + + Setting to 1.0 gives the document a big + promotion. However, it does not necessarily mean + that the boosted document will be the top result + at all times, nor that other documents will be + excluded. Results could still be shown even when + none of them matches the condition. And results + that are significantly more relevant to the + search query can still trump your heavily + favored but irrelevant documents. + + Setting to -1.0 gives the document a big + demotion. However, results that are deeply + relevant might still be shown. The document will + have an upstream battle to get a fairly high ranking, but it is not blocked out completely. - Setting to 0.0 means no boost applied. The boosting - condition is ignored. Only one of the (condition, boost) - combination or the boost_control_spec below are set. If both - are set then the global boost is ignored and the more - fine-grained boost_control_spec is applied. + Setting to 0.0 means no boost applied. The + boosting condition is ignored. Only one of the + (condition, boost) combination or the + boost_control_spec below are set. If both are + set then the global boost is ignored and the + more fine-grained boost_control_spec is applied. boost_control_spec (google.cloud.discoveryengine_v1beta.types.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec): Complex specification for custom ranking based on customer defined attribute value. @@ -775,19 +797,22 @@ class BoostControlSpec(proto.Message): The name of the field whose value will be used to determine the boost amount. attribute_type (google.cloud.discoveryengine_v1beta.types.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType): - The attribute type to be used to determine the boost amount. - The attribute value can be derived from the field value of - the specified field_name. In the case of numerical it is + The attribute type to be used to determine the + boost amount. The attribute value can be derived + from the field value of the specified + field_name. In the case of numerical it is straightforward i.e. attribute_value = - numerical_field_value. In the case of freshness however, - attribute_value = (time.now() - datetime_field_value). + numerical_field_value. In the case of freshness + however, attribute_value = (time.now() - + datetime_field_value). interpolation_type (google.cloud.discoveryengine_v1beta.types.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType): The interpolation type to be applied to connect the control points listed below. control_points (MutableSequence[google.cloud.discoveryengine_v1beta.types.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint]): - The control points used to define the curve. The monotonic - function (defined through the interpolation_type above) - passes through the control points listed here. + The control points used to define the curve. The + monotonic function (defined through the + interpolation_type above) passes through the + control points listed here. """ class AttributeType(proto.Enum): @@ -798,19 +823,21 @@ class AttributeType(proto.Enum): ATTRIBUTE_TYPE_UNSPECIFIED (0): Unspecified AttributeType. NUMERICAL (1): - The value of the numerical field will be used to dynamically - update the boost amount. In this case, the attribute_value - (the x value) of the control point will be the actual value - of the numerical field for which the boost_amount is + The value of the numerical field will be used to + dynamically update the boost amount. In this + case, the attribute_value (the x value) of the + control point will be the actual value of the + numerical field for which the boost_amount is specified. FRESHNESS (2): - For the freshness use case the attribute value will be the - duration between the current time and the date in the - datetime field specified. The value must be formatted as an - XSD ``dayTimeDuration`` value (a restricted subset of an ISO - 8601 duration value). The pattern for this is: - ``[nD][T[nH][nM][nS]]``. For example, ``5D``, ``3DT12H30M``, - ``T24H``. + For the freshness use case the attribute value + will be the duration between the current time + and the date in the datetime field specified. + The value must be formatted as an XSD + ``dayTimeDuration`` value (a restricted subset + of an ISO 8601 duration value). The pattern for + this is: ```nD `__`nM `__]``. For + example, ``5D``, ``3DT12H30M``, ``T24H``. """ ATTRIBUTE_TYPE_UNSPECIFIED = 0 NUMERICAL = 1 @@ -841,13 +868,16 @@ class ControlPoint(proto.Message): Can be one of: 1. The numerical field value. - 2. The duration spec for freshness: The value must be - formatted as an XSD ``dayTimeDuration`` value (a - restricted subset of an ISO 8601 duration value). The - pattern for this is: ``[nD][T[nH][nM][nS]]``. + 2. The duration spec for freshness: + + The value must be formatted as an XSD + ``dayTimeDuration`` value (a restricted subset + of an ISO 8601 duration value). The pattern for + this is: ```nD `__`nM `__]``. boost_amount (float): - The value between -1 to 1 by which to boost the score if the - attribute_value evaluates to the value specified above. + The value between -1 to 1 by which to boost the + score if the attribute_value evaluates to the + value specified above. """ attribute_value: str = proto.Field( @@ -909,9 +939,9 @@ class QueryExpansionSpec(proto.Message): Attributes: condition (google.cloud.discoveryengine_v1beta.types.SearchRequest.QueryExpansionSpec.Condition): - The condition under which query expansion should occur. - Default to - [Condition.DISABLED][google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec.Condition.DISABLED]. + The condition under which query expansion should + occur. Default to `Condition.DISABLED + `__. pin_unexpanded_results (bool): Whether to pin unexpanded results. If this field is set to true, unexpanded products are @@ -925,13 +955,15 @@ class Condition(proto.Enum): Values: CONDITION_UNSPECIFIED (0): - Unspecified query expansion condition. In this case, server - behavior defaults to - [Condition.DISABLED][google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec.Condition.DISABLED]. + Unspecified query expansion condition. In this + case, server behavior defaults to + `Condition.DISABLED + `__. DISABLED (1): - Disabled query expansion. Only the exact search query is - used, even if - [SearchResponse.total_size][google.cloud.discoveryengine.v1beta.SearchResponse.total_size] + Disabled query expansion. Only the exact search + query is used, even if + `SearchResponse.total_size + `__ is zero. AUTO (2): Automatic query expansion built by the Search @@ -956,9 +988,10 @@ class SpellCorrectionSpec(proto.Message): Attributes: mode (google.cloud.discoveryengine_v1beta.types.SearchRequest.SpellCorrectionSpec.Mode): - The mode under which spell correction replaces the original - search query. Defaults to - [Mode.AUTO][google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec.Mode.AUTO]. + The mode under which spell correction + replaces the original search query. Defaults to + `Mode.AUTO + `__. """ class Mode(proto.Enum): @@ -967,14 +1000,17 @@ class Mode(proto.Enum): Values: MODE_UNSPECIFIED (0): - Unspecified spell correction mode. In this case, server - behavior defaults to - [Mode.AUTO][google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec.Mode.AUTO]. + Unspecified spell correction mode. In this case, + server behavior defaults to + `Mode.AUTO + `__. SUGGESTION_ONLY (1): - Search API tries to find a spelling suggestion. If a - suggestion is found, it is put in the - [SearchResponse.corrected_query][google.cloud.discoveryengine.v1beta.SearchResponse.corrected_query]. - The spelling suggestion won't be used as the search query. + Search API tries to find a spelling suggestion. + If a suggestion is found, it is put in the + `SearchResponse.corrected_query + `__. + The spelling suggestion won't be used as the + search query. AUTO (2): Automatic spell correction built by the Search API. Search will be based on the @@ -996,28 +1032,32 @@ class ContentSearchSpec(proto.Message): Attributes: snippet_spec (google.cloud.discoveryengine_v1beta.types.SearchRequest.ContentSearchSpec.SnippetSpec): - If ``snippetSpec`` is not specified, snippets are not - included in the search response. + If ``snippetSpec`` is not specified, snippets + are not included in the search response. summary_spec (google.cloud.discoveryengine_v1beta.types.SearchRequest.ContentSearchSpec.SummarySpec): - If ``summarySpec`` is not specified, summaries are not - included in the search response. + If ``summarySpec`` is not specified, summaries + are not included in the search response. extractive_content_spec (google.cloud.discoveryengine_v1beta.types.SearchRequest.ContentSearchSpec.ExtractiveContentSpec): - If there is no extractive_content_spec provided, there will - be no extractive answer in the search response. + If there is no extractive_content_spec provided, + there will be no extractive answer in the search + response. search_result_mode (google.cloud.discoveryengine_v1beta.types.SearchRequest.ContentSearchSpec.SearchResultMode): - Specifies the search result mode. If unspecified, the search - result mode defaults to ``DOCUMENTS``. + Specifies the search result mode. If + unspecified, the search result mode defaults to + ``DOCUMENTS``. chunk_spec (google.cloud.discoveryengine_v1beta.types.SearchRequest.ContentSearchSpec.ChunkSpec): - Specifies the chunk spec to be returned from the search - response. Only available if the - [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode] + Specifies the chunk spec to be returned from the + search response. Only available if the + `SearchRequest.ContentSearchSpec.search_result_mode + `__ is set to - [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS] + `CHUNKS + `__ """ class SearchResultMode(proto.Enum): - r"""Specifies the search result mode. If unspecified, the search result - mode defaults to ``DOCUMENTS``. + r"""Specifies the search result mode. If unspecified, the + search result mode defaults to ``DOCUMENTS``. Values: SEARCH_RESULT_MODE_UNSPECIFIED (0): @@ -1025,9 +1065,10 @@ class SearchResultMode(proto.Enum): DOCUMENTS (1): Returns documents in the search result. CHUNKS (2): - Returns chunks in the search result. Only available if the - [DataStore.DocumentProcessingConfig.chunking_config][] is - specified. + Returns chunks in the search result. Only + available if the + [DataStore.DocumentProcessingConfig.chunking_config][] + is specified. """ SEARCH_RESULT_MODE_UNSPECIFIED = 0 DOCUMENTS = 1 @@ -1039,18 +1080,19 @@ class SnippetSpec(proto.Message): Attributes: max_snippet_count (int): - [DEPRECATED] This field is deprecated. To control snippet - return, use ``return_snippet`` field. For backwards - compatibility, we will return snippet if max_snippet_count > - 0. + [DEPRECATED] This field is deprecated. To + control snippet return, use ``return_snippet`` + field. For backwards compatibility, we will + return snippet if max_snippet_count > 0. reference_only (bool): - [DEPRECATED] This field is deprecated and will have no - affect on the snippet. + [DEPRECATED] This field is deprecated and will + have no affect on the snippet. return_snippet (bool): - If ``true``, then return snippet. If no snippet can be - generated, we return "No snippet is available for this - page." A ``snippet_status`` with ``SUCCESS`` or - ``NO_SNIPPET_AVAILABLE`` will also be returned. + If ``true``, then return snippet. If no snippet + can be generated, we return "No snippet is + available for this page." A ``snippet_status`` + with ``SUCCESS`` or ``NO_SNIPPET_AVAILABLE`` + will also be returned. """ max_snippet_count: int = proto.Field( @@ -1072,90 +1114,105 @@ class SummarySpec(proto.Message): Attributes: summary_result_count (int): - The number of top results to generate the summary from. If - the number of results returned is less than - ``summaryResultCount``, the summary is generated from all of - the results. - - At most 10 results for documents mode, or 50 for chunks - mode, can be used to generate a summary. The chunks mode is - used when - [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode] + The number of top results to generate the + summary from. If the number of results returned + is less than ``summaryResultCount``, the summary + is generated from all of the results. + + At most 10 results for documents mode, or 50 for + chunks mode, can be used to generate a summary. + The chunks mode is used when + `SearchRequest.ContentSearchSpec.search_result_mode + `__ is set to - [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]. + `CHUNKS + `__. include_citations (bool): - Specifies whether to include citations in the summary. The - default value is ``false``. + Specifies whether to include citations in the + summary. The default value is ``false``. - When this field is set to ``true``, summaries include - in-line citation numbers. + When this field is set to ``true``, summaries + include in-line citation numbers. Example summary including citations: - BigQuery is Google Cloud's fully managed and completely - serverless enterprise data warehouse [1]. BigQuery supports - all data types, works across clouds, and has built-in - machine learning and business intelligence, all within a - unified platform [2, 3]. - - The citation numbers refer to the returned search results - and are 1-indexed. For example, [1] means that the sentence - is attributed to the first search result. [2, 3] means that - the sentence is attributed to both the second and third - search results. + BigQuery is Google Cloud's fully managed and + completely serverless enterprise data warehouse + [1]. BigQuery supports all data types, works + across clouds, and has built-in machine learning + and business intelligence, all within a unified + platform [2, 3]. + + The citation numbers refer to the returned + search results and are 1-indexed. For example, + [1] means that the sentence is attributed to the + first search result. [2, 3] means that the + sentence is attributed to both the second and + third search results. ignore_adversarial_query (bool): - Specifies whether to filter out adversarial queries. The - default value is ``false``. + Specifies whether to filter out adversarial + queries. The default value is ``false``. - Google employs search-query classification to detect - adversarial queries. No summary is returned if the search - query is classified as an adversarial query. For example, a - user might ask a question regarding negative comments about - the company or submit a query designed to generate unsafe, - policy-violating output. If this field is set to ``true``, - we skip generating summaries for adversarial queries and - return fallback messages instead. + Google employs search-query classification to + detect adversarial queries. No summary is + returned if the search query is classified as an + adversarial query. For example, a user might ask + a question regarding negative comments about the + company or submit a query designed to generate + unsafe, policy-violating output. If this field + is set to ``true``, we skip generating summaries + for adversarial queries and return fallback + messages instead. ignore_non_summary_seeking_query (bool): - Specifies whether to filter out queries that are not - summary-seeking. The default value is ``false``. - - Google employs search-query classification to detect - summary-seeking queries. No summary is returned if the - search query is classified as a non-summary seeking query. - For example, ``why is the sky blue`` and - ``Who is the best soccer player in the world?`` are - summary-seeking queries, but ``SFO airport`` and - ``world cup 2026`` are not. They are most likely - navigational queries. If this field is set to ``true``, we - skip generating summaries for non-summary seeking queries - and return fallback messages instead. + Specifies whether to filter out queries that are + not summary-seeking. The default value is + ``false``. + + Google employs search-query classification to + detect summary-seeking queries. No summary is + returned if the search query is classified as a + non-summary seeking query. For example, ``why is + the sky blue`` and ``Who is the best soccer + player in the world?`` are summary-seeking + queries, but ``SFO airport`` and ``world cup + 2026`` are not. They are most likely + navigational queries. If this field is set to + ``true``, we skip generating summaries for + non-summary seeking queries and return fallback + messages instead. ignore_low_relevant_content (bool): - Specifies whether to filter out queries that have low - relevance. The default value is ``false``. - - If this field is set to ``false``, all search results are - used regardless of relevance to generate answers. If set to - ``true``, only queries with high relevance search results - will generate answers. + Specifies whether to filter out queries that + have low relevance. The default value is + ``false``. + + If this field is set to ``false``, all search + results are used regardless of relevance to + generate answers. If set to ``true``, only + queries with high relevance search results will + generate answers. ignore_jail_breaking_query (bool): - Optional. Specifies whether to filter out jail-breaking - queries. The default value is ``false``. - - Google employs search-query classification to detect - jail-breaking queries. No summary is returned if the search - query is classified as a jail-breaking query. A user might - add instructions to the query to change the tone, style, - language, content of the answer, or ask the model to act as - a different entity, e.g. "Reply in the tone of a competing - company's CEO". If this field is set to ``true``, we skip - generating summaries for jail-breaking queries and return - fallback messages instead. + Optional. Specifies whether to filter out + jail-breaking queries. The default value is + ``false``. + + Google employs search-query classification to + detect jail-breaking queries. No summary is + returned if the search query is classified as a + jail-breaking query. A user might add + instructions to the query to change the tone, + style, language, content of the answer, or ask + the model to act as a different entity, e.g. + "Reply in the tone of a competing company's + CEO". If this field is set to ``true``, we skip + generating summaries for jail-breaking queries + and return fallback messages instead. model_prompt_spec (google.cloud.discoveryengine_v1beta.types.SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec): If specified, the spec will be used to modify the prompt provided to the LLM. language_code (str): - Language code for Summary. Use language tags defined by - `BCP47 `__. + Language code for Summary. Use language tags + defined by `BCP47 + `__. Note: This is an experimental feature. model_spec (google.cloud.discoveryengine_v1beta.types.SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec): If specified, the spec will be used to modify @@ -1195,15 +1252,19 @@ class ModelSpec(proto.Message): Supported values are: - - ``stable``: string. Default value when no value is - specified. Uses a generally available, fine-tuned model. - For more information, see `Answer generation model - versions and - lifecycle `__. - - ``preview``: string. (Public preview) Uses a preview - model. For more information, see `Answer generation model - versions and - lifecycle `__. + * ``stable``: string. Default value when no + value is specified. Uses a generally + available, fine-tuned model. For more + information, see `Answer generation model + versions and + lifecycle + `__. + + * ``preview``: string. (Public preview) Uses a + preview model. For more information, see + `Answer generation model versions and + lifecycle + `__. """ version: str = proto.Field( @@ -1262,53 +1323,63 @@ class ExtractiveContentSpec(proto.Message): Attributes: max_extractive_answer_count (int): - The maximum number of extractive answers returned in each - search result. + The maximum number of extractive answers + returned in each search result. - An extractive answer is a verbatim answer extracted from the - original document, which provides a precise and contextually - relevant answer to the search query. + An extractive answer is a verbatim answer + extracted from the original document, which + provides a precise and contextually relevant + answer to the search query. - If the number of matching answers is less than the - ``max_extractive_answer_count``, return all of the answers. - Otherwise, return the ``max_extractive_answer_count``. + If the number of matching answers is less than + the ``max_extractive_answer_count``, return all + of the answers. Otherwise, return the + ``max_extractive_answer_count``. At most five answers are returned for each - [SearchResult][google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult]. + `SearchResult + `__. max_extractive_segment_count (int): - The max number of extractive segments returned in each - search result. Only applied if the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] + The max number of extractive segments returned + in each search result. Only applied if the + `DataStore + `__ is set to - [DataStore.ContentConfig.CONTENT_REQUIRED][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.CONTENT_REQUIRED] + `DataStore.ContentConfig.CONTENT_REQUIRED + `__ or - [DataStore.solution_types][google.cloud.discoveryengine.v1beta.DataStore.solution_types] + `DataStore.solution_types + `__ is - [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT]. + `SOLUTION_TYPE_CHAT + `__. - An extractive segment is a text segment extracted from the - original document that is relevant to the search query, and, - in general, more verbose than an extractive answer. The - segment could then be used as input for LLMs to generate - summaries and answers. + An extractive segment is a text segment + extracted from the original document that is + relevant to the search query, and, in general, + more verbose than an extractive answer. The + segment could then be used as input for LLMs to + generate summaries and answers. If the number of matching segments is less than - ``max_extractive_segment_count``, return all of the - segments. Otherwise, return the + ``max_extractive_segment_count``, return all of + the segments. Otherwise, return the ``max_extractive_segment_count``. return_extractive_segment_score (bool): - Specifies whether to return the confidence score from the - extractive segments in each search result. This feature is - available only for new or allowlisted data stores. To - allowlist your data store, contact your Customer Engineer. - The default value is ``false``. + Specifies whether to return the confidence score + from the extractive segments in each search + result. This feature is available only for new + or allowlisted data stores. To allowlist your + data store, contact your Customer Engineer. The + default value is ``false``. num_previous_segments (int): - Specifies whether to also include the adjacent from each - selected segments. Return at most ``num_previous_segments`` + Specifies whether to also include the adjacent + from each selected segments. + Return at most ``num_previous_segments`` segments before each selected segments. num_next_segments (int): - Return at most ``num_next_segments`` segments after each - selected segments. + Return at most ``num_next_segments`` segments + after each selected segments. """ max_extractive_answer_count: int = proto.Field( @@ -1333,11 +1404,13 @@ class ExtractiveContentSpec(proto.Message): ) class ChunkSpec(proto.Message): - r"""Specifies the chunk spec to be returned from the search response. - Only available if the - [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode] + r"""Specifies the chunk spec to be returned from the search + response. Only available if the + `SearchRequest.ContentSearchSpec.search_result_mode + `__ is set to - [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS] + `CHUNKS + `__ Attributes: num_previous_chunks (int): @@ -1432,16 +1505,19 @@ class NaturalLanguageQueryUnderstandingSpec(proto.Message): Attributes: filter_extraction_condition (google.cloud.discoveryengine_v1beta.types.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition): - The condition under which filter extraction should occur. - Default to [Condition.DISABLED][]. + The condition under which filter extraction + should occur. Default to [Condition.DISABLED][]. geo_search_query_detection_field_names (MutableSequence[str]): - Field names used for location-based filtering, where - geolocation filters are detected in natural language search - queries. Only valid when the FilterExtractionCondition is - set to ``ENABLED``. - - If this field is set, it overrides the field names set in - [ServingConfig.geo_search_query_detection_field_names][google.cloud.discoveryengine.v1beta.ServingConfig.geo_search_query_detection_field_names]. + Field names used for location-based filtering, + where geolocation filters are detected in + natural language search queries. Only valid when + the FilterExtractionCondition is set to + ``ENABLED``. + + If this field is set, it overrides the field + names set in + `ServingConfig.geo_search_query_detection_field_names + `__. """ class FilterExtractionCondition(proto.Enum): @@ -1450,7 +1526,8 @@ class FilterExtractionCondition(proto.Enum): Values: CONDITION_UNSPECIFIED (0): - Server behavior defaults to [Condition.DISABLED][]. + Server behavior defaults to + [Condition.DISABLED][]. DISABLED (1): Disables NL filter extraction. ENABLED (2): @@ -1477,9 +1554,10 @@ class SearchAsYouTypeSpec(proto.Message): Attributes: condition (google.cloud.discoveryengine_v1beta.types.SearchRequest.SearchAsYouTypeSpec.Condition): - The condition under which search as you type should occur. - Default to - [Condition.DISABLED][google.cloud.discoveryengine.v1beta.SearchRequest.SearchAsYouTypeSpec.Condition.DISABLED]. + The condition under which search as you type + should occur. Default to + `Condition.DISABLED + `__. """ class Condition(proto.Enum): @@ -1489,7 +1567,8 @@ class Condition(proto.Enum): Values: CONDITION_UNSPECIFIED (0): Server behavior defaults to - [Condition.DISABLED][google.cloud.discoveryengine.v1beta.SearchRequest.SearchAsYouTypeSpec.Condition.DISABLED]. + `Condition.DISABLED + `__. DISABLED (1): Disables Search As You Type. ENABLED (2): @@ -1518,38 +1597,48 @@ class SessionSpec(proto.Message): Attributes: query_id (str): - If set, the search result gets stored to the "turn" - specified by this query ID. + If set, the search result gets stored to the + "turn" specified by this query ID. - Example: Let's say the session looks like this: session { - name: ".../sessions/xxx" turns { query { text: "What is - foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } - turns { query { text: "How about bar then?" query_id: - ".../questions/zzz" } } } + Example: Let's say the session looks like this: - The user can call /search API with a request like this: + session { + name: ".../sessions/xxx" + turns { + query { text: "What is foo?" query_id: + ".../questions/yyy" } answer: "Foo is ..." + } + turns { + query { text: "How about bar then?" + query_id: ".../questions/zzz" } } + } - :: + The user can call /search API with a request + like this: session: ".../sessions/xxx" - session_spec { query_id: ".../questions/zzz" } - - Then, the API stores the search result, associated with the - last turn. The stored search result can be used by a - subsequent /answer API call (with the session ID and the - query ID specified). Also, it is possible to call /search - and /answer in parallel with the same session ID & query ID. + session_spec { query_id: ".../questions/zzz" + } + + Then, the API stores the search result, + associated with the last turn. The stored search + result can be used by a subsequent /answer API + call (with the session ID and the query ID + specified). Also, it is possible to call /search + and /answer in parallel with the same session ID + & query ID. search_result_persistence_count (int): - The number of top search results to persist. The persisted - search results can be used for the subsequent /answer api - call. + The number of top search results to persist. The + persisted search results can be used for the + subsequent /answer api call. - This field is simliar to the ``summary_result_count`` field - in - [SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count]. + This field is simliar to the + ``summary_result_count`` field in + `SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count + `__. - At most 10 results for documents mode, or 50 for chunks - mode. + At most 10 results for documents mode, or 50 for + chunks mode. This field is a member of `oneof`_ ``_search_result_persistence_count``. """ @@ -1569,8 +1658,10 @@ class PersonalizationSpec(proto.Message): Attributes: mode (google.cloud.discoveryengine_v1beta.types.SearchRequest.PersonalizationSpec.Mode): - The personalization mode of the search request. Defaults to - [Mode.AUTO][google.cloud.discoveryengine.v1beta.SearchRequest.PersonalizationSpec.Mode.AUTO]. + The personalization mode of the search request. + Defaults to + `Mode.AUTO + `__. """ class Mode(proto.Enum): @@ -1578,8 +1669,9 @@ class Mode(proto.Enum): Values: MODE_UNSPECIFIED (0): - Default value. In this case, server behavior defaults to - [Mode.AUTO][google.cloud.discoveryengine.v1beta.SearchRequest.PersonalizationSpec.Mode.AUTO]. + Default value. In this case, server behavior + defaults to `Mode.AUTO + `__. AUTO (1): Personalization is enabled if data quality requirements are met. @@ -1752,7 +1844,8 @@ class Mode(proto.Enum): class SearchResponse(proto.Message): r"""Response message for - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] + `SearchService.Search + `__ method. Attributes: @@ -1764,39 +1857,47 @@ class SearchResponse(proto.Message): guided_search_result (google.cloud.discoveryengine_v1beta.types.SearchResponse.GuidedSearchResult): Guided search result. total_size (int): - The estimated total count of matched items irrespective of - pagination. The count of - [results][google.cloud.discoveryengine.v1beta.SearchResponse.results] + The estimated total count of matched items + irrespective of pagination. The count of + `results + `__ returned by pagination may be less than the - [total_size][google.cloud.discoveryengine.v1beta.SearchResponse.total_size] + `total_size + `__ that matches. attribution_token (str): - A unique search token. This should be included in the - [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] - logs resulting from this search, which enables accurate - attribution of search model performance. This also helps to - identify a request during the customer support scenarios. + A unique search token. This should be included + in the `UserEvent + `__ + logs resulting from this search, which enables + accurate attribution of search model + performance. This also helps to identify a + request during the customer support scenarios. redirect_uri (str): - The URI of a customer-defined redirect page. If redirect - action is triggered, no search is performed, and only - [redirect_uri][google.cloud.discoveryengine.v1beta.SearchResponse.redirect_uri] + The URI of a customer-defined redirect page. If + redirect action is triggered, no search is + performed, and only `redirect_uri + `__ and - [attribution_token][google.cloud.discoveryengine.v1beta.SearchResponse.attribution_token] + `attribution_token + `__ are set in the response. next_page_token (str): A token that can be sent as - [SearchRequest.page_token][google.cloud.discoveryengine.v1beta.SearchRequest.page_token] - to retrieve the next page. If this field is omitted, there - are no subsequent pages. + `SearchRequest.page_token + `__ + to retrieve the next page. If this field is + omitted, there are no subsequent pages. corrected_query (str): - Contains the spell corrected query, if found. If the spell - correction type is AUTOMATIC, then the search results are - based on corrected_query. Otherwise the original query is - used for search. + Contains the spell corrected query, if found. If + the spell correction type is AUTOMATIC, then the + search results are based on corrected_query. + Otherwise the original query is used for search. summary (google.cloud.discoveryengine_v1beta.types.SearchResponse.Summary): - A summary as part of the search results. This field is only - returned if - [SearchRequest.ContentSearchSpec.summary_spec][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.summary_spec] + A summary as part of the search results. + This field is only returned if + `SearchRequest.ContentSearchSpec.summary_spec + `__ is set. applied_controls (MutableSequence[str]): Controls applied as part of the Control @@ -1813,8 +1914,10 @@ class SearchResponse(proto.Message): Session information. Only set if - [SearchRequest.session][google.cloud.discoveryengine.v1beta.SearchRequest.session] - is provided. See its description for more details. + `SearchRequest.session + `__ + is provided. See its description for more + details. one_box_results (MutableSequence[google.cloud.discoveryengine_v1beta.types.SearchResponse.OneBoxResult]): A list of One Box results. There can be multiple One Box results of different types. @@ -1825,17 +1928,21 @@ class SearchResult(proto.Message): Attributes: id (str): - [Document.id][google.cloud.discoveryengine.v1beta.Document.id] - of the searched - [Document][google.cloud.discoveryengine.v1beta.Document]. + `Document.id + `__ + of the searched `Document + `__. document (google.cloud.discoveryengine_v1beta.types.Document): - The document data snippet in the search response. Only - fields that are marked as ``retrievable`` are populated. + The document data snippet in the search + response. Only fields that are marked as + ``retrievable`` are populated. chunk (google.cloud.discoveryengine_v1beta.types.Chunk): The chunk data in the search response if the - [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode] + `SearchRequest.ContentSearchSpec.search_result_mode + `__ is set to - [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]. + `CHUNKS + `__. model_scores (MutableMapping[str, google.cloud.discoveryengine_v1beta.types.DoubleList]): Google provided available scores. rank_signals (google.cloud.discoveryengine_v1beta.types.SearchResponse.SearchResult.RankSignals): @@ -1982,9 +2089,10 @@ class Facet(proto.Message): Attributes: key (str): - The key for this facet. For example, ``"colors"`` or - ``"price"``. It matches - [SearchRequest.FacetSpec.FacetKey.key][google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey.key]. + The key for this facet. For example, + ``"colors"`` or ``"price"``. It matches + `SearchRequest.FacetSpec.FacetKey.key + `__. values (MutableSequence[google.cloud.discoveryengine_v1beta.types.SearchResponse.Facet.FacetValue]): The facet values for this field. dynamic_facet (bool): @@ -2008,9 +2116,10 @@ class FacetValue(proto.Message): This field is a member of `oneof`_ ``facet_value``. interval (google.cloud.discoveryengine_v1beta.types.Interval): - Interval value for a facet, such as [10, 20) for facet - "price". It matches - [SearchRequest.FacetSpec.FacetKey.intervals][google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey.intervals]. + Interval value for a facet, such as `10, 20) for + facet "price". It matches + [SearchRequest.FacetSpec.FacetKey.intervals + `__. This field is a member of `oneof`_ ``facet_value``. count (int): @@ -2066,11 +2175,11 @@ class RefinementAttribute(proto.Message): Attributes: attribute_key (str): - Attribute key used to refine the results. For example, - ``"movie_type"``. + Attribute key used to refine the results. For + example, ``"movie_type"``. attribute_value (str): - Attribute value used to refine the results. For example, - ``"drama"``. + Attribute value used to refine the results. For + example, ``"drama"``. """ attribute_key: str = proto.Field( @@ -2123,14 +2232,16 @@ class SummarySkippedReason(proto.Enum): The adversarial query ignored case. Only used when - [SummarySpec.ignore_adversarial_query][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.ignore_adversarial_query] + `SummarySpec.ignore_adversarial_query + `__ is set to ``true``. NON_SUMMARY_SEEKING_QUERY_IGNORED (2): The non-summary seeking query ignored case. - Google skips the summary if the query is chit chat. Only - used when - [SummarySpec.ignore_non_summary_seeking_query][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_summary_seeking_query] + Google skips the summary if the query is chit + chat. Only used when + `SummarySpec.ignore_non_summary_seeking_query + `__ is set to ``true``. OUT_OF_DOMAIN_QUERY_IGNORED (3): The out-of-domain query ignored case. @@ -2159,8 +2270,8 @@ class SummarySkippedReason(proto.Enum): JAIL_BREAKING_QUERY_IGNORED (7): The jail-breaking query ignored case. - For example, "Reply in the tone of a competing company's - CEO". Only used when + For example, "Reply in the tone of a competing + company's CEO". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to ``true``. CUSTOMER_POLICY_VIOLATION (8): @@ -2172,8 +2283,8 @@ class SummarySkippedReason(proto.Enum): NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 (9): The non-answer seeking query ignored case. - Google skips the summary if the query doesn't have clear - intent. Only used when + Google skips the summary if the query doesn't + have clear intent. Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] is set to ``true``. """ @@ -2263,9 +2374,9 @@ class CitationSource(proto.Message): Attributes: reference_index (int): Document reference index from - SummaryWithMetadata.references. It is 0-indexed and the - value will be zero if the reference_index is not set - explicitly. + SummaryWithMetadata.references. It is 0-indexed + and the value will be zero if the + reference_index is not set explicitly. """ reference_index: int = proto.Field( @@ -2281,9 +2392,10 @@ class Reference(proto.Message): Title of the document. document (str): Required. - [Document.name][google.cloud.discoveryengine.v1beta.Document.name] - of the document. Full resource name of the referenced - document, in the format + `Document.name + `__ + of the document. Full resource name of the + referenced document, in the format ``projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*``. uri (str): Cloud Storage or HTTP uri for the document. @@ -2414,9 +2526,10 @@ class QueryExpansionInfo(proto.Message): Bool describing whether query expansion has occurred. pinned_result_count (int): - Number of pinned results. This field will only be set when - expansion happens and - [SearchRequest.QueryExpansionSpec.pin_unexpanded_results][google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec.pin_unexpanded_results] + Number of pinned results. This field will only + be set when expansion happens and + `SearchRequest.QueryExpansionSpec.pin_unexpanded_results + `__ is set to true. """ @@ -2522,7 +2635,8 @@ class Comparison(proto.Enum): LESS_THAN (3): Denotes less than ``<`` operator. GREATER_THAN_EQUALS (4): - Denotes greater than or equal to ``>=`` operator. + Denotes greater than or equal to ``>=`` + operator. GREATER_THAN (5): Denotes greater than ``>`` operator. """ @@ -2721,10 +2835,12 @@ class SessionInfo(proto.Message): Attributes: name (str): - Name of the session. If the auto-session mode is used (when - [SearchRequest.session][google.cloud.discoveryengine.v1beta.SearchRequest.session] - ends with "-"), this field holds the newly generated session - name. + Name of the session. + If the auto-session mode is used (when + `SearchRequest.session + `__ + ends with "-"), this field holds the newly + generated session name. query_id (str): Query ID that corresponds to this search API call. One session can have multiple turns, each diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/search_tuning_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/search_tuning_service.py index ca1b175ba108..afe0e18329c2 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/search_tuning_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/search_tuning_service.py @@ -37,16 +37,17 @@ class ListCustomModelsRequest(proto.Message): r"""Request message for - [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1beta.SearchTuningService.ListCustomModels] + `SearchTuningService.ListCustomModels + `__ method. Attributes: data_store (str): - Required. The resource name of the parent Data Store, such - as + Required. The resource name of the parent Data + Store, such as ``projects/*/locations/global/collections/default_collection/dataStores/default_data_store``. - This field is used to identify the data store where to fetch - the models from. + This field is used to identify the data store + where to fetch the models from. """ data_store: str = proto.Field( @@ -57,7 +58,8 @@ class ListCustomModelsRequest(proto.Message): class ListCustomModelsResponse(proto.Message): r"""Response message for - [SearchTuningService.ListCustomModels][google.cloud.discoveryengine.v1beta.SearchTuningService.ListCustomModels] + `SearchTuningService.ListCustomModels + `__ method. Attributes: @@ -76,7 +78,8 @@ class ListCustomModelsResponse(proto.Message): class TrainCustomModelRequest(proto.Message): r"""Request message for - [SearchTuningService.TrainCustomModel][google.cloud.discoveryengine.v1beta.SearchTuningService.TrainCustomModel] + `SearchTuningService.TrainCustomModel + `__ method. @@ -88,15 +91,16 @@ class TrainCustomModelRequest(proto.Message): This field is a member of `oneof`_ ``training_input``. data_store (str): - Required. The resource name of the Data Store, such as + Required. The resource name of the Data Store, + such as ``projects/*/locations/global/collections/default_collection/dataStores/default_data_store``. - This field is used to identify the data store where to train - the models. + This field is used to identify the data store + where to train the models. model_type (str): Model to be trained. Supported values are: - - **search-tuning**: Fine tuning the search system based on - data provided. + * **search-tuning**: Fine tuning the search + system based on data provided. error_config (google.cloud.discoveryengine_v1beta.types.ImportErrorConfig): The desired location of errors incurred during the data ingestion and training. @@ -109,39 +113,45 @@ class GcsTrainingInput(proto.Message): Attributes: corpus_data_path (str): - The Cloud Storage corpus data which could be associated in - train data. The data path format is - ``gs:///``. A newline - delimited jsonl/ndjson file. + The Cloud Storage corpus data which could be + associated in train data. The data path format + is ``gs:///``. + A newline delimited jsonl/ndjson file. + + For search-tuning model, each line should have + the _id, title and text. Example: - For search-tuning model, each line should have the \_id, - title and text. Example: - ``{"_id": "doc1", title: "relevant doc", "text": "relevant text"}`` + ``{"_id": "doc1", title: "relevant doc", "text": + "relevant text"}`` query_data_path (str): - The gcs query data which could be associated in train data. - The data path format is - ``gs:///``. A newline - delimited jsonl/ndjson file. + The gcs query data which could be associated in + train data. The data path format is + ``gs:///``. A + newline delimited jsonl/ndjson file. - For search-tuning model, each line should have the \_id and - text. Example: {"\_id": "query1", "text": "example query"} + For search-tuning model, each line should have + the _id and text. Example: {"_id": "query1", + "text": "example query"} train_data_path (str): - Cloud Storage training data path whose format should be - ``gs:///``. The file should - be in tsv format. Each line should have the doc_id and - query_id and score (number). - - For search-tuning model, it should have the query-id - corpus-id score as tsv file header. The score should be a - number in ``[0, inf+)``. The larger the number is, the more - relevant the pair is. Example: - - - ``query-id\tcorpus-id\tscore`` - - ``query1\tdoc1\t1`` + Cloud Storage training data path whose format + should be + ``gs:///``. The + file should be in tsv format. Each line should + have the doc_id and query_id and score (number). + + For search-tuning model, it should have the + query-id corpus-id score as tsv file header. The + score should be a number in ``[0, inf+)``. The + larger the number is, the more relevant the pair + is. Example: + + * ``query-id\tcorpus-id\tscore`` + * ``query1\tdoc1\t1`` test_data_path (str): - Cloud Storage test data. Same format as train_data_path. If - not provided, a random 80/20 train/test split will be - performed on train_data_path. + Cloud Storage test data. Same format as + train_data_path. If not provided, a random 80/20 + train/test split will be performed on + train_data_path. """ corpus_data_path: str = proto.Field( @@ -188,7 +198,8 @@ class GcsTrainingInput(proto.Message): class TrainCustomModelResponse(proto.Message): r"""Response of the - [TrainCustomModelRequest][google.cloud.discoveryengine.v1beta.TrainCustomModelRequest]. + `TrainCustomModelRequest + `__. This message is returned by the google.longrunning.Operations.response field. @@ -202,15 +213,20 @@ class TrainCustomModelResponse(proto.Message): model_status (str): The trained model status. Possible values are: - - **bad-data**: The training data quality is bad. - - **no-improvement**: Tuning didn't improve performance. - Won't deploy. - - **in-progress**: Model training job creation is in - progress. - - **training**: Model is actively training. - - **evaluating**: The model is evaluating trained metrics. - - **indexing**: The model trained metrics are indexing. - - **ready**: The model is ready for serving. + * **bad-data**: The training data quality is + bad. + + * **no-improvement**: Tuning didn't improve + performance. Won't deploy. * **in-progress**: + Model training job creation is in progress. + + * **training**: Model is actively training. + * **evaluating**: The model is evaluating + trained metrics. + + * **indexing**: The model trained metrics are + indexing. * **ready**: The model is ready for + serving. metrics (MutableMapping[str, float]): The metrics of the trained model. model_name (str): diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/serving_config.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/serving_config.py index c518f8a9b3f9..9a39033006e7 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/serving_config.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/serving_config.py @@ -57,89 +57,106 @@ class ServingConfig(proto.Message): Immutable. Fully qualified name ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`` display_name (str): - Required. The human readable serving config display name. - Used in Discovery UI. + Required. The human readable serving config + display name. Used in Discovery UI. - This field must be a UTF-8 encoded string with a length - limit of 128 characters. Otherwise, an INVALID_ARGUMENT - error is returned. + This field must be a UTF-8 encoded string with a + length limit of 128 characters. Otherwise, an + INVALID_ARGUMENT error is returned. solution_type (google.cloud.discoveryengine_v1beta.types.SolutionType): Required. Immutable. Specifies the solution type that a serving config can be associated with. model_id (str): - The id of the model to use at serving time. Currently only - RecommendationModels are supported. Can be changed but only - to a compatible model (e.g. others-you-may-like CTR to - others-you-may-like CVR). + The id of the model to use at serving time. + Currently only RecommendationModels are + supported. Can be changed but only to a + compatible model (e.g. others-you-may-like CTR + to others-you-may-like CVR). Required when - [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + `SolutionType + `__ + is `SOLUTION_TYPE_RECOMMENDATION + `__. diversity_level (str): - How much diversity to use in recommendation model results - e.g. ``medium-diversity`` or ``high-diversity``. Currently - supported values: + How much diversity to use in recommendation + model results e.g. ``medium-diversity`` or + ``high-diversity``. Currently supported values: - - ``no-diversity`` - - ``low-diversity`` - - ``medium-diversity`` - - ``high-diversity`` - - ``auto-diversity`` + * ``no-diversity`` + * ``low-diversity`` - If not specified, we choose default based on recommendation - model type. Default value: ``no-diversity``. + * ``medium-diversity`` + * ``high-diversity`` + + * ``auto-diversity`` + + If not specified, we choose default based on + recommendation model type. Default value: + ``no-diversity``. Can only be set if - [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + `SolutionType + `__ + is `SOLUTION_TYPE_RECOMMENDATION + `__. embedding_config (google.cloud.discoveryengine_v1beta.types.EmbeddingConfig): - Bring your own embedding config. The config is used for - search semantic retrieval. The retrieval is based on the dot - product of - [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector] - and the document embeddings that are provided by this - EmbeddingConfig. If - [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector] + Bring your own embedding config. The config is + used for search semantic retrieval. The + retrieval is based on the dot product of + `SearchRequest.EmbeddingSpec.EmbeddingVector.vector + `__ + and the document embeddings that are provided by + this EmbeddingConfig. If + `SearchRequest.EmbeddingSpec.EmbeddingVector.vector + `__ is provided, it overrides this - [ServingConfig.embedding_config][google.cloud.discoveryengine.v1beta.ServingConfig.embedding_config]. + `ServingConfig.embedding_config + `__. ranking_expression (str): - The ranking expression controls the customized ranking on - retrieval documents. To leverage this, document embedding is - required. The ranking expression setting in ServingConfig - applies to all search requests served by the serving config. - However, if - [SearchRequest.ranking_expression][google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression] - is specified, it overrides the ServingConfig ranking - expression. - - The ranking expression is a single function or multiple - functions that are joined by "+". - - - ranking_expression = function, { " + ", function }; + The ranking expression controls the customized + ranking on retrieval documents. To leverage + this, document embedding is required. The + ranking expression setting in ServingConfig + applies to all search requests served by the + serving config. However, if + `SearchRequest.ranking_expression + `__ + is specified, it overrides the ServingConfig + ranking expression. + + The ranking expression is a single function or + multiple functions that are joined by "+". + + * ranking_expression = function, { " + ", + function }; Supported functions: - - double \* relevance_score - - double \* dotProduct(embedding_field_path) + * double * relevance_score + * double * dotProduct(embedding_field_path) Function variables: - - ``relevance_score``: pre-defined keywords, used for - measure relevance between query and document. - - ``embedding_field_path``: the document embedding field - used with query embedding vector. - - ``dotProduct``: embedding function between - embedding_field_path and query embedding vector. + * ``relevance_score``: pre-defined keywords, + used for measure relevance between query and + document. + + * ``embedding_field_path``: the document + embedding field used with query embedding + vector. - Example ranking expression: + * ``dotProduct``: embedding function between + embedding_field_path and query embedding + vector. - :: + Example ranking expression: - If document has an embedding field doc_embedding, the ranking expression - could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. + If document has an embedding field + doc_embedding, the ranking expression could + be ``0.5 * relevance_score + 0.3 * + dotProduct(doc_embedding)``. create_time (google.protobuf.timestamp_pb2.Timestamp): Output only. ServingConfig created timestamp. update_time (google.protobuf.timestamp_pb2.Timestamp): @@ -157,52 +174,64 @@ class ServingConfig(proto.Message): the serving config. Maximum of 20 boost controls. redirect_control_ids (MutableSequence[str]): - IDs of the redirect controls. Only the first triggered - redirect action is applied, even if multiple apply. Maximum - number of specifications is 100. + IDs of the redirect controls. Only the first + triggered redirect action is applied, even if + multiple apply. Maximum number of specifications + is 100. Can only be set if - [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] - is - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH]. + `SolutionType + `__ + is `SOLUTION_TYPE_SEARCH + `__. synonyms_control_ids (MutableSequence[str]): - Condition synonyms specifications. If multiple synonyms - conditions match, all matching synonyms controls in the list - will execute. Maximum number of specifications is 100. + Condition synonyms specifications. If multiple + synonyms conditions match, all matching synonyms + controls in the list will execute. Maximum + number of specifications is 100. Can only be set if - [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] - is - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH]. + `SolutionType + `__ + is `SOLUTION_TYPE_SEARCH + `__. oneway_synonyms_control_ids (MutableSequence[str]): - Condition oneway synonyms specifications. If multiple oneway - synonyms conditions match, all matching oneway synonyms - controls in the list will execute. Maximum number of - specifications is 100. + Condition oneway synonyms specifications. If + multiple oneway synonyms conditions match, all + matching oneway synonyms controls in the list + will execute. Maximum number of specifications + is 100. Can only be set if - [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] - is - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH]. + `SolutionType + `__ + is `SOLUTION_TYPE_SEARCH + `__. dissociate_control_ids (MutableSequence[str]): - Condition do not associate specifications. If multiple do - not associate conditions match, all matching do not - associate controls in the list will execute. Order does not - matter. Maximum number of specifications is 100. + Condition do not associate specifications. If + multiple do not associate conditions match, all + matching do not associate controls in the list + will execute. + Order does not matter. + Maximum number of specifications is 100. Can only be set if - [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] - is - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH]. + `SolutionType + `__ + is `SOLUTION_TYPE_SEARCH + `__. replacement_control_ids (MutableSequence[str]): - Condition replacement specifications. Applied according to - the order in the list. A previously replaced term can not be - re-replaced. Maximum number of specifications is 100. + Condition replacement specifications. + Applied according to the order in the list. + A previously replaced term can not be + re-replaced. Maximum number of specifications is + 100. Can only be set if - [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] - is - [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH]. + `SolutionType + `__ + is `SOLUTION_TYPE_SEARCH + `__. ignore_control_ids (MutableSequence[str]): Condition ignore specifications. If multiple ignore conditions match, all matching ignore @@ -213,33 +242,39 @@ class ServingConfig(proto.Message): The specification for personalization spec. Notice that if both - [ServingConfig.personalization_spec][google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec] + `ServingConfig.personalization_spec + `__ and - [SearchRequest.personalization_spec][google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec] + `SearchRequest.personalization_spec + `__ are set, - [SearchRequest.personalization_spec][google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec] + `SearchRequest.personalization_spec + `__ overrides - [ServingConfig.personalization_spec][google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec]. + `ServingConfig.personalization_spec + `__. """ class MediaConfig(proto.Message): - r"""Specifies the configurations needed for Media Discovery. Currently - we support: - - - ``demote_content_watched``: Threshold for watched content - demotion. Customers can specify if using watched content demotion - or use viewed detail page. Using the content watched demotion, - customers need to specify the watched minutes or percentage - exceeds the threshold, the content will be demoted in the - recommendation result. - - ``promote_fresh_content``: cutoff days for fresh content - promotion. Customers can specify if using content freshness - promotion. If the content was published within the cutoff days, - the content will be promoted in the recommendation result. Can - only be set if - [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] - is - [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]. + r"""Specifies the configurations needed for Media Discovery. + Currently we support: + + * ``demote_content_watched``: Threshold for watched content + demotion. Customers can specify if using watched content + demotion or use viewed detail page. Using the content watched + demotion, customers need to specify the watched minutes or + percentage exceeds the threshold, the content will be demoted in + the recommendation result. + + * ``promote_fresh_content``: cutoff days for fresh content + promotion. Customers can specify if using content freshness + promotion. If the content was published within the cutoff days, + the content will be promoted in the recommendation result. + Can only be set if + `SolutionType + `__ is + `SOLUTION_TYPE_RECOMMENDATION + `__. This message has `oneof`_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. @@ -250,9 +285,9 @@ class MediaConfig(proto.Message): Attributes: content_watched_percentage_threshold (float): - Specifies the content watched percentage threshold for - demotion. Threshold value must be between [0, 1.0] - inclusive. + Specifies the content watched percentage + threshold for demotion. Threshold value must be + between [0, 1.0] inclusive. This field is a member of `oneof`_ ``demote_content_watched``. content_watched_seconds_threshold (float): @@ -261,17 +296,20 @@ class MediaConfig(proto.Message): This field is a member of `oneof`_ ``demote_content_watched``. demotion_event_type (str): - Specifies the event type used for demoting recommendation - result. Currently supported values: + Specifies the event type used for demoting + recommendation result. Currently supported + values: + + * ``view-item``: Item viewed. + * ``media-play``: Start/resume watching a video, + playing a song, etc. - - ``view-item``: Item viewed. - - ``media-play``: Start/resume watching a video, playing a - song, etc. - - ``media-complete``: Finished or stopped midway through a - video, song, etc. + * ``media-complete``: Finished or stopped midway + through a video, song, etc. - If unset, watch history demotion will not be applied. - Content freshness demotion will still be applied. + If unset, watch history demotion will not be + applied. Content freshness demotion will still + be applied. demote_content_watched_past_days (int): Optional. Specifies the number of days to look back for demoting watched content. If set @@ -308,10 +346,11 @@ class MediaConfig(proto.Message): ) class GenericConfig(proto.Message): - r"""Specifies the configurations needed for Generic Discovery.Currently - we support: + r"""Specifies the configurations needed for Generic + Discovery.Currently we support: - - ``content_search_spec``: configuration for generic content search. + * ``content_search_spec``: configuration for generic content + search. Attributes: content_search_spec (google.cloud.discoveryengine_v1beta.types.SearchRequest.ContentSearchSpec): diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/serving_config_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/serving_config_service.py index 2701dec76cc8..8cfe78819db4 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/serving_config_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/serving_config_service.py @@ -43,10 +43,12 @@ class UpdateServingConfigRequest(proto.Message): Required. The ServingConfig to update. update_mask (google.protobuf.field_mask_pb2.FieldMask): Indicates which fields in the provided - [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] + `ServingConfig + `__ to update. The following are NOT supported: - - [ServingConfig.name][google.cloud.discoveryengine.v1beta.ServingConfig.name] + * `ServingConfig.name + `__ If not set, all supported fields are updated. """ @@ -68,8 +70,8 @@ class GetServingConfigRequest(proto.Message): Attributes: name (str): - Required. The resource name of the ServingConfig to get. - Format: + Required. The resource name of the ServingConfig + to get. Format: ``projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`` """ @@ -84,7 +86,8 @@ class ListServingConfigsRequest(proto.Message): Attributes: parent (str): - Required. Full resource name of the parent resource. Format: + Required. Full resource name of the parent + resource. Format: ``projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`` page_size (int): Optional. Maximum number of results to @@ -93,8 +96,8 @@ class ListServingConfigsRequest(proto.Message): results are returned. page_token (str): Optional. A page token, received from a previous - ``ListServingConfigs`` call. Provide this to retrieve the - subsequent page. + ``ListServingConfigs`` call. Provide this to + retrieve the subsequent page. """ parent: str = proto.Field( diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/session.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/session.py index 013ee90b77c4..3aea0d341f23 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/session.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/session.py @@ -88,11 +88,13 @@ class Turn(proto.Message): call) happened in this turn. detailed_answer (google.cloud.discoveryengine_v1beta.types.Answer): Output only. In - [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1beta.ConversationalSearchService.GetSession] + `ConversationalSearchService.GetSession + `__ API, if - [GetSessionRequest.include_answer_details][google.cloud.discoveryengine.v1beta.GetSessionRequest.include_answer_details] - is set to true, this field will be populated when getting - answer query session. + `GetSessionRequest.include_answer_details + `__ + is set to true, this field will be populated + when getting answer query session. query_config (MutableMapping[str, str]): Optional. Represents metadata related to the query config, for example LLM model and version diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/site_search_engine.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/site_search_engine.py index 87bb9aa78b38..75a2cb9a727b 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/site_search_engine.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/site_search_engine.py @@ -38,8 +38,8 @@ class SiteSearchEngine(proto.Message): Attributes: name (str): - The fully qualified resource name of the site search engine. - Format: + The fully qualified resource name of the site + search engine. Format: ``projects/*/locations/*/dataStores/*/siteSearchEngine`` """ @@ -54,30 +54,34 @@ class TargetSite(proto.Message): Attributes: name (str): - Output only. The fully qualified resource name of the target - site. + Output only. The fully qualified resource name + of the target site. ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`` The ``target_site_id`` is system-generated. provided_uri_pattern (str): - Required. Input only. The user provided URI pattern from - which the ``generated_uri_pattern`` is generated. + Required. Input only. The user provided URI + pattern from which the ``generated_uri_pattern`` + is generated. type_ (google.cloud.discoveryengine_v1beta.types.TargetSite.Type): The type of the target site, e.g., whether the site is to be included or excluded. exact_match (bool): - Input only. If set to false, a uri_pattern is generated to - include all pages whose address contains the - provided_uri_pattern. If set to true, an uri_pattern is - generated to try to be an exact match of the - provided_uri_pattern or just the specific page if the - provided_uri_pattern is a specific one. provided_uri_pattern - is always normalized to generate the URI pattern to be used - by the search engine. + Input only. If set to false, a uri_pattern is + generated to include all pages whose address + contains the provided_uri_pattern. If set to + true, an uri_pattern is generated to try to be + an exact match of the provided_uri_pattern or + just the specific page if the + provided_uri_pattern is a specific one. + provided_uri_pattern is always normalized to + generate the URI pattern to be used by the + search engine. generated_uri_pattern (str): - Output only. This is system-generated based on the - provided_uri_pattern. + Output only. This is system-generated based on + the provided_uri_pattern. root_domain_uri (str): - Output only. Root domain of the provided_uri_pattern. + Output only. Root domain of the + provided_uri_pattern. site_verification_info (google.cloud.discoveryengine_v1beta.types.SiteVerificationInfo): Output only. Site ownership and validity verification status. @@ -95,9 +99,9 @@ class Type(proto.Enum): Values: TYPE_UNSPECIFIED (0): - This value is unused. In this case, server behavior defaults - to - [Type.INCLUDE][google.cloud.discoveryengine.v1beta.TargetSite.Type.INCLUDE]. + This value is unused. In this case, server + behavior defaults to `Type.INCLUDE + `__. INCLUDE (1): Include the target site. EXCLUDE (2): @@ -273,8 +277,8 @@ class Sitemap(proto.Message): This field is a member of `oneof`_ ``feed``. name (str): - Output only. The fully qualified resource name of the - sitemap. + Output only. The fully qualified resource name + of the sitemap. ``projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*`` The ``sitemap_id`` suffix is system-generated. create_time (google.protobuf.timestamp_pb2.Timestamp): diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/site_search_engine_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/site_search_engine_service.py index 2db134f26036..1927067662df 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/site_search_engine_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/site_search_engine_service.py @@ -66,19 +66,22 @@ class GetSiteSearchEngineRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.GetSiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.GetSiteSearchEngine] + `SiteSearchEngineService.GetSiteSearchEngine + `__ method. Attributes: name (str): Required. Resource name of - [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. - If the caller does not have permission to access the - [SiteSearchEngine], regardless of whether or not it exists, - a PERMISSION_DENIED error is returned. + If the caller does not have permission to access + the [SiteSearchEngine], regardless of whether or + not it exists, a PERMISSION_DENIED error is + returned. """ name: str = proto.Field( @@ -89,18 +92,20 @@ class GetSiteSearchEngineRequest(proto.Message): class CreateTargetSiteRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.CreateTargetSite] + `SiteSearchEngineService.CreateTargetSite + `__ method. Attributes: parent (str): Required. Parent resource name of - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. target_site (google.cloud.discoveryengine_v1beta.types.TargetSite): - Required. The - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] + Required. The `TargetSite + `__ to create. """ @@ -117,7 +122,8 @@ class CreateTargetSiteRequest(proto.Message): class CreateTargetSiteMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.CreateTargetSite] + `SiteSearchEngineService.CreateTargetSite + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -143,16 +149,18 @@ class CreateTargetSiteMetadata(proto.Message): class BatchCreateTargetSitesRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchCreateTargetSites] + `SiteSearchEngineService.BatchCreateTargetSites + `__ method. Attributes: parent (str): - Required. The parent resource shared by all TargetSites - being created. + Required. The parent resource shared by all + TargetSites being created. ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. - The parent field in the CreateBookRequest messages must - either be empty or match this field. + The parent field in the CreateBookRequest + messages must either be empty or match this + field. requests (MutableSequence[google.cloud.discoveryengine_v1beta.types.CreateTargetSiteRequest]): Required. The request message specifying the resources to create. A maximum of 20 TargetSites @@ -172,23 +180,27 @@ class BatchCreateTargetSitesRequest(proto.Message): class GetTargetSiteRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.GetTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.GetTargetSite] + `SiteSearchEngineService.GetTargetSite + `__ method. Attributes: name (str): Required. Full resource name of - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}``. - If the caller does not have permission to access the - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. + If the caller does not have permission to access + the `TargetSite + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. If the requested - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] + `TargetSite + `__ does not exist, a NOT_FOUND error is returned. """ @@ -200,20 +212,23 @@ class GetTargetSiteRequest(proto.Message): class UpdateTargetSiteRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.UpdateTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.UpdateTargetSite] + `SiteSearchEngineService.UpdateTargetSite + `__ method. Attributes: target_site (google.cloud.discoveryengine_v1beta.types.TargetSite): - Required. The target site to update. If the caller does not - have permission to update the - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. - - If the - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] - to update does not exist, a NOT_FOUND error is returned. + Required. The target site to update. + If the caller does not have permission to update + the `TargetSite + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. + + If the `TargetSite + `__ + to update does not exist, a NOT_FOUND error is + returned. """ target_site: gcd_site_search_engine.TargetSite = proto.Field( @@ -225,7 +240,8 @@ class UpdateTargetSiteRequest(proto.Message): class UpdateTargetSiteMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.UpdateTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.UpdateTargetSite] + `SiteSearchEngineService.UpdateTargetSite + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -251,23 +267,27 @@ class UpdateTargetSiteMetadata(proto.Message): class DeleteTargetSiteRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DeleteTargetSite] + `SiteSearchEngineService.DeleteTargetSite + `__ method. Attributes: name (str): Required. Full resource name of - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], + `TargetSite + `__, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}``. - If the caller does not have permission to access the - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. + If the caller does not have permission to access + the `TargetSite + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. If the requested - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] + `TargetSite + `__ does not exist, a NOT_FOUND error is returned. """ @@ -279,7 +299,8 @@ class DeleteTargetSiteRequest(proto.Message): class DeleteTargetSiteMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DeleteTargetSite] + `SiteSearchEngineService.DeleteTargetSite + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -305,34 +326,39 @@ class DeleteTargetSiteMetadata(proto.Message): class ListTargetSitesRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.ListTargetSites] + `SiteSearchEngineService.ListTargetSites + `__ method. Attributes: parent (str): - Required. The parent site search engine resource name, such - as + Required. The parent site search engine resource + name, such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. If the caller does not have permission to list - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s - under this site search engine, regardless of whether or not - this branch exists, a PERMISSION_DENIED error is returned. + `TargetSite + `__s + under this site search engine, regardless of + whether or not this branch exists, a + PERMISSION_DENIED error is returned. page_size (int): - Requested page size. Server may return fewer items than - requested. If unspecified, server will pick an appropriate - default. The maximum value is 1000; values above 1000 will - be coerced to 1000. + Requested page size. Server may return fewer + items than requested. If unspecified, server + will pick an appropriate default. The maximum + value is 1000; values above 1000 will be coerced + to 1000. - If this field is negative, an INVALID_ARGUMENT error is - returned. + If this field is negative, an INVALID_ARGUMENT + error is returned. page_token (str): - A page token, received from a previous ``ListTargetSites`` - call. Provide this to retrieve the subsequent page. + A page token, received from a previous + ``ListTargetSites`` call. Provide this to + retrieve the subsequent page. - When paginating, all other parameters provided to - ``ListTargetSites`` must match the call that provided the - page token. + When paginating, all other parameters provided + to ``ListTargetSites`` must match the call that + provided the page token. """ parent: str = proto.Field( @@ -351,16 +377,17 @@ class ListTargetSitesRequest(proto.Message): class ListTargetSitesResponse(proto.Message): r"""Response message for - [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.ListTargetSites] + `SiteSearchEngineService.ListTargetSites + `__ method. Attributes: target_sites (MutableSequence[google.cloud.discoveryengine_v1beta.types.TargetSite]): List of TargetSites. next_page_token (str): - A token that can be sent as ``page_token`` to retrieve the - next page. If this field is omitted, there are no subsequent - pages. + A token that can be sent as ``page_token`` to + retrieve the next page. If this field is + omitted, there are no subsequent pages. total_size (int): The total number of items matching the request. This will always be populated in the @@ -390,7 +417,8 @@ def raw_page(self): class BatchCreateTargetSiteMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchCreateTargetSites] + `SiteSearchEngineService.BatchCreateTargetSites + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -416,7 +444,8 @@ class BatchCreateTargetSiteMetadata(proto.Message): class BatchCreateTargetSitesResponse(proto.Message): r"""Response message for - [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchCreateTargetSites] + `SiteSearchEngineService.BatchCreateTargetSites + `__ method. Attributes: @@ -435,19 +464,21 @@ class BatchCreateTargetSitesResponse(proto.Message): class CreateSitemapRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.CreateSitemap][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.CreateSitemap] + `SiteSearchEngineService.CreateSitemap + `__ method. Attributes: parent (str): Required. Parent resource name of the - [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine``. sitemap (google.cloud.discoveryengine_v1beta.types.Sitemap): - Required. The - [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap] to - create. + Required. The `Sitemap + `__ + to create. """ parent: str = proto.Field( @@ -463,24 +494,27 @@ class CreateSitemapRequest(proto.Message): class DeleteSitemapRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.DeleteSitemap][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DeleteSitemap] + `SiteSearchEngineService.DeleteSitemap + `__ method. Attributes: name (str): Required. Full resource name of - [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap], such - as + `Sitemap + `__, + such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}``. - If the caller does not have permission to access the - [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap], - regardless of whether or not it exists, a PERMISSION_DENIED - error is returned. + If the caller does not have permission to access + the `Sitemap + `__, + regardless of whether or not it exists, a + PERMISSION_DENIED error is returned. - If the requested - [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap] does - not exist, a NOT_FOUND error is returned. + If the requested `Sitemap + `__ + does not exist, a NOT_FOUND error is returned. """ name: str = proto.Field( @@ -491,32 +525,35 @@ class DeleteSitemapRequest(proto.Message): class FetchSitemapsRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.FetchSitemaps][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.FetchSitemaps] + `SiteSearchEngineService.FetchSitemaps + `__ method. Attributes: parent (str): Required. Parent resource name of the - [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine``. matcher (google.cloud.discoveryengine_v1beta.types.FetchSitemapsRequest.Matcher): Optional. If specified, fetches the matching - [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap]s. If - not specified, fetches all - [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap]s in - the - [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. + `Sitemap + `__s. + If not specified, fetches all `Sitemap + `__s + in the `DataStore + `__. """ class UrisMatcher(proto.Message): - r"""Matcher for the - [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap]s by their - uris. + r"""Matcher for the `Sitemap + `__s by their uris. Attributes: uris (MutableSequence[str]): - The [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap] + The `Sitemap + `__ uris. """ @@ -526,8 +563,8 @@ class UrisMatcher(proto.Message): ) class Matcher(proto.Message): - r"""Matcher for the - [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap]s. Currently + r"""Matcher for the `Sitemap + `__s. Currently only supports uris matcher. @@ -560,7 +597,8 @@ class Matcher(proto.Message): class CreateSitemapMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.CreateSitemap][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.CreateSitemap] + `SiteSearchEngineService.CreateSitemap + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -586,7 +624,8 @@ class CreateSitemapMetadata(proto.Message): class DeleteSitemapMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.DeleteSitemap][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DeleteSitemap] + `SiteSearchEngineService.DeleteSitemap + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -612,23 +651,26 @@ class DeleteSitemapMetadata(proto.Message): class FetchSitemapsResponse(proto.Message): r"""Response message for - [SiteSearchEngineService.FetchSitemaps][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.FetchSitemaps] + `SiteSearchEngineService.FetchSitemaps + `__ method. Attributes: sitemaps_metadata (MutableSequence[google.cloud.discoveryengine_v1beta.types.FetchSitemapsResponse.SitemapMetadata]): - List of - [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap]s + List of `Sitemap + `__s fetched. """ class SitemapMetadata(proto.Message): - r"""Contains a [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap] - and its metadata. + r"""Contains a `Sitemap + `__ and its + metadata. Attributes: sitemap (google.cloud.discoveryengine_v1beta.types.Sitemap): - The [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap]. + The `Sitemap + `__. """ sitemap: gcd_site_search_engine.Sitemap = proto.Field( @@ -646,13 +688,15 @@ class SitemapMetadata(proto.Message): class EnableAdvancedSiteSearchRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.EnableAdvancedSiteSearch] + `SiteSearchEngineService.EnableAdvancedSiteSearch + `__ method. Attributes: site_search_engine (str): Required. Full resource name of the - [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine``. """ @@ -665,7 +709,8 @@ class EnableAdvancedSiteSearchRequest(proto.Message): class EnableAdvancedSiteSearchResponse(proto.Message): r"""Response message for - [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.EnableAdvancedSiteSearch] + `SiteSearchEngineService.EnableAdvancedSiteSearch + `__ method. """ @@ -673,7 +718,8 @@ class EnableAdvancedSiteSearchResponse(proto.Message): class EnableAdvancedSiteSearchMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.EnableAdvancedSiteSearch] + `SiteSearchEngineService.EnableAdvancedSiteSearch + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -699,13 +745,15 @@ class EnableAdvancedSiteSearchMetadata(proto.Message): class DisableAdvancedSiteSearchRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DisableAdvancedSiteSearch] + `SiteSearchEngineService.DisableAdvancedSiteSearch + `__ method. Attributes: site_search_engine (str): Required. Full resource name of the - [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine``. """ @@ -718,7 +766,8 @@ class DisableAdvancedSiteSearchRequest(proto.Message): class DisableAdvancedSiteSearchResponse(proto.Message): r"""Response message for - [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DisableAdvancedSiteSearch] + `SiteSearchEngineService.DisableAdvancedSiteSearch + `__ method. """ @@ -726,7 +775,8 @@ class DisableAdvancedSiteSearchResponse(proto.Message): class DisableAdvancedSiteSearchMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.DisableAdvancedSiteSearch] + `SiteSearchEngineService.DisableAdvancedSiteSearch + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -752,24 +802,27 @@ class DisableAdvancedSiteSearchMetadata(proto.Message): class RecrawlUrisRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.RecrawlUris] + `SiteSearchEngineService.RecrawlUris + `__ method. Attributes: site_search_engine (str): Required. Full resource name of the - [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine], + `SiteSearchEngine + `__, such as ``projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine``. uris (MutableSequence[str]): - Required. List of URIs to crawl. At most 10K URIs are - supported, otherwise an INVALID_ARGUMENT error is thrown. - Each URI should match at least one - [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] + Required. List of URIs to crawl. At most 10K + URIs are supported, otherwise an + INVALID_ARGUMENT error is thrown. Each URI + should match at least one `TargetSite + `__ in ``site_search_engine``. site_credential (str): - Optional. Full resource name of the [SiteCredential][], such - as + Optional. Full resource name of the + [SiteCredential][], such as ``projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*``. Only set to crawl private URIs. """ @@ -790,12 +843,14 @@ class RecrawlUrisRequest(proto.Message): class RecrawlUrisResponse(proto.Message): r"""Response message for - [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.RecrawlUris] + `SiteSearchEngineService.RecrawlUris + `__ method. Attributes: failure_samples (MutableSequence[google.cloud.discoveryengine_v1beta.types.RecrawlUrisResponse.FailureInfo]): - Details for a sample of up to 10 ``failed_uris``. + Details for a sample of up to 10 + ``failed_uris``. failed_uris (MutableSequence[str]): URIs that were not crawled before the LRO terminated. @@ -879,7 +934,8 @@ class CorpusType(proto.Enum): class RecrawlUrisMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.RecrawlUris][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.RecrawlUris] + `SiteSearchEngineService.RecrawlUris + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -905,8 +961,8 @@ class RecrawlUrisMetadata(proto.Message): Total number of URIs that don't match any TargetSites. valid_uris_count (int): - Total number of unique URIs in the request that are not in - invalid_uris. + Total number of unique URIs in the request that + are not in invalid_uris. success_count (int): Total number of URIs that have been crawled so far. @@ -964,13 +1020,14 @@ class RecrawlUrisMetadata(proto.Message): class BatchVerifyTargetSitesRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchVerifyTargetSites] + `SiteSearchEngineService.BatchVerifyTargetSites + `__ method. Attributes: parent (str): - Required. The parent resource shared by all TargetSites - being verified. + Required. The parent resource shared by all + TargetSites being verified. ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. """ @@ -982,7 +1039,8 @@ class BatchVerifyTargetSitesRequest(proto.Message): class BatchVerifyTargetSitesResponse(proto.Message): r"""Response message for - [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchVerifyTargetSites] + `SiteSearchEngineService.BatchVerifyTargetSites + `__ method. """ @@ -990,7 +1048,8 @@ class BatchVerifyTargetSitesResponse(proto.Message): class BatchVerifyTargetSitesMetadata(proto.Message): r"""Metadata related to the progress of the - [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.BatchVerifyTargetSites] + `SiteSearchEngineService.BatchVerifyTargetSites + `__ operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -1016,30 +1075,33 @@ class BatchVerifyTargetSitesMetadata(proto.Message): class FetchDomainVerificationStatusRequest(proto.Message): r"""Request message for - [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.FetchDomainVerificationStatus] + `SiteSearchEngineService.FetchDomainVerificationStatus + `__ method. Attributes: site_search_engine (str): - Required. The site search engine resource under which we - fetch all the domain verification status. + Required. The site search engine resource under + which we fetch all the domain verification + status. ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine``. page_size (int): - Requested page size. Server may return fewer items than - requested. If unspecified, server will pick an appropriate - default. The maximum value is 1000; values above 1000 will - be coerced to 1000. + Requested page size. Server may return fewer + items than requested. If unspecified, server + will pick an appropriate default. The maximum + value is 1000; values above 1000 will be coerced + to 1000. - If this field is negative, an INVALID_ARGUMENT error is - returned. + If this field is negative, an INVALID_ARGUMENT + error is returned. page_token (str): A page token, received from a previous - ``FetchDomainVerificationStatus`` call. Provide this to - retrieve the subsequent page. + ``FetchDomainVerificationStatus`` call. Provide + this to retrieve the subsequent page. - When paginating, all other parameters provided to - ``FetchDomainVerificationStatus`` must match the call that - provided the page token. + When paginating, all other parameters provided + to ``FetchDomainVerificationStatus`` must match + the call that provided the page token. """ site_search_engine: str = proto.Field( @@ -1058,7 +1120,8 @@ class FetchDomainVerificationStatusRequest(proto.Message): class FetchDomainVerificationStatusResponse(proto.Message): r"""Response message for - [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1beta.SiteSearchEngineService.FetchDomainVerificationStatus] + `SiteSearchEngineService.FetchDomainVerificationStatus + `__ method. Attributes: @@ -1066,9 +1129,9 @@ class FetchDomainVerificationStatusResponse(proto.Message): List of TargetSites containing the site verification status. next_page_token (str): - A token that can be sent as ``page_token`` to retrieve the - next page. If this field is omitted, there are no subsequent - pages. + A token that can be sent as ``page_token`` to + retrieve the next page. If this field is + omitted, there are no subsequent pages. total_size (int): The total number of items matching the request. This will always be populated in the diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/user_event.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/user_event.py index 5c7918c4a605..90c354565a9b 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/user_event.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/user_event.py @@ -49,190 +49,226 @@ class UserEvent(proto.Message): Generic values: - - ``search``: Search for Documents. - - ``view-item``: Detailed page view of a Document. - - ``view-item-list``: View of a panel or ordered list of - Documents. - - ``view-home-page``: View of the home page. - - ``view-category-page``: View of a category page, e.g. Home - > Men > Jeans - - ``add-feedback``: Add a user feedback. + * ``search``: Search for Documents. + * ``view-item``: Detailed page view of a + Document. + + * ``view-item-list``: View of a panel or ordered + list of Documents. * ``view-home-page``: View of + the home page. + + * ``view-category-page``: View of a category + page, e.g. Home > Men > Jeans * + ``add-feedback``: Add a user feedback. Retail-related values: - - ``add-to-cart``: Add an item(s) to cart, e.g. in Retail - online shopping - - ``purchase``: Purchase an item(s) + * ``add-to-cart``: Add an item(s) to cart, e.g. + in Retail online shopping * ``purchase``: + Purchase an item(s) Media-related values: - - ``media-play``: Start/resume watching a video, playing a - song, etc. - - ``media-complete``: Finished or stopped midway through a - video, song, etc. + * ``media-play``: Start/resume watching a video, + playing a song, etc. * ``media-complete``: + Finished or stopped midway through a video, + song, etc. user_pseudo_id (str): - Required. A unique identifier for tracking visitors. - - For example, this could be implemented with an HTTP cookie, - which should be able to uniquely identify a visitor on a - single device. This unique identifier should not change if - the visitor log in/out of the website. - - Do not set the field to the same fixed ID for different - users. This mixes the event history of those users together, - which results in degraded model quality. - - The field must be a UTF-8 encoded string with a length limit - of 128 characters. Otherwise, an ``INVALID_ARGUMENT`` error - is returned. + Required. A unique identifier for tracking + visitors. + For example, this could be implemented with an + HTTP cookie, which should be able to uniquely + identify a visitor on a single device. This + unique identifier should not change if the + visitor log in/out of the website. + + Do not set the field to the same fixed ID for + different users. This mixes the event history of + those users together, which results in degraded + model quality. + + The field must be a UTF-8 encoded string with a + length limit of 128 characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. - The field should not contain PII or user-data. We recommend - to use Google Analytics `Client - ID `__ + The field should not contain PII or user-data. + We recommend to use Google Analytics `Client + ID + `__ for this field. engine (str): - The [Engine][google.cloud.discoveryengine.v1beta.Engine] + The `Engine + `__ resource name, in the form of ``projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}``. Optional. Only required for - [Engine][google.cloud.discoveryengine.v1beta.Engine] - produced user events. For example, user events from blended - search. + `Engine + `__ + produced user events. For example, user events + from blended search. data_store (str): - The - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] + The `DataStore + `__ resource full name, of the form ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}``. - Optional. Only required for user events whose data store - can't by determined by - [UserEvent.engine][google.cloud.discoveryengine.v1beta.UserEvent.engine] - or - [UserEvent.documents][google.cloud.discoveryengine.v1beta.UserEvent.documents]. - If data store is set in the parent of write/import/collect - user event requests, this field can be omitted. + Optional. Only required for user events whose + data store can't by determined by + `UserEvent.engine + `__ + or `UserEvent.documents + `__. + If data store is set in the parent of + write/import/collect user event requests, this + field can be omitted. event_time (google.protobuf.timestamp_pb2.Timestamp): Only required for - [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1beta.UserEventService.ImportUserEvents] - method. Timestamp of when the user event happened. + `UserEventService.ImportUserEvents + `__ + method. Timestamp of when the user event + happened. user_info (google.cloud.discoveryengine_v1beta.types.UserInfo): Information about the end user. direct_user_request (bool): - Should set to true if the request is made directly from the - end user, in which case the - [UserEvent.user_info.user_agent][google.cloud.discoveryengine.v1beta.UserInfo.user_agent] + Should set to true if the request is made + directly from the end user, in which case the + `UserEvent.user_info.user_agent + `__ can be populated from the HTTP request. - This flag should be set only if the API request is made - directly from the end user such as a mobile app (and not if - a gateway or a server is processing and pushing the user - events). + This flag should be set only if the API request + is made directly from the end user such as a + mobile app (and not if a gateway or a server is + processing and pushing the user events). - This should not be set when using the JavaScript tag in - [UserEventService.CollectUserEvent][google.cloud.discoveryengine.v1beta.UserEventService.CollectUserEvent]. + This should not be set when using the JavaScript + tag in `UserEventService.CollectUserEvent + `__. session_id (str): - A unique identifier for tracking a visitor session with a - length limit of 128 bytes. A session is an aggregation of an - end user behavior in a time span. + A unique identifier for tracking a visitor + session with a length limit of 128 bytes. A + session is an aggregation of an end user + behavior in a time span. A general guideline to populate the session_id: - 1. If user has no activity for 30 min, a new session_id - should be assigned. - 2. The session_id should be unique across users, suggest use - uuid or add - [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id] - as prefix. + 1. If user has no activity for 30 min, a new + session_id should be assigned. + 2. The session_id should be unique across users, + suggest use uuid or add + `UserEvent.user_pseudo_id + `__ + as prefix. page_info (google.cloud.discoveryengine_v1beta.types.PageInfo): - Page metadata such as categories and other critical - information for certain event types such as - ``view-category-page``. + Page metadata such as categories and other + critical information for certain event types + such as ``view-category-page``. attribution_token (str): - Token to attribute an API response to user action(s) to - trigger the event. - - Highly recommended for user events that are the result of - [RecommendationService.Recommend][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend]. - This field enables accurate attribution of recommendation - model performance. + Token to attribute an API response to user + action(s) to trigger the event. + Highly recommended for user events that are the + result of `RecommendationService.Recommend + `__. + This field enables accurate attribution of + recommendation model performance. The value must be one of: - - [RecommendResponse.attribution_token][google.cloud.discoveryengine.v1beta.RecommendResponse.attribution_token] - for events that are the result of - [RecommendationService.Recommend][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend]. - - [SearchResponse.attribution_token][google.cloud.discoveryengine.v1beta.SearchResponse.attribution_token] - for events that are the result of - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]. - - This token enables us to accurately attribute page view or - conversion completion back to the event and the particular - predict response containing this clicked/purchased product. - If user clicks on product K in the recommendation results, - pass - [RecommendResponse.attribution_token][google.cloud.discoveryengine.v1beta.RecommendResponse.attribution_token] - as a URL parameter to product K's page. When recording - events on product K's page, log the - [RecommendResponse.attribution_token][google.cloud.discoveryengine.v1beta.RecommendResponse.attribution_token] + * `RecommendResponse.attribution_token + `__ + for events that are the result of + `RecommendationService.Recommend + `__. + + * `SearchResponse.attribution_token + `__ + for events that are the result of + `SearchService.Search + `__. + + This token enables us to accurately attribute + page view or conversion completion back to the + event and the particular predict response + containing this clicked/purchased product. If + user clicks on product K in the recommendation + results, pass + `RecommendResponse.attribution_token + `__ + as a URL parameter to product K's page. When + recording events on product K's page, log the + `RecommendResponse.attribution_token + `__ to this field. filter (str): - The filter syntax consists of an expression language for - constructing a predicate from one or more fields of the - documents being filtered. + The filter syntax consists of an expression + language for constructing a predicate from one + or more fields of the documents being filtered. - One example is for ``search`` events, the associated - [SearchRequest][google.cloud.discoveryengine.v1beta.SearchRequest] + One example is for ``search`` events, the + associated `SearchRequest + `__ may contain a filter expression in - [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter] - conforming to https://google.aip.dev/160#filtering. - - Similarly, for ``view-item-list`` events that are generated - from a - [RecommendRequest][google.cloud.discoveryengine.v1beta.RecommendRequest], + `SearchRequest.filter + `__ + conforming to + https://google.aip.dev/160#filtering. + + Similarly, for ``view-item-list`` events that + are generated from a `RecommendRequest + `__, this field may be populated directly from - [RecommendRequest.filter][google.cloud.discoveryengine.v1beta.RecommendRequest.filter] - conforming to https://google.aip.dev/160#filtering. + `RecommendRequest.filter + `__ + conforming to + https://google.aip.dev/160#filtering. - The value must be a UTF-8 encoded string with a length limit - of 1,000 characters. Otherwise, an ``INVALID_ARGUMENT`` - error is returned. + The value must be a UTF-8 encoded string with a + length limit of 1,000 characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. documents (MutableSequence[google.cloud.discoveryengine_v1beta.types.DocumentInfo]): - List of - [Document][google.cloud.discoveryengine.v1beta.Document]s + List of `Document + `__s associated with this user event. - This field is optional except for the following event types: - - - ``view-item`` - - ``add-to-cart`` - - ``purchase`` - - ``media-play`` - - ``media-complete`` - - In a ``search`` event, this field represents the documents - returned to the end user on the current page (the end user - may have not finished browsing the whole page yet). When a - new page is returned to the end user, after - pagination/filtering/ordering even for the same query, a new - ``search`` event with different - [UserEvent.documents][google.cloud.discoveryengine.v1beta.UserEvent.documents] + This field is optional except for the following + event types: + + * ``view-item`` + * ``add-to-cart`` + + * ``purchase`` + * ``media-play`` + + * ``media-complete`` + + In a ``search`` event, this field represents the + documents returned to the end user on the + current page (the end user may have not finished + browsing the whole page yet). When a new page is + returned to the end user, after + pagination/filtering/ordering even for the same + query, a new ``search`` event with different + `UserEvent.documents + `__ is desired. panel (google.cloud.discoveryengine_v1beta.types.PanelInfo): Panel metadata associated with this user event. search_info (google.cloud.discoveryengine_v1beta.types.SearchInfo): - [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] + `SearchService.Search + `__ details related to the event. This field should be set for ``search`` event. completion_info (google.cloud.discoveryengine_v1beta.types.CompletionInfo): - [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] + `CompletionService.CompleteQuery + `__ details related to the event. - This field should be set for ``search`` event when - autocomplete function is enabled and the user clicks a - suggestion for search. + This field should be set for ``search`` event + when autocomplete function is enabled and the + user clicks a suggestion for search. transaction_info (google.cloud.discoveryengine_v1beta.types.TransactionInfo): The transaction metadata (if any) associated with this user event. @@ -246,34 +282,42 @@ class UserEvent(proto.Message): associated with promotions. Currently, this field is restricted to at most one ID. attributes (MutableMapping[str, google.cloud.discoveryengine_v1beta.types.CustomAttribute]): - Extra user event features to include in the recommendation - model. These attributes must NOT contain data that needs to - be parsed or processed further, e.g. JSON or other - encodings. - - If you provide custom attributes for ingested user events, - also include them in the user events that you associate with - prediction requests. Custom attribute formatting must be - consistent between imported events and events provided with - prediction requests. This lets the Discovery Engine API use - those custom attributes when training models and serving - predictions, which helps improve recommendation quality. - - This field needs to pass all below criteria, otherwise an - ``INVALID_ARGUMENT`` error is returned: - - - The key must be a UTF-8 encoded string with a length limit - of 5,000 characters. - - For text attributes, at most 400 values are allowed. Empty - values are not allowed. Each value must be a UTF-8 encoded - string with a length limit of 256 characters. - - For number attributes, at most 400 values are allowed. - - For product recommendations, an example of extra user - information is ``traffic_channel``, which is how a user - arrives at the site. Users can arrive at the site by coming - to the site directly, coming through Google search, or in - other ways. + Extra user event features to include in the + recommendation model. These attributes must NOT + contain data that needs to be parsed or + processed further, e.g. JSON or other encodings. + + If you provide custom attributes for ingested + user events, also include them in the user + events that you associate with prediction + requests. Custom attribute formatting must be + consistent between imported events and events + provided with prediction requests. This lets the + Discovery Engine API use those custom attributes + when training models and serving predictions, + which helps improve recommendation quality. + + This field needs to pass all below criteria, + otherwise an ``INVALID_ARGUMENT`` error is + returned: + + * The key must be a UTF-8 encoded string with a + length limit of 5,000 characters. + + * For text attributes, at most 400 values are + allowed. Empty values are not allowed. Each + value must be a UTF-8 encoded string with a + length limit of 256 characters. + + * For number attributes, at most 400 values are + allowed. + + For product recommendations, an example of extra + user information is ``traffic_channel``, which + is how a user arrives at the site. Users can + arrive + at the site by coming to the site directly, + coming through Google search, or in other ways. media_info (google.cloud.discoveryengine_v1beta.types.MediaInfo): Media-specific info. panels (MutableSequence[google.cloud.discoveryengine_v1beta.types.PanelInfo]): @@ -386,31 +430,36 @@ class PageInfo(proto.Message): pageview_id (str): A unique ID of a web page view. - This should be kept the same for all user events triggered - from the same pageview. For example, an item detail page - view could trigger multiple events as the user is browsing - the page. The ``pageview_id`` property should be kept the - same for all these events so that they can be grouped + This should be kept the same for all user events + triggered from the same pageview. For example, + an item detail page view could trigger multiple + events as the user is browsing the page. The + ``pageview_id`` property should be kept the same + for all these events so that they can be grouped together properly. - When using the client side event reporting with JavaScript - pixel and Google Tag Manager, this value is filled in - automatically. + When using the client side event reporting with + JavaScript pixel and Google Tag Manager, this + value is filled in automatically. page_category (str): - The most specific category associated with a category page. - - To represent full path of category, use '>' sign to separate - different hierarchies. If '>' is part of the category name, - replace it with other character(s). - - Category pages include special pages such as sales or - promotions. For instance, a special sale page may have the - category hierarchy: - ``"pageCategory" : "Sales > 2017 Black Friday Deals"``. - - Required for ``view-category-page`` events. Other event - types should not set this field. Otherwise, an - ``INVALID_ARGUMENT`` error is returned. + The most specific category associated with a + category page. + To represent full path of category, use '>' sign + to separate different hierarchies. If '>' is + part of the category name, replace it with other + character(s). + + Category pages include special pages such as + sales or promotions. For instance, a special + sale page may have the category hierarchy: + + ``"pageCategory" : "Sales > 2017 Black Friday + Deals"``. + + Required for ``view-category-page`` events. + Other event types should not set this field. + Otherwise, an ``INVALID_ARGUMENT`` error is + returned. uri (str): Complete URL (window.location.href) of the user's current page. @@ -456,49 +505,57 @@ class SearchInfo(proto.Message): The user's search query. See - [SearchRequest.query][google.cloud.discoveryengine.v1beta.SearchRequest.query] + `SearchRequest.query + `__ for definition. - The value must be a UTF-8 encoded string with a length limit - of 5,000 characters. Otherwise, an ``INVALID_ARGUMENT`` - error is returned. + The value must be a UTF-8 encoded string with a + length limit of 5,000 characters. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. At least one of - [search_query][google.cloud.discoveryengine.v1beta.SearchInfo.search_query] + `search_query + `__ or - [PageInfo.page_category][google.cloud.discoveryengine.v1beta.PageInfo.page_category] - is required for ``search`` events. Other event types should - not set this field. Otherwise, an ``INVALID_ARGUMENT`` error - is returned. + `PageInfo.page_category + `__ + is required for ``search`` events. Other event + types should not set this field. Otherwise, an + ``INVALID_ARGUMENT`` error is returned. order_by (str): - The order in which products are returned, if applicable. - + The order in which products are returned, if + applicable. See - [SearchRequest.order_by][google.cloud.discoveryengine.v1beta.SearchRequest.order_by] + `SearchRequest.order_by + `__ for definition and syntax. - The value must be a UTF-8 encoded string with a length limit - of 1,000 characters. Otherwise, an ``INVALID_ARGUMENT`` - error is returned. - - This can only be set for ``search`` events. Other event - types should not set this field. Otherwise, an + The value must be a UTF-8 encoded string with a + length limit of 1,000 characters. Otherwise, an ``INVALID_ARGUMENT`` error is returned. + + This can only be set for ``search`` events. + Other event types should not set this field. + Otherwise, an ``INVALID_ARGUMENT`` error is + returned. offset (int): - An integer that specifies the current offset for pagination - (the 0-indexed starting location, amongst the products - deemed by the API as relevant). + An integer that specifies the current offset for + pagination (the 0-indexed starting location, + amongst the products deemed by the API as + relevant). See - [SearchRequest.offset][google.cloud.discoveryengine.v1beta.SearchRequest.offset] + `SearchRequest.offset + `__ for definition. - If this field is negative, an ``INVALID_ARGUMENT`` is - returned. + If this field is negative, an + ``INVALID_ARGUMENT`` is returned. - This can only be set for ``search`` events. Other event - types should not set this field. Otherwise, an - ``INVALID_ARGUMENT`` error is returned. + This can only be set for ``search`` events. + Other event types should not set this field. + Otherwise, an ``INVALID_ARGUMENT`` error is + returned. This field is a member of `oneof`_ ``_offset``. """ @@ -525,10 +582,12 @@ class CompletionInfo(proto.Message): Attributes: selected_suggestion (str): End user selected - [CompleteQueryResponse.QuerySuggestion.suggestion][google.cloud.discoveryengine.v1beta.CompleteQueryResponse.QuerySuggestion.suggestion]. + `CompleteQueryResponse.QuerySuggestion.suggestion + `__. selected_position (int): End user selected - [CompleteQueryResponse.QuerySuggestion.suggestion][google.cloud.discoveryengine.v1beta.CompleteQueryResponse.QuerySuggestion.suggestion] + `CompleteQueryResponse.QuerySuggestion.suggestion + `__ position, starting from 0. """ @@ -567,43 +626,51 @@ class TransactionInfo(proto.Message): This field is a member of `oneof`_ ``_tax``. cost (float): - All the costs associated with the products. These can be - manufacturing costs, shipping expenses not borne by the end - user, or any other costs, such that: - - - Profit = - [value][google.cloud.discoveryengine.v1beta.TransactionInfo.value] - - - [tax][google.cloud.discoveryengine.v1beta.TransactionInfo.tax] - - - [cost][google.cloud.discoveryengine.v1beta.TransactionInfo.cost] + All the costs associated with the products. + These can be manufacturing costs, shipping + expenses not borne by the end user, or any other + costs, such that: + + * Profit = + `value + `__ + - `tax + `__ + - `cost + `__ This field is a member of `oneof`_ ``_cost``. discount_value (float): - The total discount(s) value applied to this transaction. - This figure should be excluded from - [TransactionInfo.value][google.cloud.discoveryengine.v1beta.TransactionInfo.value] + The total discount(s) value applied to this + transaction. This figure should be excluded from + `TransactionInfo.value + `__ For example, if a user paid - [TransactionInfo.value][google.cloud.discoveryengine.v1beta.TransactionInfo.value] - amount, then nominal (pre-discount) value of the transaction - is the sum of - [TransactionInfo.value][google.cloud.discoveryengine.v1beta.TransactionInfo.value] + `TransactionInfo.value + `__ + amount, then nominal (pre-discount) value of the + transaction is the sum of `TransactionInfo.value + `__ and - [TransactionInfo.discount_value][google.cloud.discoveryengine.v1beta.TransactionInfo.discount_value] + `TransactionInfo.discount_value + `__ - This means that profit is calculated the same way, - regardless of the discount value, and that - [TransactionInfo.discount_value][google.cloud.discoveryengine.v1beta.TransactionInfo.discount_value] + This means that profit is calculated the same + way, regardless of the discount value, and that + `TransactionInfo.discount_value + `__ can be larger than - [TransactionInfo.value][google.cloud.discoveryengine.v1beta.TransactionInfo.value]: + `TransactionInfo.value + `__: - - Profit = - [value][google.cloud.discoveryengine.v1beta.TransactionInfo.value] - - - [tax][google.cloud.discoveryengine.v1beta.TransactionInfo.tax] - - - [cost][google.cloud.discoveryengine.v1beta.TransactionInfo.cost] + * Profit = + `value + `__ + - `tax + `__ + - `cost + `__ This field is a member of `oneof`_ ``_discount_value``. """ @@ -650,32 +717,37 @@ class DocumentInfo(proto.Message): Attributes: id (str): - The [Document][google.cloud.discoveryengine.v1beta.Document] + The `Document + `__ resource ID. This field is a member of `oneof`_ ``document_descriptor``. name (str): - The [Document][google.cloud.discoveryengine.v1beta.Document] + The `Document + `__ resource full name, of the form: + ``projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`` This field is a member of `oneof`_ ``document_descriptor``. uri (str): - The [Document][google.cloud.discoveryengine.v1beta.Document] + The `Document + `__ URI - only allowed for website data stores. This field is a member of `oneof`_ ``document_descriptor``. quantity (int): - Quantity of the Document associated with the user event. - Defaults to 1. - - For example, this field is 2 if two quantities of the same - Document are involved in a ``add-to-cart`` event. + Quantity of the Document associated with the + user event. Defaults to 1. + For example, this field is 2 if two quantities + of the same Document are involved in a + ``add-to-cart`` event. - Required for events of the following event types: + Required for events of the following event + types: - - ``add-to-cart`` - - ``purchase`` + * ``add-to-cart`` + * ``purchase`` This field is a member of `oneof`_ ``_quantity``. promotion_ids (MutableSequence[str]): @@ -728,16 +800,18 @@ class PanelInfo(proto.Message): display_name (str): The display name of the panel. panel_position (int): - The ordered position of the panel, if shown to the user with - other panels. If set, then - [total_panels][google.cloud.discoveryengine.v1beta.PanelInfo.total_panels] + The ordered position of the panel, if shown to + the user with other panels. If set, then + `total_panels + `__ must also be set. This field is a member of `oneof`_ ``_panel_position``. total_panels (int): - The total number of panels, including this one, shown to the - user. Must be set if - [panel_position][google.cloud.discoveryengine.v1beta.PanelInfo.panel_position] + The total number of panels, including this one, + shown to the user. Must be set if + `panel_position + `__ is set. This field is a member of `oneof`_ ``_total_panels``. @@ -778,20 +852,24 @@ class MediaInfo(proto.Message): Attributes: media_progress_duration (google.protobuf.duration_pb2.Duration): - The media progress time in seconds, if applicable. For - example, if the end user has finished 90 seconds of a - playback video, then - [MediaInfo.media_progress_duration.seconds][google.protobuf.Duration.seconds] - should be set to 90. + The media progress time in seconds, if + applicable. For example, if the end user has + finished 90 seconds of a playback video, then + `MediaInfo.media_progress_duration.seconds + `__ should be + set to 90. media_progress_percentage (float): Media progress should be computed using only the - [media_progress_duration][google.cloud.discoveryengine.v1beta.MediaInfo.media_progress_duration] + `media_progress_duration + `__ relative to the media total length. - This value must be between ``[0, 1.0]`` inclusive. + This value must be between ``[0, 1.0]`` + inclusive. - If this is not a playback or the progress cannot be computed - (e.g. ongoing livestream), this field should be unset. + If this is not a playback or the progress cannot + be computed (e.g. ongoing livestream), this + field should be unset. This field is a member of `oneof`_ ``_media_progress_percentage``. """ diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/user_event_service.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/user_event_service.py index 8be711e32aeb..166d76d7e7e9 100644 --- a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/user_event_service.py +++ b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/user_event_service.py @@ -37,17 +37,22 @@ class WriteUserEventRequest(proto.Message): Attributes: parent (str): - Required. The parent resource name. If the write user event - action is applied in - [DataStore][google.cloud.discoveryengine.v1beta.DataStore] + Required. The parent resource name. + If the write user event action is applied in + `DataStore + `__ level, the format is: + ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}``. - If the write user event action is applied in [Location][] - level, for example, the event with - [Document][google.cloud.discoveryengine.v1beta.Document] - across multiple - [DataStore][google.cloud.discoveryengine.v1beta.DataStore], - the format is: ``projects/{project}/locations/{location}``. + If the write user event action is applied in + [Location][] level, for example, the event with + `Document + `__ + across multiple `DataStore + `__, + the format is: + + ``projects/{project}/locations/{location}``. user_event (google.cloud.discoveryengine_v1beta.types.UserEvent): Required. User event to write. @@ -81,7 +86,8 @@ class CollectUserEventRequest(proto.Message): Attributes: parent (str): - Required. The parent DataStore resource name, such as + Required. The parent DataStore resource name, + such as ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}``. user_event (str): Required. URL encoded UserEvent proto with a diff --git a/packages/google-cloud-discoveryengine/noxfile.py b/packages/google-cloud-discoveryengine/noxfile.py index b1aa5da98074..cc2c57688306 100644 --- a/packages/google-cloud-discoveryengine/noxfile.py +++ b/packages/google-cloud-discoveryengine/noxfile.py @@ -27,10 +27,6 @@ LINT_PATHS = ["docs", "google", "tests", "noxfile.py", "setup.py"] -# Add samples to the list of directories to format if the directory exists. -if os.path.isdir("samples"): - LINT_PATHS.append("samples") - ALL_PYTHON = [ "3.7", "3.8", diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_assistant_service_stream_assist_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_assistant_service_stream_assist_async.py index 58b839146e14..a28f79d6da51 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_assistant_service_stream_assist_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_assistant_service_stream_assist_async.py @@ -50,5 +50,4 @@ async def sample_stream_assist(): async for response in stream: print(response) - # [END discoveryengine_v1_generated_AssistantService_StreamAssist_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_assistant_service_stream_assist_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_assistant_service_stream_assist_sync.py index 378c879f362e..56dda285fc58 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_assistant_service_stream_assist_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_assistant_service_stream_assist_sync.py @@ -50,5 +50,4 @@ def sample_stream_assist(): for response in stream: print(response) - # [END discoveryengine_v1_generated_AssistantService_StreamAssist_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_delete_cmek_config_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_delete_cmek_config_async.py index def5d4b98bd8..90d1885e887e 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_delete_cmek_config_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_delete_cmek_config_async.py @@ -53,5 +53,4 @@ async def sample_delete_cmek_config(): # Handle the response print(response) - # [END discoveryengine_v1_generated_CmekConfigService_DeleteCmekConfig_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_delete_cmek_config_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_delete_cmek_config_sync.py index bc5564303b29..bb7df58c6adb 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_delete_cmek_config_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_delete_cmek_config_sync.py @@ -53,5 +53,4 @@ def sample_delete_cmek_config(): # Handle the response print(response) - # [END discoveryengine_v1_generated_CmekConfigService_DeleteCmekConfig_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_get_cmek_config_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_get_cmek_config_async.py index b06f14173bae..31386b57064b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_get_cmek_config_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_get_cmek_config_async.py @@ -49,5 +49,4 @@ async def sample_get_cmek_config(): # Handle the response print(response) - # [END discoveryengine_v1_generated_CmekConfigService_GetCmekConfig_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_get_cmek_config_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_get_cmek_config_sync.py index 939fc61fcec8..6dc1e3aed93a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_get_cmek_config_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_get_cmek_config_sync.py @@ -49,5 +49,4 @@ def sample_get_cmek_config(): # Handle the response print(response) - # [END discoveryengine_v1_generated_CmekConfigService_GetCmekConfig_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_list_cmek_configs_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_list_cmek_configs_async.py index f4c43d0835f6..d8927d10d786 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_list_cmek_configs_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_list_cmek_configs_async.py @@ -49,5 +49,4 @@ async def sample_list_cmek_configs(): # Handle the response print(response) - # [END discoveryengine_v1_generated_CmekConfigService_ListCmekConfigs_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_list_cmek_configs_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_list_cmek_configs_sync.py index 970af6b18a75..157c5c935e42 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_list_cmek_configs_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_list_cmek_configs_sync.py @@ -49,5 +49,4 @@ def sample_list_cmek_configs(): # Handle the response print(response) - # [END discoveryengine_v1_generated_CmekConfigService_ListCmekConfigs_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_update_cmek_config_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_update_cmek_config_async.py index be3810cc5cc1..61c365e66a68 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_update_cmek_config_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_update_cmek_config_async.py @@ -56,5 +56,4 @@ async def sample_update_cmek_config(): # Handle the response print(response) - # [END discoveryengine_v1_generated_CmekConfigService_UpdateCmekConfig_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_update_cmek_config_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_update_cmek_config_sync.py index 0cc62a19ad44..1e53d9bd11a4 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_update_cmek_config_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_cmek_config_service_update_cmek_config_sync.py @@ -56,5 +56,4 @@ def sample_update_cmek_config(): # Handle the response print(response) - # [END discoveryengine_v1_generated_CmekConfigService_UpdateCmekConfig_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_complete_query_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_complete_query_async.py index 2872a8672ed4..7e934420f9b3 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_complete_query_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_complete_query_async.py @@ -50,5 +50,4 @@ async def sample_complete_query(): # Handle the response print(response) - # [END discoveryengine_v1_generated_CompletionService_CompleteQuery_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_complete_query_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_complete_query_sync.py index 92f0b50c5f6e..1ab02f8a06c1 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_complete_query_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_complete_query_sync.py @@ -50,5 +50,4 @@ def sample_complete_query(): # Handle the response print(response) - # [END discoveryengine_v1_generated_CompletionService_CompleteQuery_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_import_completion_suggestions_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_import_completion_suggestions_async.py index da2c399fa859..c686729ab640 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_import_completion_suggestions_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_import_completion_suggestions_async.py @@ -58,5 +58,4 @@ async def sample_import_completion_suggestions(): # Handle the response print(response) - # [END discoveryengine_v1_generated_CompletionService_ImportCompletionSuggestions_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_import_completion_suggestions_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_import_completion_suggestions_sync.py index cb2c3285ce25..2ee68606b20a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_import_completion_suggestions_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_import_completion_suggestions_sync.py @@ -58,5 +58,4 @@ def sample_import_completion_suggestions(): # Handle the response print(response) - # [END discoveryengine_v1_generated_CompletionService_ImportCompletionSuggestions_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_import_suggestion_deny_list_entries_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_import_suggestion_deny_list_entries_async.py index 663b6f81ef8b..f0590d4ef1c6 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_import_suggestion_deny_list_entries_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_import_suggestion_deny_list_entries_async.py @@ -58,5 +58,4 @@ async def sample_import_suggestion_deny_list_entries(): # Handle the response print(response) - # [END discoveryengine_v1_generated_CompletionService_ImportSuggestionDenyListEntries_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_import_suggestion_deny_list_entries_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_import_suggestion_deny_list_entries_sync.py index 12b56b959243..3ecaf7b0494e 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_import_suggestion_deny_list_entries_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_import_suggestion_deny_list_entries_sync.py @@ -58,5 +58,4 @@ def sample_import_suggestion_deny_list_entries(): # Handle the response print(response) - # [END discoveryengine_v1_generated_CompletionService_ImportSuggestionDenyListEntries_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_purge_completion_suggestions_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_purge_completion_suggestions_async.py index b535d45f147c..36cf3212705f 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_purge_completion_suggestions_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_purge_completion_suggestions_async.py @@ -53,5 +53,4 @@ async def sample_purge_completion_suggestions(): # Handle the response print(response) - # [END discoveryengine_v1_generated_CompletionService_PurgeCompletionSuggestions_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_purge_completion_suggestions_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_purge_completion_suggestions_sync.py index b6deddd1ce63..59ed6015d480 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_purge_completion_suggestions_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_purge_completion_suggestions_sync.py @@ -53,5 +53,4 @@ def sample_purge_completion_suggestions(): # Handle the response print(response) - # [END discoveryengine_v1_generated_CompletionService_PurgeCompletionSuggestions_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_purge_suggestion_deny_list_entries_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_purge_suggestion_deny_list_entries_async.py index c7239b8fab3f..b38d1be3d002 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_purge_suggestion_deny_list_entries_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_purge_suggestion_deny_list_entries_async.py @@ -53,5 +53,4 @@ async def sample_purge_suggestion_deny_list_entries(): # Handle the response print(response) - # [END discoveryengine_v1_generated_CompletionService_PurgeSuggestionDenyListEntries_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_purge_suggestion_deny_list_entries_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_purge_suggestion_deny_list_entries_sync.py index 39ba791d26dd..c8ec2649d417 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_purge_suggestion_deny_list_entries_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_completion_service_purge_suggestion_deny_list_entries_sync.py @@ -53,5 +53,4 @@ def sample_purge_suggestion_deny_list_entries(): # Handle the response print(response) - # [END discoveryengine_v1_generated_CompletionService_PurgeSuggestionDenyListEntries_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_create_control_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_create_control_async.py index 5225ea83a506..491fe81e5522 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_create_control_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_create_control_async.py @@ -58,5 +58,4 @@ async def sample_create_control(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ControlService_CreateControl_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_create_control_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_create_control_sync.py index 8d8e282efcf1..29fc4542cd45 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_create_control_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_create_control_sync.py @@ -58,5 +58,4 @@ def sample_create_control(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ControlService_CreateControl_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_get_control_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_get_control_async.py index 7d42f16573e3..cd72fcf52c6f 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_get_control_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_get_control_async.py @@ -49,5 +49,4 @@ async def sample_get_control(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ControlService_GetControl_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_get_control_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_get_control_sync.py index e1d4cf0e0a19..9fd33a70d9f6 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_get_control_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_get_control_sync.py @@ -49,5 +49,4 @@ def sample_get_control(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ControlService_GetControl_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_list_controls_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_list_controls_async.py index 680382406bc1..11d6041203a9 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_list_controls_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_list_controls_async.py @@ -50,5 +50,4 @@ async def sample_list_controls(): async for response in page_result: print(response) - # [END discoveryengine_v1_generated_ControlService_ListControls_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_list_controls_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_list_controls_sync.py index fa43f7853686..10f0c5734a03 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_list_controls_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_list_controls_sync.py @@ -50,5 +50,4 @@ def sample_list_controls(): for response in page_result: print(response) - # [END discoveryengine_v1_generated_ControlService_ListControls_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_update_control_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_update_control_async.py index df6d8ccc84a7..3539380889c1 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_update_control_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_update_control_async.py @@ -56,5 +56,4 @@ async def sample_update_control(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ControlService_UpdateControl_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_update_control_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_update_control_sync.py index 68028d5c3779..8a09c027ad97 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_update_control_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_control_service_update_control_sync.py @@ -56,5 +56,4 @@ def sample_update_control(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ControlService_UpdateControl_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_answer_query_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_answer_query_async.py index c8106df0a622..e862764c8934 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_answer_query_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_answer_query_async.py @@ -53,5 +53,4 @@ async def sample_answer_query(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ConversationalSearchService_AnswerQuery_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_answer_query_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_answer_query_sync.py index 1d699d8a9b27..dfac2a38ac3b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_answer_query_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_answer_query_sync.py @@ -53,5 +53,4 @@ def sample_answer_query(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ConversationalSearchService_AnswerQuery_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_converse_conversation_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_converse_conversation_async.py index 630e74b71421..1f1147b57023 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_converse_conversation_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_converse_conversation_async.py @@ -49,5 +49,4 @@ async def sample_converse_conversation(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ConversationalSearchService_ConverseConversation_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_converse_conversation_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_converse_conversation_sync.py index 58f3486b7ae8..a75ecf3514de 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_converse_conversation_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_converse_conversation_sync.py @@ -49,5 +49,4 @@ def sample_converse_conversation(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ConversationalSearchService_ConverseConversation_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_create_conversation_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_create_conversation_async.py index 4eebd94babc1..66bdd1eb5157 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_create_conversation_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_create_conversation_async.py @@ -49,5 +49,4 @@ async def sample_create_conversation(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ConversationalSearchService_CreateConversation_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_create_conversation_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_create_conversation_sync.py index 793c1d486ad7..6b3710d28efc 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_create_conversation_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_create_conversation_sync.py @@ -49,5 +49,4 @@ def sample_create_conversation(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ConversationalSearchService_CreateConversation_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_create_session_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_create_session_async.py index 2054b0142165..e15b91121c95 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_create_session_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_create_session_async.py @@ -49,5 +49,4 @@ async def sample_create_session(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ConversationalSearchService_CreateSession_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_create_session_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_create_session_sync.py index ac71cd643238..129e247bbba1 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_create_session_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_create_session_sync.py @@ -49,5 +49,4 @@ def sample_create_session(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ConversationalSearchService_CreateSession_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_get_answer_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_get_answer_async.py index d262165bdffa..5daeb5bef273 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_get_answer_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_get_answer_async.py @@ -49,5 +49,4 @@ async def sample_get_answer(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ConversationalSearchService_GetAnswer_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_get_answer_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_get_answer_sync.py index bb57113a0af2..9b6feaba70af 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_get_answer_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_get_answer_sync.py @@ -49,5 +49,4 @@ def sample_get_answer(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ConversationalSearchService_GetAnswer_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_get_conversation_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_get_conversation_async.py index 6e99161d658f..e8e2cbd5292c 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_get_conversation_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_get_conversation_async.py @@ -49,5 +49,4 @@ async def sample_get_conversation(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ConversationalSearchService_GetConversation_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_get_conversation_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_get_conversation_sync.py index d74a6651b2d9..6722c839ca62 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_get_conversation_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_get_conversation_sync.py @@ -49,5 +49,4 @@ def sample_get_conversation(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ConversationalSearchService_GetConversation_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_get_session_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_get_session_async.py index 0e13cbdac4e1..7baa0dc05104 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_get_session_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_get_session_async.py @@ -49,5 +49,4 @@ async def sample_get_session(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ConversationalSearchService_GetSession_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_get_session_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_get_session_sync.py index ee7c64c8a467..5024ddf33150 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_get_session_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_get_session_sync.py @@ -49,5 +49,4 @@ def sample_get_session(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ConversationalSearchService_GetSession_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_list_conversations_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_list_conversations_async.py index 0b3db39b5139..80f7d2f94635 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_list_conversations_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_list_conversations_async.py @@ -50,5 +50,4 @@ async def sample_list_conversations(): async for response in page_result: print(response) - # [END discoveryengine_v1_generated_ConversationalSearchService_ListConversations_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_list_conversations_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_list_conversations_sync.py index 1636b14a3244..0873049f6777 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_list_conversations_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_list_conversations_sync.py @@ -50,5 +50,4 @@ def sample_list_conversations(): for response in page_result: print(response) - # [END discoveryengine_v1_generated_ConversationalSearchService_ListConversations_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_list_sessions_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_list_sessions_async.py index 935919b2c42a..9b5f4e4cadca 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_list_sessions_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_list_sessions_async.py @@ -50,5 +50,4 @@ async def sample_list_sessions(): async for response in page_result: print(response) - # [END discoveryengine_v1_generated_ConversationalSearchService_ListSessions_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_list_sessions_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_list_sessions_sync.py index c3770cd632d6..4383811d1353 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_list_sessions_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_list_sessions_sync.py @@ -50,5 +50,4 @@ def sample_list_sessions(): for response in page_result: print(response) - # [END discoveryengine_v1_generated_ConversationalSearchService_ListSessions_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_stream_answer_query_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_stream_answer_query_async.py index 0ea60123d42e..66a6c1e39fc5 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_stream_answer_query_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_stream_answer_query_async.py @@ -54,5 +54,4 @@ async def sample_stream_answer_query(): async for response in stream: print(response) - # [END discoveryengine_v1_generated_ConversationalSearchService_StreamAnswerQuery_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_stream_answer_query_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_stream_answer_query_sync.py index 040004b53515..5de8a60ce4e5 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_stream_answer_query_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_stream_answer_query_sync.py @@ -54,5 +54,4 @@ def sample_stream_answer_query(): for response in stream: print(response) - # [END discoveryengine_v1_generated_ConversationalSearchService_StreamAnswerQuery_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_update_conversation_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_update_conversation_async.py index e4c44b9ebe82..05ad4554f2ed 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_update_conversation_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_update_conversation_async.py @@ -39,7 +39,8 @@ async def sample_update_conversation(): client = discoveryengine_v1.ConversationalSearchServiceAsyncClient() # Initialize request argument(s) - request = discoveryengine_v1.UpdateConversationRequest() + request = discoveryengine_v1.UpdateConversationRequest( + ) # Make the request response = await client.update_conversation(request=request) @@ -47,5 +48,4 @@ async def sample_update_conversation(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ConversationalSearchService_UpdateConversation_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_update_conversation_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_update_conversation_sync.py index d20316f3b701..f0a44f23e55d 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_update_conversation_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_update_conversation_sync.py @@ -39,7 +39,8 @@ def sample_update_conversation(): client = discoveryengine_v1.ConversationalSearchServiceClient() # Initialize request argument(s) - request = discoveryengine_v1.UpdateConversationRequest() + request = discoveryengine_v1.UpdateConversationRequest( + ) # Make the request response = client.update_conversation(request=request) @@ -47,5 +48,4 @@ def sample_update_conversation(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ConversationalSearchService_UpdateConversation_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_update_session_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_update_session_async.py index d78921554cfd..bd8f9587324c 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_update_session_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_update_session_async.py @@ -39,7 +39,8 @@ async def sample_update_session(): client = discoveryengine_v1.ConversationalSearchServiceAsyncClient() # Initialize request argument(s) - request = discoveryengine_v1.UpdateSessionRequest() + request = discoveryengine_v1.UpdateSessionRequest( + ) # Make the request response = await client.update_session(request=request) @@ -47,5 +48,4 @@ async def sample_update_session(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ConversationalSearchService_UpdateSession_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_update_session_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_update_session_sync.py index 69ba23a633d8..e48b66d6af90 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_update_session_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_conversational_search_service_update_session_sync.py @@ -39,7 +39,8 @@ def sample_update_session(): client = discoveryengine_v1.ConversationalSearchServiceClient() # Initialize request argument(s) - request = discoveryengine_v1.UpdateSessionRequest() + request = discoveryengine_v1.UpdateSessionRequest( + ) # Make the request response = client.update_session(request=request) @@ -47,5 +48,4 @@ def sample_update_session(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ConversationalSearchService_UpdateSession_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_create_data_store_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_create_data_store_async.py index 2de93cd7ebac..737387cd8ef1 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_create_data_store_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_create_data_store_async.py @@ -59,5 +59,4 @@ async def sample_create_data_store(): # Handle the response print(response) - # [END discoveryengine_v1_generated_DataStoreService_CreateDataStore_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_create_data_store_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_create_data_store_sync.py index 18e793ff0d0f..e4b18e01cc1f 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_create_data_store_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_create_data_store_sync.py @@ -59,5 +59,4 @@ def sample_create_data_store(): # Handle the response print(response) - # [END discoveryengine_v1_generated_DataStoreService_CreateDataStore_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_delete_data_store_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_delete_data_store_async.py index 17dcc5739d98..74adc3506bc9 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_delete_data_store_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_delete_data_store_async.py @@ -53,5 +53,4 @@ async def sample_delete_data_store(): # Handle the response print(response) - # [END discoveryengine_v1_generated_DataStoreService_DeleteDataStore_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_delete_data_store_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_delete_data_store_sync.py index ea1d8f951521..f974b44dff48 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_delete_data_store_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_delete_data_store_sync.py @@ -53,5 +53,4 @@ def sample_delete_data_store(): # Handle the response print(response) - # [END discoveryengine_v1_generated_DataStoreService_DeleteDataStore_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_get_data_store_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_get_data_store_async.py index d12e5a319f7a..924796cf7f22 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_get_data_store_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_get_data_store_async.py @@ -49,5 +49,4 @@ async def sample_get_data_store(): # Handle the response print(response) - # [END discoveryengine_v1_generated_DataStoreService_GetDataStore_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_get_data_store_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_get_data_store_sync.py index 13792d1bc354..7eafe02b3d98 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_get_data_store_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_get_data_store_sync.py @@ -49,5 +49,4 @@ def sample_get_data_store(): # Handle the response print(response) - # [END discoveryengine_v1_generated_DataStoreService_GetDataStore_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_list_data_stores_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_list_data_stores_async.py index 1f006887f106..729bebb0e0ef 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_list_data_stores_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_list_data_stores_async.py @@ -50,5 +50,4 @@ async def sample_list_data_stores(): async for response in page_result: print(response) - # [END discoveryengine_v1_generated_DataStoreService_ListDataStores_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_list_data_stores_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_list_data_stores_sync.py index 94a51c3437d8..aa38abd478dd 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_list_data_stores_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_list_data_stores_sync.py @@ -50,5 +50,4 @@ def sample_list_data_stores(): for response in page_result: print(response) - # [END discoveryengine_v1_generated_DataStoreService_ListDataStores_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_update_data_store_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_update_data_store_async.py index 6b827c384aed..0e8941560e5a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_update_data_store_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_update_data_store_async.py @@ -52,5 +52,4 @@ async def sample_update_data_store(): # Handle the response print(response) - # [END discoveryengine_v1_generated_DataStoreService_UpdateDataStore_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_update_data_store_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_update_data_store_sync.py index 7ce01346a249..46c56e76b4d4 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_update_data_store_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_data_store_service_update_data_store_sync.py @@ -52,5 +52,4 @@ def sample_update_data_store(): # Handle the response print(response) - # [END discoveryengine_v1_generated_DataStoreService_UpdateDataStore_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_batch_get_documents_metadata_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_batch_get_documents_metadata_async.py index 9fdf9f038157..258a6978f09a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_batch_get_documents_metadata_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_batch_get_documents_metadata_async.py @@ -49,5 +49,4 @@ async def sample_batch_get_documents_metadata(): # Handle the response print(response) - # [END discoveryengine_v1_generated_DocumentService_BatchGetDocumentsMetadata_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_batch_get_documents_metadata_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_batch_get_documents_metadata_sync.py index 83072910de02..0bd8a2ea3f8f 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_batch_get_documents_metadata_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_batch_get_documents_metadata_sync.py @@ -49,5 +49,4 @@ def sample_batch_get_documents_metadata(): # Handle the response print(response) - # [END discoveryengine_v1_generated_DocumentService_BatchGetDocumentsMetadata_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_create_document_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_create_document_async.py index 7222fcf1d5eb..571aa929cfc2 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_create_document_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_create_document_async.py @@ -50,5 +50,4 @@ async def sample_create_document(): # Handle the response print(response) - # [END discoveryengine_v1_generated_DocumentService_CreateDocument_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_create_document_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_create_document_sync.py index 421b7b5865d9..0aa3c249f8d9 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_create_document_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_create_document_sync.py @@ -50,5 +50,4 @@ def sample_create_document(): # Handle the response print(response) - # [END discoveryengine_v1_generated_DocumentService_CreateDocument_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_get_document_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_get_document_async.py index d2d15f9e9bf3..64d767bf57f6 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_get_document_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_get_document_async.py @@ -49,5 +49,4 @@ async def sample_get_document(): # Handle the response print(response) - # [END discoveryengine_v1_generated_DocumentService_GetDocument_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_get_document_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_get_document_sync.py index 7348bf4afa18..7d79a11af373 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_get_document_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_get_document_sync.py @@ -49,5 +49,4 @@ def sample_get_document(): # Handle the response print(response) - # [END discoveryengine_v1_generated_DocumentService_GetDocument_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_import_documents_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_import_documents_async.py index d6f1c9a09cb9..d49b872d9f8b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_import_documents_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_import_documents_async.py @@ -53,5 +53,4 @@ async def sample_import_documents(): # Handle the response print(response) - # [END discoveryengine_v1_generated_DocumentService_ImportDocuments_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_import_documents_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_import_documents_sync.py index 4b8894fbebb9..4aada3891de0 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_import_documents_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_import_documents_sync.py @@ -53,5 +53,4 @@ def sample_import_documents(): # Handle the response print(response) - # [END discoveryengine_v1_generated_DocumentService_ImportDocuments_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_list_documents_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_list_documents_async.py index 34062ea1cd99..430fa36f01da 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_list_documents_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_list_documents_async.py @@ -50,5 +50,4 @@ async def sample_list_documents(): async for response in page_result: print(response) - # [END discoveryengine_v1_generated_DocumentService_ListDocuments_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_list_documents_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_list_documents_sync.py index 35a962d811fa..5858752800ac 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_list_documents_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_list_documents_sync.py @@ -50,5 +50,4 @@ def sample_list_documents(): for response in page_result: print(response) - # [END discoveryengine_v1_generated_DocumentService_ListDocuments_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_purge_documents_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_purge_documents_async.py index 21dda0fcefc8..9e7589d5d550 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_purge_documents_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_purge_documents_async.py @@ -40,7 +40,7 @@ async def sample_purge_documents(): # Initialize request argument(s) gcs_source = discoveryengine_v1.GcsSource() - gcs_source.input_uris = ["input_uris_value1", "input_uris_value2"] + gcs_source.input_uris = ['input_uris_value1', 'input_uris_value2'] request = discoveryengine_v1.PurgeDocumentsRequest( gcs_source=gcs_source, @@ -58,5 +58,4 @@ async def sample_purge_documents(): # Handle the response print(response) - # [END discoveryengine_v1_generated_DocumentService_PurgeDocuments_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_purge_documents_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_purge_documents_sync.py index 1ef709b81d9b..4969360c70bf 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_purge_documents_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_purge_documents_sync.py @@ -40,7 +40,7 @@ def sample_purge_documents(): # Initialize request argument(s) gcs_source = discoveryengine_v1.GcsSource() - gcs_source.input_uris = ["input_uris_value1", "input_uris_value2"] + gcs_source.input_uris = ['input_uris_value1', 'input_uris_value2'] request = discoveryengine_v1.PurgeDocumentsRequest( gcs_source=gcs_source, @@ -58,5 +58,4 @@ def sample_purge_documents(): # Handle the response print(response) - # [END discoveryengine_v1_generated_DocumentService_PurgeDocuments_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_update_document_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_update_document_async.py index 48b0b72e4b0a..c78d47e005b6 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_update_document_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_update_document_async.py @@ -39,7 +39,8 @@ async def sample_update_document(): client = discoveryengine_v1.DocumentServiceAsyncClient() # Initialize request argument(s) - request = discoveryengine_v1.UpdateDocumentRequest() + request = discoveryengine_v1.UpdateDocumentRequest( + ) # Make the request response = await client.update_document(request=request) @@ -47,5 +48,4 @@ async def sample_update_document(): # Handle the response print(response) - # [END discoveryengine_v1_generated_DocumentService_UpdateDocument_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_update_document_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_update_document_sync.py index f7343b2244f0..e71b56757e5d 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_update_document_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_document_service_update_document_sync.py @@ -39,7 +39,8 @@ def sample_update_document(): client = discoveryengine_v1.DocumentServiceClient() # Initialize request argument(s) - request = discoveryengine_v1.UpdateDocumentRequest() + request = discoveryengine_v1.UpdateDocumentRequest( + ) # Make the request response = client.update_document(request=request) @@ -47,5 +48,4 @@ def sample_update_document(): # Handle the response print(response) - # [END discoveryengine_v1_generated_DocumentService_UpdateDocument_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_create_engine_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_create_engine_async.py index 6cd6970c7f7e..8895a369500b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_create_engine_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_create_engine_async.py @@ -59,5 +59,4 @@ async def sample_create_engine(): # Handle the response print(response) - # [END discoveryengine_v1_generated_EngineService_CreateEngine_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_create_engine_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_create_engine_sync.py index 4c547f97ff0d..df9f42e4d518 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_create_engine_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_create_engine_sync.py @@ -59,5 +59,4 @@ def sample_create_engine(): # Handle the response print(response) - # [END discoveryengine_v1_generated_EngineService_CreateEngine_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_delete_engine_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_delete_engine_async.py index 23ba3e001d69..0cb8fe8bb5e6 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_delete_engine_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_delete_engine_async.py @@ -53,5 +53,4 @@ async def sample_delete_engine(): # Handle the response print(response) - # [END discoveryengine_v1_generated_EngineService_DeleteEngine_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_delete_engine_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_delete_engine_sync.py index d6585c13ee0c..ce605e4bda11 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_delete_engine_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_delete_engine_sync.py @@ -53,5 +53,4 @@ def sample_delete_engine(): # Handle the response print(response) - # [END discoveryengine_v1_generated_EngineService_DeleteEngine_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_get_engine_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_get_engine_async.py index e038d18f7643..638fee4116be 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_get_engine_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_get_engine_async.py @@ -49,5 +49,4 @@ async def sample_get_engine(): # Handle the response print(response) - # [END discoveryengine_v1_generated_EngineService_GetEngine_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_get_engine_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_get_engine_sync.py index 5c6def4deeaa..fafdba5b693c 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_get_engine_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_get_engine_sync.py @@ -49,5 +49,4 @@ def sample_get_engine(): # Handle the response print(response) - # [END discoveryengine_v1_generated_EngineService_GetEngine_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_list_engines_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_list_engines_async.py index 529e271f8928..407a667a5800 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_list_engines_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_list_engines_async.py @@ -50,5 +50,4 @@ async def sample_list_engines(): async for response in page_result: print(response) - # [END discoveryengine_v1_generated_EngineService_ListEngines_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_list_engines_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_list_engines_sync.py index 6a13c6f6e6e9..be193e3195b7 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_list_engines_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_list_engines_sync.py @@ -50,5 +50,4 @@ def sample_list_engines(): for response in page_result: print(response) - # [END discoveryengine_v1_generated_EngineService_ListEngines_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_update_engine_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_update_engine_async.py index 7d724a7bc392..cb7b459d5552 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_update_engine_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_update_engine_async.py @@ -53,5 +53,4 @@ async def sample_update_engine(): # Handle the response print(response) - # [END discoveryengine_v1_generated_EngineService_UpdateEngine_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_update_engine_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_update_engine_sync.py index 37c443e12270..8294f637bb7b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_update_engine_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_engine_service_update_engine_sync.py @@ -53,5 +53,4 @@ def sample_update_engine(): # Handle the response print(response) - # [END discoveryengine_v1_generated_EngineService_UpdateEngine_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_grounded_generation_service_check_grounding_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_grounded_generation_service_check_grounding_async.py index b676a16da86e..f542fa848914 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_grounded_generation_service_check_grounding_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_grounded_generation_service_check_grounding_async.py @@ -49,5 +49,4 @@ async def sample_check_grounding(): # Handle the response print(response) - # [END discoveryengine_v1_generated_GroundedGenerationService_CheckGrounding_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_grounded_generation_service_check_grounding_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_grounded_generation_service_check_grounding_sync.py index 7c6e9ec11d34..9697e272f103 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_grounded_generation_service_check_grounding_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_grounded_generation_service_check_grounding_sync.py @@ -49,5 +49,4 @@ def sample_check_grounding(): # Handle the response print(response) - # [END discoveryengine_v1_generated_GroundedGenerationService_CheckGrounding_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_grounded_generation_service_generate_grounded_content_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_grounded_generation_service_generate_grounded_content_async.py index 16a991307938..f09ff407cbff 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_grounded_generation_service_generate_grounded_content_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_grounded_generation_service_generate_grounded_content_async.py @@ -49,5 +49,4 @@ async def sample_generate_grounded_content(): # Handle the response print(response) - # [END discoveryengine_v1_generated_GroundedGenerationService_GenerateGroundedContent_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_grounded_generation_service_generate_grounded_content_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_grounded_generation_service_generate_grounded_content_sync.py index 2dde79292128..bb6ed064d1f7 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_grounded_generation_service_generate_grounded_content_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_grounded_generation_service_generate_grounded_content_sync.py @@ -49,5 +49,4 @@ def sample_generate_grounded_content(): # Handle the response print(response) - # [END discoveryengine_v1_generated_GroundedGenerationService_GenerateGroundedContent_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_grounded_generation_service_stream_generate_grounded_content_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_grounded_generation_service_stream_generate_grounded_content_async.py index ef3ed85975e3..86a85750a433 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_grounded_generation_service_stream_generate_grounded_content_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_grounded_generation_service_stream_generate_grounded_content_async.py @@ -60,5 +60,4 @@ def request_generator(): async for response in stream: print(response) - # [END discoveryengine_v1_generated_GroundedGenerationService_StreamGenerateGroundedContent_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_grounded_generation_service_stream_generate_grounded_content_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_grounded_generation_service_stream_generate_grounded_content_sync.py index 7bf46a287b7b..77716e18f925 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_grounded_generation_service_stream_generate_grounded_content_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_grounded_generation_service_stream_generate_grounded_content_sync.py @@ -60,5 +60,4 @@ def request_generator(): for response in stream: print(response) - # [END discoveryengine_v1_generated_GroundedGenerationService_StreamGenerateGroundedContent_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_create_identity_mapping_store_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_create_identity_mapping_store_async.py index 83a21cd42d7f..c43e4d863f1b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_create_identity_mapping_store_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_create_identity_mapping_store_async.py @@ -51,5 +51,4 @@ async def sample_create_identity_mapping_store(): # Handle the response print(response) - # [END discoveryengine_v1_generated_IdentityMappingStoreService_CreateIdentityMappingStore_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_create_identity_mapping_store_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_create_identity_mapping_store_sync.py index ccbee21eaf6c..173b418d80a3 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_create_identity_mapping_store_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_create_identity_mapping_store_sync.py @@ -51,5 +51,4 @@ def sample_create_identity_mapping_store(): # Handle the response print(response) - # [END discoveryengine_v1_generated_IdentityMappingStoreService_CreateIdentityMappingStore_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_delete_identity_mapping_store_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_delete_identity_mapping_store_async.py index b454946f2768..c53be1558c41 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_delete_identity_mapping_store_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_delete_identity_mapping_store_async.py @@ -53,5 +53,4 @@ async def sample_delete_identity_mapping_store(): # Handle the response print(response) - # [END discoveryengine_v1_generated_IdentityMappingStoreService_DeleteIdentityMappingStore_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_delete_identity_mapping_store_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_delete_identity_mapping_store_sync.py index f3e569df8bf2..42a98381c893 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_delete_identity_mapping_store_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_delete_identity_mapping_store_sync.py @@ -53,5 +53,4 @@ def sample_delete_identity_mapping_store(): # Handle the response print(response) - # [END discoveryengine_v1_generated_IdentityMappingStoreService_DeleteIdentityMappingStore_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_get_identity_mapping_store_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_get_identity_mapping_store_async.py index 38b5a9a1cfb3..02a189c14cde 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_get_identity_mapping_store_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_get_identity_mapping_store_async.py @@ -49,5 +49,4 @@ async def sample_get_identity_mapping_store(): # Handle the response print(response) - # [END discoveryengine_v1_generated_IdentityMappingStoreService_GetIdentityMappingStore_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_get_identity_mapping_store_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_get_identity_mapping_store_sync.py index 0a3f515c86f4..8e06a8403778 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_get_identity_mapping_store_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_get_identity_mapping_store_sync.py @@ -49,5 +49,4 @@ def sample_get_identity_mapping_store(): # Handle the response print(response) - # [END discoveryengine_v1_generated_IdentityMappingStoreService_GetIdentityMappingStore_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_import_identity_mappings_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_import_identity_mappings_async.py index d7c1d5d51e11..a6e02c6af53d 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_import_identity_mappings_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_import_identity_mappings_async.py @@ -53,5 +53,4 @@ async def sample_import_identity_mappings(): # Handle the response print(response) - # [END discoveryengine_v1_generated_IdentityMappingStoreService_ImportIdentityMappings_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_import_identity_mappings_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_import_identity_mappings_sync.py index 97003e96c4b3..3fd1698fd70f 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_import_identity_mappings_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_import_identity_mappings_sync.py @@ -53,5 +53,4 @@ def sample_import_identity_mappings(): # Handle the response print(response) - # [END discoveryengine_v1_generated_IdentityMappingStoreService_ImportIdentityMappings_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_list_identity_mapping_stores_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_list_identity_mapping_stores_async.py index f70f21649d03..2a09aaadc4e9 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_list_identity_mapping_stores_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_list_identity_mapping_stores_async.py @@ -50,5 +50,4 @@ async def sample_list_identity_mapping_stores(): async for response in page_result: print(response) - # [END discoveryengine_v1_generated_IdentityMappingStoreService_ListIdentityMappingStores_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_list_identity_mapping_stores_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_list_identity_mapping_stores_sync.py index 7b6c736b8752..cfa5e51657ed 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_list_identity_mapping_stores_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_list_identity_mapping_stores_sync.py @@ -50,5 +50,4 @@ def sample_list_identity_mapping_stores(): for response in page_result: print(response) - # [END discoveryengine_v1_generated_IdentityMappingStoreService_ListIdentityMappingStores_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_list_identity_mappings_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_list_identity_mappings_async.py index 01dd589046fc..b6d25be1c2ca 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_list_identity_mappings_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_list_identity_mappings_async.py @@ -50,5 +50,4 @@ async def sample_list_identity_mappings(): async for response in page_result: print(response) - # [END discoveryengine_v1_generated_IdentityMappingStoreService_ListIdentityMappings_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_list_identity_mappings_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_list_identity_mappings_sync.py index a1beb1fd8d86..f52e247a4b87 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_list_identity_mappings_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_list_identity_mappings_sync.py @@ -50,5 +50,4 @@ def sample_list_identity_mappings(): for response in page_result: print(response) - # [END discoveryengine_v1_generated_IdentityMappingStoreService_ListIdentityMappings_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_purge_identity_mappings_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_purge_identity_mappings_async.py index b3b17af093e4..21397f5fc69b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_purge_identity_mappings_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_purge_identity_mappings_async.py @@ -53,5 +53,4 @@ async def sample_purge_identity_mappings(): # Handle the response print(response) - # [END discoveryengine_v1_generated_IdentityMappingStoreService_PurgeIdentityMappings_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_purge_identity_mappings_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_purge_identity_mappings_sync.py index f78957bcb168..5146869b6aa2 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_purge_identity_mappings_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_identity_mapping_store_service_purge_identity_mappings_sync.py @@ -53,5 +53,4 @@ def sample_purge_identity_mappings(): # Handle the response print(response) - # [END discoveryengine_v1_generated_IdentityMappingStoreService_PurgeIdentityMappings_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_project_service_provision_project_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_project_service_provision_project_async.py index 5d2f49bc8fba..00df347d4871 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_project_service_provision_project_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_project_service_provision_project_async.py @@ -55,5 +55,4 @@ async def sample_provision_project(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ProjectService_ProvisionProject_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_project_service_provision_project_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_project_service_provision_project_sync.py index 8dbbe4de297a..d90ee9585f4b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_project_service_provision_project_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_project_service_provision_project_sync.py @@ -55,5 +55,4 @@ def sample_provision_project(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ProjectService_ProvisionProject_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_rank_service_rank_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_rank_service_rank_async.py index 2ff934b5bab9..5faae73a7689 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_rank_service_rank_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_rank_service_rank_async.py @@ -49,5 +49,4 @@ async def sample_rank(): # Handle the response print(response) - # [END discoveryengine_v1_generated_RankService_Rank_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_rank_service_rank_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_rank_service_rank_sync.py index 908beb6a5638..d1b14b62efa2 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_rank_service_rank_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_rank_service_rank_sync.py @@ -49,5 +49,4 @@ def sample_rank(): # Handle the response print(response) - # [END discoveryengine_v1_generated_RankService_Rank_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_recommendation_service_recommend_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_recommendation_service_recommend_async.py index c2ec9a850999..e4be5f4dd5a0 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_recommendation_service_recommend_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_recommendation_service_recommend_async.py @@ -54,5 +54,4 @@ async def sample_recommend(): # Handle the response print(response) - # [END discoveryengine_v1_generated_RecommendationService_Recommend_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_recommendation_service_recommend_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_recommendation_service_recommend_sync.py index 1a616c511ad7..fb5186af7815 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_recommendation_service_recommend_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_recommendation_service_recommend_sync.py @@ -54,5 +54,4 @@ def sample_recommend(): # Handle the response print(response) - # [END discoveryengine_v1_generated_RecommendationService_Recommend_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_create_schema_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_create_schema_async.py index 05ad44399ac4..eb2851552fe5 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_create_schema_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_create_schema_async.py @@ -54,5 +54,4 @@ async def sample_create_schema(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SchemaService_CreateSchema_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_create_schema_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_create_schema_sync.py index 766557d87883..2c341aaab036 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_create_schema_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_create_schema_sync.py @@ -54,5 +54,4 @@ def sample_create_schema(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SchemaService_CreateSchema_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_delete_schema_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_delete_schema_async.py index 7f1dabea275b..41bbad16e7d4 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_delete_schema_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_delete_schema_async.py @@ -53,5 +53,4 @@ async def sample_delete_schema(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SchemaService_DeleteSchema_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_delete_schema_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_delete_schema_sync.py index 0342204d3620..5f7ecf33858f 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_delete_schema_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_delete_schema_sync.py @@ -53,5 +53,4 @@ def sample_delete_schema(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SchemaService_DeleteSchema_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_get_schema_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_get_schema_async.py index f340257c4fb2..8dcaaff3ea28 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_get_schema_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_get_schema_async.py @@ -49,5 +49,4 @@ async def sample_get_schema(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SchemaService_GetSchema_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_get_schema_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_get_schema_sync.py index d1bc572d6f79..83097e70bd63 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_get_schema_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_get_schema_sync.py @@ -49,5 +49,4 @@ def sample_get_schema(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SchemaService_GetSchema_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_list_schemas_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_list_schemas_async.py index 9959b487e2e6..d24e1a42a8ff 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_list_schemas_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_list_schemas_async.py @@ -50,5 +50,4 @@ async def sample_list_schemas(): async for response in page_result: print(response) - # [END discoveryengine_v1_generated_SchemaService_ListSchemas_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_list_schemas_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_list_schemas_sync.py index 422e9d4436f8..7ba44fc77c1a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_list_schemas_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_list_schemas_sync.py @@ -50,5 +50,4 @@ def sample_list_schemas(): for response in page_result: print(response) - # [END discoveryengine_v1_generated_SchemaService_ListSchemas_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_update_schema_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_update_schema_async.py index ccd5ba5da1c4..1ea947cb7fe7 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_update_schema_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_update_schema_async.py @@ -39,7 +39,8 @@ async def sample_update_schema(): client = discoveryengine_v1.SchemaServiceAsyncClient() # Initialize request argument(s) - request = discoveryengine_v1.UpdateSchemaRequest() + request = discoveryengine_v1.UpdateSchemaRequest( + ) # Make the request operation = client.update_schema(request=request) @@ -51,5 +52,4 @@ async def sample_update_schema(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SchemaService_UpdateSchema_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_update_schema_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_update_schema_sync.py index 4e90e11c06d7..84970664cefc 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_update_schema_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_schema_service_update_schema_sync.py @@ -39,7 +39,8 @@ def sample_update_schema(): client = discoveryengine_v1.SchemaServiceClient() # Initialize request argument(s) - request = discoveryengine_v1.UpdateSchemaRequest() + request = discoveryengine_v1.UpdateSchemaRequest( + ) # Make the request operation = client.update_schema(request=request) @@ -51,5 +52,4 @@ def sample_update_schema(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SchemaService_UpdateSchema_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_service_search_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_service_search_async.py index 5d84a29c3bd0..9d538e65374f 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_service_search_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_service_search_async.py @@ -50,5 +50,4 @@ async def sample_search(): async for response in page_result: print(response) - # [END discoveryengine_v1_generated_SearchService_Search_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_service_search_lite_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_service_search_lite_async.py index ff092d8a8aad..c5060a0248f9 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_service_search_lite_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_service_search_lite_async.py @@ -50,5 +50,4 @@ async def sample_search_lite(): async for response in page_result: print(response) - # [END discoveryengine_v1_generated_SearchService_SearchLite_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_service_search_lite_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_service_search_lite_sync.py index 444c8bf90099..75a31e7a161d 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_service_search_lite_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_service_search_lite_sync.py @@ -50,5 +50,4 @@ def sample_search_lite(): for response in page_result: print(response) - # [END discoveryengine_v1_generated_SearchService_SearchLite_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_service_search_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_service_search_sync.py index c71ed9c2f005..fee699a7a258 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_service_search_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_service_search_sync.py @@ -50,5 +50,4 @@ def sample_search(): for response in page_result: print(response) - # [END discoveryengine_v1_generated_SearchService_Search_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_tuning_service_list_custom_models_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_tuning_service_list_custom_models_async.py index e5bd62cc2974..63da53427aad 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_tuning_service_list_custom_models_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_tuning_service_list_custom_models_async.py @@ -49,5 +49,4 @@ async def sample_list_custom_models(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SearchTuningService_ListCustomModels_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_tuning_service_list_custom_models_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_tuning_service_list_custom_models_sync.py index 8174fd0df8b3..79ddb25d93d3 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_tuning_service_list_custom_models_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_tuning_service_list_custom_models_sync.py @@ -49,5 +49,4 @@ def sample_list_custom_models(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SearchTuningService_ListCustomModels_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_tuning_service_train_custom_model_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_tuning_service_train_custom_model_async.py index d58f35aeba49..1d3f404955dc 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_tuning_service_train_custom_model_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_tuning_service_train_custom_model_async.py @@ -53,5 +53,4 @@ async def sample_train_custom_model(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SearchTuningService_TrainCustomModel_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_tuning_service_train_custom_model_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_tuning_service_train_custom_model_sync.py index 732740ae828c..57df15c102d4 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_tuning_service_train_custom_model_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_search_tuning_service_train_custom_model_sync.py @@ -53,5 +53,4 @@ def sample_train_custom_model(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SearchTuningService_TrainCustomModel_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_serving_config_service_update_serving_config_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_serving_config_service_update_serving_config_async.py index 95829130774a..00fdf31c0409 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_serving_config_service_update_serving_config_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_serving_config_service_update_serving_config_async.py @@ -54,5 +54,4 @@ async def sample_update_serving_config(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ServingConfigService_UpdateServingConfig_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_serving_config_service_update_serving_config_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_serving_config_service_update_serving_config_sync.py index 2dc9228e93dc..d06ef8678b3f 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_serving_config_service_update_serving_config_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_serving_config_service_update_serving_config_sync.py @@ -54,5 +54,4 @@ def sample_update_serving_config(): # Handle the response print(response) - # [END discoveryengine_v1_generated_ServingConfigService_UpdateServingConfig_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_create_session_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_create_session_async.py index 3253b28f5f8d..752e2a676828 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_create_session_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_create_session_async.py @@ -49,5 +49,4 @@ async def sample_create_session(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SessionService_CreateSession_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_create_session_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_create_session_sync.py index c73a452ef56c..8f2ef4ac4400 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_create_session_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_create_session_sync.py @@ -49,5 +49,4 @@ def sample_create_session(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SessionService_CreateSession_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_get_session_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_get_session_async.py index d0168c7697f6..05066a8c3520 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_get_session_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_get_session_async.py @@ -49,5 +49,4 @@ async def sample_get_session(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SessionService_GetSession_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_get_session_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_get_session_sync.py index 3227a8f3f3fb..125b31bbe137 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_get_session_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_get_session_sync.py @@ -49,5 +49,4 @@ def sample_get_session(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SessionService_GetSession_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_list_sessions_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_list_sessions_async.py index 5cc0ea3af748..de699c018a3b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_list_sessions_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_list_sessions_async.py @@ -50,5 +50,4 @@ async def sample_list_sessions(): async for response in page_result: print(response) - # [END discoveryengine_v1_generated_SessionService_ListSessions_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_list_sessions_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_list_sessions_sync.py index ddeabafc6d5f..315a2d268dd8 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_list_sessions_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_list_sessions_sync.py @@ -50,5 +50,4 @@ def sample_list_sessions(): for response in page_result: print(response) - # [END discoveryengine_v1_generated_SessionService_ListSessions_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_update_session_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_update_session_async.py index 2108118ed54c..6c508b4e59c6 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_update_session_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_update_session_async.py @@ -39,7 +39,8 @@ async def sample_update_session(): client = discoveryengine_v1.SessionServiceAsyncClient() # Initialize request argument(s) - request = discoveryengine_v1.UpdateSessionRequest() + request = discoveryengine_v1.UpdateSessionRequest( + ) # Make the request response = await client.update_session(request=request) @@ -47,5 +48,4 @@ async def sample_update_session(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SessionService_UpdateSession_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_update_session_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_update_session_sync.py index a263a39529ed..ba57999aca83 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_update_session_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_session_service_update_session_sync.py @@ -39,7 +39,8 @@ def sample_update_session(): client = discoveryengine_v1.SessionServiceClient() # Initialize request argument(s) - request = discoveryengine_v1.UpdateSessionRequest() + request = discoveryengine_v1.UpdateSessionRequest( + ) # Make the request response = client.update_session(request=request) @@ -47,5 +48,4 @@ def sample_update_session(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SessionService_UpdateSession_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_batch_create_target_sites_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_batch_create_target_sites_async.py index 802bc20c30b0..1e768b30cac4 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_batch_create_target_sites_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_batch_create_target_sites_async.py @@ -58,5 +58,4 @@ async def sample_batch_create_target_sites(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_BatchCreateTargetSites_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_batch_create_target_sites_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_batch_create_target_sites_sync.py index 97689971ebf2..7586beb10743 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_batch_create_target_sites_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_batch_create_target_sites_sync.py @@ -58,5 +58,4 @@ def sample_batch_create_target_sites(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_BatchCreateTargetSites_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_batch_verify_target_sites_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_batch_verify_target_sites_async.py index 17e3c756a197..23fb55f5333b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_batch_verify_target_sites_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_batch_verify_target_sites_async.py @@ -53,5 +53,4 @@ async def sample_batch_verify_target_sites(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_BatchVerifyTargetSites_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_batch_verify_target_sites_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_batch_verify_target_sites_sync.py index 3756c94d08e3..a6dfcad2f06c 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_batch_verify_target_sites_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_batch_verify_target_sites_sync.py @@ -53,5 +53,4 @@ def sample_batch_verify_target_sites(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_BatchVerifyTargetSites_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_create_sitemap_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_create_sitemap_async.py index b0adf216e068..71ea4a25e177 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_create_sitemap_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_create_sitemap_async.py @@ -57,5 +57,4 @@ async def sample_create_sitemap(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_CreateSitemap_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_create_sitemap_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_create_sitemap_sync.py index d03499d9c58a..cb5ade4192a9 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_create_sitemap_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_create_sitemap_sync.py @@ -57,5 +57,4 @@ def sample_create_sitemap(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_CreateSitemap_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_create_target_site_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_create_target_site_async.py index 1e6868bfdf90..756f77800955 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_create_target_site_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_create_target_site_async.py @@ -57,5 +57,4 @@ async def sample_create_target_site(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_CreateTargetSite_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_create_target_site_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_create_target_site_sync.py index b0be0dfde77d..fd516471b7b0 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_create_target_site_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_create_target_site_sync.py @@ -57,5 +57,4 @@ def sample_create_target_site(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_CreateTargetSite_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_delete_sitemap_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_delete_sitemap_async.py index 63b755b6ac65..98433cbaa570 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_delete_sitemap_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_delete_sitemap_async.py @@ -53,5 +53,4 @@ async def sample_delete_sitemap(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_DeleteSitemap_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_delete_sitemap_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_delete_sitemap_sync.py index eacccf560c88..b50d4492caf7 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_delete_sitemap_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_delete_sitemap_sync.py @@ -53,5 +53,4 @@ def sample_delete_sitemap(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_DeleteSitemap_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_delete_target_site_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_delete_target_site_async.py index 16447d32f982..d669c0a9876c 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_delete_target_site_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_delete_target_site_async.py @@ -53,5 +53,4 @@ async def sample_delete_target_site(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_DeleteTargetSite_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_delete_target_site_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_delete_target_site_sync.py index d3cc43b1f3bb..c213fd05a89a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_delete_target_site_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_delete_target_site_sync.py @@ -53,5 +53,4 @@ def sample_delete_target_site(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_DeleteTargetSite_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_disable_advanced_site_search_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_disable_advanced_site_search_async.py index edd433254023..78cadacec079 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_disable_advanced_site_search_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_disable_advanced_site_search_async.py @@ -53,5 +53,4 @@ async def sample_disable_advanced_site_search(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_DisableAdvancedSiteSearch_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_disable_advanced_site_search_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_disable_advanced_site_search_sync.py index 2fb5b175a5e4..b209de709b74 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_disable_advanced_site_search_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_disable_advanced_site_search_sync.py @@ -53,5 +53,4 @@ def sample_disable_advanced_site_search(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_DisableAdvancedSiteSearch_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_enable_advanced_site_search_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_enable_advanced_site_search_async.py index 85769bd4fa52..e397cb786ff8 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_enable_advanced_site_search_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_enable_advanced_site_search_async.py @@ -53,5 +53,4 @@ async def sample_enable_advanced_site_search(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_EnableAdvancedSiteSearch_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_enable_advanced_site_search_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_enable_advanced_site_search_sync.py index eff5aa719168..6a0f77f7cbd6 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_enable_advanced_site_search_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_enable_advanced_site_search_sync.py @@ -53,5 +53,4 @@ def sample_enable_advanced_site_search(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_EnableAdvancedSiteSearch_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_fetch_domain_verification_status_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_fetch_domain_verification_status_async.py index 5fcbaddbf82e..cda54642c75a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_fetch_domain_verification_status_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_fetch_domain_verification_status_async.py @@ -50,5 +50,4 @@ async def sample_fetch_domain_verification_status(): async for response in page_result: print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_FetchDomainVerificationStatus_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_fetch_domain_verification_status_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_fetch_domain_verification_status_sync.py index 92d8886ef8e4..8d3463b49122 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_fetch_domain_verification_status_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_fetch_domain_verification_status_sync.py @@ -50,5 +50,4 @@ def sample_fetch_domain_verification_status(): for response in page_result: print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_FetchDomainVerificationStatus_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_fetch_sitemaps_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_fetch_sitemaps_async.py index eca9415ea386..73cef0fd7a50 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_fetch_sitemaps_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_fetch_sitemaps_async.py @@ -49,5 +49,4 @@ async def sample_fetch_sitemaps(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_FetchSitemaps_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_fetch_sitemaps_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_fetch_sitemaps_sync.py index c39ce5b6471a..26d4fbf488a8 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_fetch_sitemaps_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_fetch_sitemaps_sync.py @@ -49,5 +49,4 @@ def sample_fetch_sitemaps(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_FetchSitemaps_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_get_site_search_engine_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_get_site_search_engine_async.py index 4ad59e2991fa..d41a9c53252a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_get_site_search_engine_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_get_site_search_engine_async.py @@ -49,5 +49,4 @@ async def sample_get_site_search_engine(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_GetSiteSearchEngine_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_get_site_search_engine_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_get_site_search_engine_sync.py index 728d6d105f14..f29957d3d953 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_get_site_search_engine_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_get_site_search_engine_sync.py @@ -49,5 +49,4 @@ def sample_get_site_search_engine(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_GetSiteSearchEngine_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_get_target_site_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_get_target_site_async.py index 922fcd292e13..92543a394fdd 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_get_target_site_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_get_target_site_async.py @@ -49,5 +49,4 @@ async def sample_get_target_site(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_GetTargetSite_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_get_target_site_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_get_target_site_sync.py index 4090f18e38e6..0d0d40c3dd70 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_get_target_site_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_get_target_site_sync.py @@ -49,5 +49,4 @@ def sample_get_target_site(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_GetTargetSite_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_list_target_sites_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_list_target_sites_async.py index b6bb05efd9ec..7ad2df79e32d 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_list_target_sites_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_list_target_sites_async.py @@ -50,5 +50,4 @@ async def sample_list_target_sites(): async for response in page_result: print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_ListTargetSites_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_list_target_sites_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_list_target_sites_sync.py index 5877fd250660..7ddd7c19a380 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_list_target_sites_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_list_target_sites_sync.py @@ -50,5 +50,4 @@ def sample_list_target_sites(): for response in page_result: print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_ListTargetSites_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_recrawl_uris_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_recrawl_uris_async.py index 40446fd1a4bd..78b909922713 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_recrawl_uris_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_recrawl_uris_async.py @@ -41,7 +41,7 @@ async def sample_recrawl_uris(): # Initialize request argument(s) request = discoveryengine_v1.RecrawlUrisRequest( site_search_engine="site_search_engine_value", - uris=["uris_value1", "uris_value2"], + uris=['uris_value1', 'uris_value2'], ) # Make the request @@ -54,5 +54,4 @@ async def sample_recrawl_uris(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_RecrawlUris_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_recrawl_uris_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_recrawl_uris_sync.py index 036a3956adfb..79c32790f949 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_recrawl_uris_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_recrawl_uris_sync.py @@ -41,7 +41,7 @@ def sample_recrawl_uris(): # Initialize request argument(s) request = discoveryengine_v1.RecrawlUrisRequest( site_search_engine="site_search_engine_value", - uris=["uris_value1", "uris_value2"], + uris=['uris_value1', 'uris_value2'], ) # Make the request @@ -54,5 +54,4 @@ def sample_recrawl_uris(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_RecrawlUris_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_update_target_site_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_update_target_site_async.py index ad5fdb06da54..d0d95779eeb4 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_update_target_site_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_update_target_site_async.py @@ -56,5 +56,4 @@ async def sample_update_target_site(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_UpdateTargetSite_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_update_target_site_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_update_target_site_sync.py index e244b865d51e..58293fcbac8b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_update_target_site_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_site_search_engine_service_update_target_site_sync.py @@ -56,5 +56,4 @@ def sample_update_target_site(): # Handle the response print(response) - # [END discoveryengine_v1_generated_SiteSearchEngineService_UpdateTargetSite_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_collect_user_event_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_collect_user_event_async.py index 609a4a0daaa2..255230d2f355 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_collect_user_event_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_collect_user_event_async.py @@ -50,5 +50,4 @@ async def sample_collect_user_event(): # Handle the response print(response) - # [END discoveryengine_v1_generated_UserEventService_CollectUserEvent_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_collect_user_event_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_collect_user_event_sync.py index 57198a7b706c..9b8797b755bf 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_collect_user_event_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_collect_user_event_sync.py @@ -50,5 +50,4 @@ def sample_collect_user_event(): # Handle the response print(response) - # [END discoveryengine_v1_generated_UserEventService_CollectUserEvent_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_import_user_events_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_import_user_events_async.py index e1b85b67639d..e5ba83b750d5 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_import_user_events_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_import_user_events_async.py @@ -58,5 +58,4 @@ async def sample_import_user_events(): # Handle the response print(response) - # [END discoveryengine_v1_generated_UserEventService_ImportUserEvents_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_import_user_events_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_import_user_events_sync.py index 36ebea275ab2..71bc98fe3427 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_import_user_events_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_import_user_events_sync.py @@ -58,5 +58,4 @@ def sample_import_user_events(): # Handle the response print(response) - # [END discoveryengine_v1_generated_UserEventService_ImportUserEvents_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_purge_user_events_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_purge_user_events_async.py index 08ead898588a..a21882b03db6 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_purge_user_events_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_purge_user_events_async.py @@ -54,5 +54,4 @@ async def sample_purge_user_events(): # Handle the response print(response) - # [END discoveryengine_v1_generated_UserEventService_PurgeUserEvents_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_purge_user_events_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_purge_user_events_sync.py index bda5de3d3e38..26bc9c9643a3 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_purge_user_events_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_purge_user_events_sync.py @@ -54,5 +54,4 @@ def sample_purge_user_events(): # Handle the response print(response) - # [END discoveryengine_v1_generated_UserEventService_PurgeUserEvents_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_write_user_event_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_write_user_event_async.py index 3a032d286d58..9764d8005606 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_write_user_event_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_write_user_event_async.py @@ -49,5 +49,4 @@ async def sample_write_user_event(): # Handle the response print(response) - # [END discoveryengine_v1_generated_UserEventService_WriteUserEvent_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_write_user_event_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_write_user_event_sync.py index 8c438e01438d..88a7a892bab1 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_write_user_event_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_event_service_write_user_event_sync.py @@ -49,5 +49,4 @@ def sample_write_user_event(): # Handle the response print(response) - # [END discoveryengine_v1_generated_UserEventService_WriteUserEvent_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_license_service_batch_update_user_licenses_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_license_service_batch_update_user_licenses_async.py index 2a9c9aca8acd..258d3daa4955 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_license_service_batch_update_user_licenses_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_license_service_batch_update_user_licenses_async.py @@ -57,5 +57,4 @@ async def sample_batch_update_user_licenses(): # Handle the response print(response) - # [END discoveryengine_v1_generated_UserLicenseService_BatchUpdateUserLicenses_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_license_service_batch_update_user_licenses_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_license_service_batch_update_user_licenses_sync.py index c64cbf098904..1690193a7ccc 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_license_service_batch_update_user_licenses_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_license_service_batch_update_user_licenses_sync.py @@ -57,5 +57,4 @@ def sample_batch_update_user_licenses(): # Handle the response print(response) - # [END discoveryengine_v1_generated_UserLicenseService_BatchUpdateUserLicenses_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_license_service_list_user_licenses_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_license_service_list_user_licenses_async.py index e5319a6a3bbe..f3d926dd18d4 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_license_service_list_user_licenses_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_license_service_list_user_licenses_async.py @@ -50,5 +50,4 @@ async def sample_list_user_licenses(): async for response in page_result: print(response) - # [END discoveryengine_v1_generated_UserLicenseService_ListUserLicenses_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_license_service_list_user_licenses_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_license_service_list_user_licenses_sync.py index 872a23f2e54e..8725be65c4ed 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_license_service_list_user_licenses_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1_generated_user_license_service_list_user_licenses_sync.py @@ -50,5 +50,4 @@ def sample_list_user_licenses(): for response in page_result: print(response) - # [END discoveryengine_v1_generated_UserLicenseService_ListUserLicenses_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_acl_config_service_get_acl_config_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_acl_config_service_get_acl_config_async.py index 293b4d0a3f40..08b422fae73d 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_acl_config_service_get_acl_config_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_acl_config_service_get_acl_config_async.py @@ -49,5 +49,4 @@ async def sample_get_acl_config(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_AclConfigService_GetAclConfig_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_acl_config_service_get_acl_config_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_acl_config_service_get_acl_config_sync.py index 0392460b8bc6..a838044d642b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_acl_config_service_get_acl_config_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_acl_config_service_get_acl_config_sync.py @@ -49,5 +49,4 @@ def sample_get_acl_config(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_AclConfigService_GetAclConfig_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_acl_config_service_update_acl_config_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_acl_config_service_update_acl_config_async.py index 6430025f65f8..11c6b61c1500 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_acl_config_service_update_acl_config_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_acl_config_service_update_acl_config_async.py @@ -39,7 +39,8 @@ async def sample_update_acl_config(): client = discoveryengine_v1alpha.AclConfigServiceAsyncClient() # Initialize request argument(s) - request = discoveryengine_v1alpha.UpdateAclConfigRequest() + request = discoveryengine_v1alpha.UpdateAclConfigRequest( + ) # Make the request response = await client.update_acl_config(request=request) @@ -47,5 +48,4 @@ async def sample_update_acl_config(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_AclConfigService_UpdateAclConfig_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_acl_config_service_update_acl_config_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_acl_config_service_update_acl_config_sync.py index be064e1d0a28..32451c9b9a5e 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_acl_config_service_update_acl_config_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_acl_config_service_update_acl_config_sync.py @@ -39,7 +39,8 @@ def sample_update_acl_config(): client = discoveryengine_v1alpha.AclConfigServiceClient() # Initialize request argument(s) - request = discoveryengine_v1alpha.UpdateAclConfigRequest() + request = discoveryengine_v1alpha.UpdateAclConfigRequest( + ) # Make the request response = client.update_acl_config(request=request) @@ -47,5 +48,4 @@ def sample_update_acl_config(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_AclConfigService_UpdateAclConfig_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_chunk_service_get_chunk_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_chunk_service_get_chunk_async.py index 70964109e0e2..5924ffe13b21 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_chunk_service_get_chunk_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_chunk_service_get_chunk_async.py @@ -49,5 +49,4 @@ async def sample_get_chunk(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ChunkService_GetChunk_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_chunk_service_get_chunk_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_chunk_service_get_chunk_sync.py index 6b0cfe32ad6b..f4fca2998feb 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_chunk_service_get_chunk_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_chunk_service_get_chunk_sync.py @@ -49,5 +49,4 @@ def sample_get_chunk(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ChunkService_GetChunk_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_chunk_service_list_chunks_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_chunk_service_list_chunks_async.py index f239b4049375..a409d4ec400a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_chunk_service_list_chunks_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_chunk_service_list_chunks_async.py @@ -50,5 +50,4 @@ async def sample_list_chunks(): async for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_ChunkService_ListChunks_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_chunk_service_list_chunks_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_chunk_service_list_chunks_sync.py index 69deb89dce04..7b98c0cfaacc 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_chunk_service_list_chunks_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_chunk_service_list_chunks_sync.py @@ -50,5 +50,4 @@ def sample_list_chunks(): for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_ChunkService_ListChunks_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_complete_query_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_complete_query_async.py index 8b8e7bb160bc..78df569fc36e 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_complete_query_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_complete_query_async.py @@ -50,5 +50,4 @@ async def sample_complete_query(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_CompletionService_CompleteQuery_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_complete_query_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_complete_query_sync.py index 0be3ddcb415f..3cf6b0957eaf 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_complete_query_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_complete_query_sync.py @@ -50,5 +50,4 @@ def sample_complete_query(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_CompletionService_CompleteQuery_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_import_completion_suggestions_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_import_completion_suggestions_async.py index 3aa6b0e171f1..299025818589 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_import_completion_suggestions_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_import_completion_suggestions_async.py @@ -58,5 +58,4 @@ async def sample_import_completion_suggestions(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_CompletionService_ImportCompletionSuggestions_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_import_completion_suggestions_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_import_completion_suggestions_sync.py index b2da816ede1f..789ad8405854 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_import_completion_suggestions_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_import_completion_suggestions_sync.py @@ -58,5 +58,4 @@ def sample_import_completion_suggestions(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_CompletionService_ImportCompletionSuggestions_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_import_suggestion_deny_list_entries_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_import_suggestion_deny_list_entries_async.py index 30103543fcca..7f96cc49a544 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_import_suggestion_deny_list_entries_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_import_suggestion_deny_list_entries_async.py @@ -58,5 +58,4 @@ async def sample_import_suggestion_deny_list_entries(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_CompletionService_ImportSuggestionDenyListEntries_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_import_suggestion_deny_list_entries_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_import_suggestion_deny_list_entries_sync.py index 3d6d9974ca16..e79aa227b39f 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_import_suggestion_deny_list_entries_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_import_suggestion_deny_list_entries_sync.py @@ -58,5 +58,4 @@ def sample_import_suggestion_deny_list_entries(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_CompletionService_ImportSuggestionDenyListEntries_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_purge_completion_suggestions_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_purge_completion_suggestions_async.py index 4df69df59090..0ee9676fce9c 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_purge_completion_suggestions_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_purge_completion_suggestions_async.py @@ -53,5 +53,4 @@ async def sample_purge_completion_suggestions(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_CompletionService_PurgeCompletionSuggestions_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_purge_completion_suggestions_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_purge_completion_suggestions_sync.py index d8f3e408f3a5..46928f565d0b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_purge_completion_suggestions_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_purge_completion_suggestions_sync.py @@ -53,5 +53,4 @@ def sample_purge_completion_suggestions(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_CompletionService_PurgeCompletionSuggestions_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_purge_suggestion_deny_list_entries_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_purge_suggestion_deny_list_entries_async.py index ee6b260f61ee..d7a55218cbd4 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_purge_suggestion_deny_list_entries_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_purge_suggestion_deny_list_entries_async.py @@ -53,5 +53,4 @@ async def sample_purge_suggestion_deny_list_entries(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_CompletionService_PurgeSuggestionDenyListEntries_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_purge_suggestion_deny_list_entries_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_purge_suggestion_deny_list_entries_sync.py index 2d3fe86d1654..cc6921ec8162 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_purge_suggestion_deny_list_entries_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_completion_service_purge_suggestion_deny_list_entries_sync.py @@ -53,5 +53,4 @@ def sample_purge_suggestion_deny_list_entries(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_CompletionService_PurgeSuggestionDenyListEntries_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_create_control_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_create_control_async.py index a6e357be713e..531accd44b2a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_create_control_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_create_control_async.py @@ -58,5 +58,4 @@ async def sample_create_control(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ControlService_CreateControl_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_create_control_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_create_control_sync.py index 9e258d889ed7..2025cc7dfd81 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_create_control_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_create_control_sync.py @@ -58,5 +58,4 @@ def sample_create_control(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ControlService_CreateControl_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_get_control_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_get_control_async.py index b433852835a3..a0ae2f8eb739 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_get_control_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_get_control_async.py @@ -49,5 +49,4 @@ async def sample_get_control(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ControlService_GetControl_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_get_control_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_get_control_sync.py index f2fe2a6e73fd..10f98875e2a7 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_get_control_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_get_control_sync.py @@ -49,5 +49,4 @@ def sample_get_control(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ControlService_GetControl_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_list_controls_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_list_controls_async.py index bf649d34413a..d49a128d46dc 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_list_controls_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_list_controls_async.py @@ -50,5 +50,4 @@ async def sample_list_controls(): async for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_ControlService_ListControls_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_list_controls_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_list_controls_sync.py index 0189c2ace8cc..ac09ede38ba2 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_list_controls_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_list_controls_sync.py @@ -50,5 +50,4 @@ def sample_list_controls(): for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_ControlService_ListControls_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_update_control_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_update_control_async.py index 3aae1cdab4dc..246621786e7b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_update_control_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_update_control_async.py @@ -56,5 +56,4 @@ async def sample_update_control(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ControlService_UpdateControl_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_update_control_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_update_control_sync.py index 24473f4c419c..6e7cace54ebe 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_update_control_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_control_service_update_control_sync.py @@ -56,5 +56,4 @@ def sample_update_control(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ControlService_UpdateControl_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_answer_query_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_answer_query_async.py index d0a4393ca8fc..f6b541105ec1 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_answer_query_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_answer_query_async.py @@ -53,5 +53,4 @@ async def sample_answer_query(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ConversationalSearchService_AnswerQuery_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_answer_query_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_answer_query_sync.py index 646b714c48f9..ff0185f2995c 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_answer_query_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_answer_query_sync.py @@ -53,5 +53,4 @@ def sample_answer_query(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ConversationalSearchService_AnswerQuery_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_converse_conversation_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_converse_conversation_async.py index 35ce408fd105..579d09f6734a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_converse_conversation_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_converse_conversation_async.py @@ -49,5 +49,4 @@ async def sample_converse_conversation(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ConversationalSearchService_ConverseConversation_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_converse_conversation_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_converse_conversation_sync.py index 09f921772cae..06293019a5a6 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_converse_conversation_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_converse_conversation_sync.py @@ -49,5 +49,4 @@ def sample_converse_conversation(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ConversationalSearchService_ConverseConversation_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_create_conversation_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_create_conversation_async.py index adf3cc4368ba..bbeb731046a1 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_create_conversation_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_create_conversation_async.py @@ -49,5 +49,4 @@ async def sample_create_conversation(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ConversationalSearchService_CreateConversation_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_create_conversation_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_create_conversation_sync.py index 283d89bdf845..d91de64be2de 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_create_conversation_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_create_conversation_sync.py @@ -49,5 +49,4 @@ def sample_create_conversation(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ConversationalSearchService_CreateConversation_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_create_session_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_create_session_async.py index 2938fe80ebf2..5b905cbb49c9 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_create_session_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_create_session_async.py @@ -49,5 +49,4 @@ async def sample_create_session(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ConversationalSearchService_CreateSession_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_create_session_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_create_session_sync.py index 43c60f4c6138..083420bad0ae 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_create_session_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_create_session_sync.py @@ -49,5 +49,4 @@ def sample_create_session(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ConversationalSearchService_CreateSession_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_get_answer_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_get_answer_async.py index b84861764e03..059725862240 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_get_answer_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_get_answer_async.py @@ -49,5 +49,4 @@ async def sample_get_answer(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ConversationalSearchService_GetAnswer_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_get_answer_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_get_answer_sync.py index df9c21b0af9a..5e9943283a2e 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_get_answer_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_get_answer_sync.py @@ -49,5 +49,4 @@ def sample_get_answer(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ConversationalSearchService_GetAnswer_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_get_conversation_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_get_conversation_async.py index 766745f528ee..545073d77c9e 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_get_conversation_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_get_conversation_async.py @@ -49,5 +49,4 @@ async def sample_get_conversation(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ConversationalSearchService_GetConversation_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_get_conversation_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_get_conversation_sync.py index 876995ce0aff..582718ac7d0d 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_get_conversation_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_get_conversation_sync.py @@ -49,5 +49,4 @@ def sample_get_conversation(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ConversationalSearchService_GetConversation_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_get_session_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_get_session_async.py index 3a6d6c98efd3..104bf05a0e70 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_get_session_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_get_session_async.py @@ -49,5 +49,4 @@ async def sample_get_session(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ConversationalSearchService_GetSession_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_get_session_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_get_session_sync.py index 41561434441e..c2bab00901ce 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_get_session_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_get_session_sync.py @@ -49,5 +49,4 @@ def sample_get_session(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ConversationalSearchService_GetSession_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_list_conversations_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_list_conversations_async.py index 7d85a14916c5..0f6b5893b613 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_list_conversations_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_list_conversations_async.py @@ -50,5 +50,4 @@ async def sample_list_conversations(): async for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_ConversationalSearchService_ListConversations_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_list_conversations_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_list_conversations_sync.py index b55645c95d33..6e9c15b9b612 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_list_conversations_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_list_conversations_sync.py @@ -50,5 +50,4 @@ def sample_list_conversations(): for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_ConversationalSearchService_ListConversations_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_list_sessions_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_list_sessions_async.py index f8a5ef392850..718b1fc62385 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_list_sessions_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_list_sessions_async.py @@ -50,5 +50,4 @@ async def sample_list_sessions(): async for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_ConversationalSearchService_ListSessions_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_list_sessions_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_list_sessions_sync.py index d4f750e75f56..31473f096f65 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_list_sessions_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_list_sessions_sync.py @@ -50,5 +50,4 @@ def sample_list_sessions(): for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_ConversationalSearchService_ListSessions_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_update_conversation_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_update_conversation_async.py index 1a172b8dc9bd..ce21b791c778 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_update_conversation_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_update_conversation_async.py @@ -39,7 +39,8 @@ async def sample_update_conversation(): client = discoveryengine_v1alpha.ConversationalSearchServiceAsyncClient() # Initialize request argument(s) - request = discoveryengine_v1alpha.UpdateConversationRequest() + request = discoveryengine_v1alpha.UpdateConversationRequest( + ) # Make the request response = await client.update_conversation(request=request) @@ -47,5 +48,4 @@ async def sample_update_conversation(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ConversationalSearchService_UpdateConversation_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_update_conversation_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_update_conversation_sync.py index 490b91e8a503..1ec187286af1 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_update_conversation_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_update_conversation_sync.py @@ -39,7 +39,8 @@ def sample_update_conversation(): client = discoveryengine_v1alpha.ConversationalSearchServiceClient() # Initialize request argument(s) - request = discoveryengine_v1alpha.UpdateConversationRequest() + request = discoveryengine_v1alpha.UpdateConversationRequest( + ) # Make the request response = client.update_conversation(request=request) @@ -47,5 +48,4 @@ def sample_update_conversation(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ConversationalSearchService_UpdateConversation_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_update_session_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_update_session_async.py index 5a6926c74e72..6a99a17ba6b8 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_update_session_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_update_session_async.py @@ -39,7 +39,8 @@ async def sample_update_session(): client = discoveryengine_v1alpha.ConversationalSearchServiceAsyncClient() # Initialize request argument(s) - request = discoveryengine_v1alpha.UpdateSessionRequest() + request = discoveryengine_v1alpha.UpdateSessionRequest( + ) # Make the request response = await client.update_session(request=request) @@ -47,5 +48,4 @@ async def sample_update_session(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ConversationalSearchService_UpdateSession_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_update_session_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_update_session_sync.py index 4cddc08de6d2..ea1d0de14d43 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_update_session_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_conversational_search_service_update_session_sync.py @@ -39,7 +39,8 @@ def sample_update_session(): client = discoveryengine_v1alpha.ConversationalSearchServiceClient() # Initialize request argument(s) - request = discoveryengine_v1alpha.UpdateSessionRequest() + request = discoveryengine_v1alpha.UpdateSessionRequest( + ) # Make the request response = client.update_session(request=request) @@ -47,5 +48,4 @@ def sample_update_session(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ConversationalSearchService_UpdateSession_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_create_data_store_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_create_data_store_async.py index 6fd3378e2c2a..5f5e76f25f01 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_create_data_store_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_create_data_store_async.py @@ -58,5 +58,4 @@ async def sample_create_data_store(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_DataStoreService_CreateDataStore_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_create_data_store_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_create_data_store_sync.py index fff58e49a35d..5185ba0a63be 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_create_data_store_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_create_data_store_sync.py @@ -58,5 +58,4 @@ def sample_create_data_store(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_DataStoreService_CreateDataStore_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_delete_data_store_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_delete_data_store_async.py index c61afc17c242..07a30abe7f49 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_delete_data_store_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_delete_data_store_async.py @@ -53,5 +53,4 @@ async def sample_delete_data_store(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_DataStoreService_DeleteDataStore_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_delete_data_store_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_delete_data_store_sync.py index b8a1befcaf56..136a40bd54ce 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_delete_data_store_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_delete_data_store_sync.py @@ -53,5 +53,4 @@ def sample_delete_data_store(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_DataStoreService_DeleteDataStore_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_get_data_store_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_get_data_store_async.py index db2b701e0233..11cbf22535aa 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_get_data_store_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_get_data_store_async.py @@ -49,5 +49,4 @@ async def sample_get_data_store(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_DataStoreService_GetDataStore_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_get_data_store_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_get_data_store_sync.py index 27b0fc5158c9..b17f6ec0c769 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_get_data_store_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_get_data_store_sync.py @@ -49,5 +49,4 @@ def sample_get_data_store(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_DataStoreService_GetDataStore_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_get_document_processing_config_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_get_document_processing_config_async.py index e8685bdff920..4ff1b0de7bee 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_get_document_processing_config_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_get_document_processing_config_async.py @@ -49,5 +49,4 @@ async def sample_get_document_processing_config(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_DataStoreService_GetDocumentProcessingConfig_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_get_document_processing_config_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_get_document_processing_config_sync.py index aadc5db45d6a..fe9d48f18b28 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_get_document_processing_config_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_get_document_processing_config_sync.py @@ -49,5 +49,4 @@ def sample_get_document_processing_config(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_DataStoreService_GetDocumentProcessingConfig_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_list_data_stores_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_list_data_stores_async.py index 9241629a452b..1cbea0a42dc4 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_list_data_stores_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_list_data_stores_async.py @@ -50,5 +50,4 @@ async def sample_list_data_stores(): async for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_DataStoreService_ListDataStores_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_list_data_stores_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_list_data_stores_sync.py index 7c23b42d668a..52a1f4475a14 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_list_data_stores_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_list_data_stores_sync.py @@ -50,5 +50,4 @@ def sample_list_data_stores(): for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_DataStoreService_ListDataStores_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_update_data_store_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_update_data_store_async.py index 7521b0be7b62..7a581d7312c6 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_update_data_store_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_update_data_store_async.py @@ -52,5 +52,4 @@ async def sample_update_data_store(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_DataStoreService_UpdateDataStore_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_update_data_store_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_update_data_store_sync.py index 86a08c168d41..d399e5455460 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_update_data_store_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_update_data_store_sync.py @@ -52,5 +52,4 @@ def sample_update_data_store(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_DataStoreService_UpdateDataStore_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_update_document_processing_config_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_update_document_processing_config_async.py index b853890f6184..33c3cda7ee92 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_update_document_processing_config_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_update_document_processing_config_async.py @@ -39,7 +39,8 @@ async def sample_update_document_processing_config(): client = discoveryengine_v1alpha.DataStoreServiceAsyncClient() # Initialize request argument(s) - request = discoveryengine_v1alpha.UpdateDocumentProcessingConfigRequest() + request = discoveryengine_v1alpha.UpdateDocumentProcessingConfigRequest( + ) # Make the request response = await client.update_document_processing_config(request=request) @@ -47,5 +48,4 @@ async def sample_update_document_processing_config(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_DataStoreService_UpdateDocumentProcessingConfig_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_update_document_processing_config_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_update_document_processing_config_sync.py index 008a3818b4ea..f5a5075ed875 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_update_document_processing_config_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_data_store_service_update_document_processing_config_sync.py @@ -39,7 +39,8 @@ def sample_update_document_processing_config(): client = discoveryengine_v1alpha.DataStoreServiceClient() # Initialize request argument(s) - request = discoveryengine_v1alpha.UpdateDocumentProcessingConfigRequest() + request = discoveryengine_v1alpha.UpdateDocumentProcessingConfigRequest( + ) # Make the request response = client.update_document_processing_config(request=request) @@ -47,5 +48,4 @@ def sample_update_document_processing_config(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_DataStoreService_UpdateDocumentProcessingConfig_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_batch_get_documents_metadata_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_batch_get_documents_metadata_async.py index 9c96cd90fbbf..e0c9cee79393 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_batch_get_documents_metadata_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_batch_get_documents_metadata_async.py @@ -49,5 +49,4 @@ async def sample_batch_get_documents_metadata(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_DocumentService_BatchGetDocumentsMetadata_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_batch_get_documents_metadata_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_batch_get_documents_metadata_sync.py index 28b04ffeacf3..e711de271571 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_batch_get_documents_metadata_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_batch_get_documents_metadata_sync.py @@ -49,5 +49,4 @@ def sample_batch_get_documents_metadata(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_DocumentService_BatchGetDocumentsMetadata_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_create_document_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_create_document_async.py index 83edc76738c4..a5be705daa1d 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_create_document_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_create_document_async.py @@ -50,5 +50,4 @@ async def sample_create_document(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_DocumentService_CreateDocument_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_create_document_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_create_document_sync.py index 87b62d117fac..3fda0a6d5038 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_create_document_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_create_document_sync.py @@ -50,5 +50,4 @@ def sample_create_document(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_DocumentService_CreateDocument_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_get_document_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_get_document_async.py index 5e2bf7fd2920..ead4203f4126 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_get_document_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_get_document_async.py @@ -49,5 +49,4 @@ async def sample_get_document(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_DocumentService_GetDocument_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_get_document_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_get_document_sync.py index be3926abd83b..6f63b5ceab12 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_get_document_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_get_document_sync.py @@ -49,5 +49,4 @@ def sample_get_document(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_DocumentService_GetDocument_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_get_processed_document_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_get_processed_document_async.py index db74306fd49b..6f92efe7eab4 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_get_processed_document_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_get_processed_document_async.py @@ -50,5 +50,4 @@ async def sample_get_processed_document(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_DocumentService_GetProcessedDocument_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_get_processed_document_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_get_processed_document_sync.py index 1079943cac83..ff6f50816d03 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_get_processed_document_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_get_processed_document_sync.py @@ -50,5 +50,4 @@ def sample_get_processed_document(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_DocumentService_GetProcessedDocument_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_import_documents_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_import_documents_async.py index 5191690b57eb..a86589da47a4 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_import_documents_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_import_documents_async.py @@ -53,5 +53,4 @@ async def sample_import_documents(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_DocumentService_ImportDocuments_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_import_documents_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_import_documents_sync.py index eb13fece16c2..0593cb1fe7c7 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_import_documents_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_import_documents_sync.py @@ -53,5 +53,4 @@ def sample_import_documents(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_DocumentService_ImportDocuments_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_list_documents_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_list_documents_async.py index 7d217bb32977..3177f07e4a55 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_list_documents_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_list_documents_async.py @@ -50,5 +50,4 @@ async def sample_list_documents(): async for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_DocumentService_ListDocuments_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_list_documents_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_list_documents_sync.py index a5524247d540..b4913ef722e4 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_list_documents_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_list_documents_sync.py @@ -50,5 +50,4 @@ def sample_list_documents(): for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_DocumentService_ListDocuments_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_purge_documents_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_purge_documents_async.py index 6370c5231d35..f5acef3e5a0f 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_purge_documents_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_purge_documents_async.py @@ -40,7 +40,7 @@ async def sample_purge_documents(): # Initialize request argument(s) gcs_source = discoveryengine_v1alpha.GcsSource() - gcs_source.input_uris = ["input_uris_value1", "input_uris_value2"] + gcs_source.input_uris = ['input_uris_value1', 'input_uris_value2'] request = discoveryengine_v1alpha.PurgeDocumentsRequest( gcs_source=gcs_source, @@ -58,5 +58,4 @@ async def sample_purge_documents(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_DocumentService_PurgeDocuments_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_purge_documents_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_purge_documents_sync.py index 8b48d08da6ab..49edab74f2dd 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_purge_documents_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_purge_documents_sync.py @@ -40,7 +40,7 @@ def sample_purge_documents(): # Initialize request argument(s) gcs_source = discoveryengine_v1alpha.GcsSource() - gcs_source.input_uris = ["input_uris_value1", "input_uris_value2"] + gcs_source.input_uris = ['input_uris_value1', 'input_uris_value2'] request = discoveryengine_v1alpha.PurgeDocumentsRequest( gcs_source=gcs_source, @@ -58,5 +58,4 @@ def sample_purge_documents(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_DocumentService_PurgeDocuments_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_update_document_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_update_document_async.py index 8bb843266ba3..63b83cf4be30 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_update_document_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_update_document_async.py @@ -39,7 +39,8 @@ async def sample_update_document(): client = discoveryengine_v1alpha.DocumentServiceAsyncClient() # Initialize request argument(s) - request = discoveryengine_v1alpha.UpdateDocumentRequest() + request = discoveryengine_v1alpha.UpdateDocumentRequest( + ) # Make the request response = await client.update_document(request=request) @@ -47,5 +48,4 @@ async def sample_update_document(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_DocumentService_UpdateDocument_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_update_document_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_update_document_sync.py index 0fa46dcc411c..776f2396e742 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_update_document_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_document_service_update_document_sync.py @@ -39,7 +39,8 @@ def sample_update_document(): client = discoveryengine_v1alpha.DocumentServiceClient() # Initialize request argument(s) - request = discoveryengine_v1alpha.UpdateDocumentRequest() + request = discoveryengine_v1alpha.UpdateDocumentRequest( + ) # Make the request response = client.update_document(request=request) @@ -47,5 +48,4 @@ def sample_update_document(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_DocumentService_UpdateDocument_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_create_engine_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_create_engine_async.py index 415e4632cc08..7d6901b470ce 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_create_engine_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_create_engine_async.py @@ -59,5 +59,4 @@ async def sample_create_engine(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_EngineService_CreateEngine_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_create_engine_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_create_engine_sync.py index 073f45ca6ab6..fca916d82996 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_create_engine_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_create_engine_sync.py @@ -59,5 +59,4 @@ def sample_create_engine(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_EngineService_CreateEngine_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_delete_engine_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_delete_engine_async.py index d67dad89a07e..939aa92759a0 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_delete_engine_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_delete_engine_async.py @@ -53,5 +53,4 @@ async def sample_delete_engine(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_EngineService_DeleteEngine_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_delete_engine_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_delete_engine_sync.py index 9d848e136e03..c0db0f140722 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_delete_engine_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_delete_engine_sync.py @@ -53,5 +53,4 @@ def sample_delete_engine(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_EngineService_DeleteEngine_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_get_engine_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_get_engine_async.py index abfc2eca55bf..ce5d51f59bff 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_get_engine_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_get_engine_async.py @@ -49,5 +49,4 @@ async def sample_get_engine(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_EngineService_GetEngine_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_get_engine_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_get_engine_sync.py index 6638bba1b3d3..093996ac16ca 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_get_engine_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_get_engine_sync.py @@ -49,5 +49,4 @@ def sample_get_engine(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_EngineService_GetEngine_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_list_engines_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_list_engines_async.py index b7ee7d756bf6..022249aa6c78 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_list_engines_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_list_engines_async.py @@ -50,5 +50,4 @@ async def sample_list_engines(): async for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_EngineService_ListEngines_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_list_engines_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_list_engines_sync.py index 0525532cfb3f..b20a7b0422ed 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_list_engines_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_list_engines_sync.py @@ -50,5 +50,4 @@ def sample_list_engines(): for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_EngineService_ListEngines_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_pause_engine_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_pause_engine_async.py index 1436c12cd0fa..d6409063e00a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_pause_engine_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_pause_engine_async.py @@ -49,5 +49,4 @@ async def sample_pause_engine(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_EngineService_PauseEngine_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_pause_engine_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_pause_engine_sync.py index 2da8b5129ff1..a5e275b1488c 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_pause_engine_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_pause_engine_sync.py @@ -49,5 +49,4 @@ def sample_pause_engine(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_EngineService_PauseEngine_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_resume_engine_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_resume_engine_async.py index 1e202034f0a2..39bbeaea8852 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_resume_engine_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_resume_engine_async.py @@ -49,5 +49,4 @@ async def sample_resume_engine(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_EngineService_ResumeEngine_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_resume_engine_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_resume_engine_sync.py index c40a43128d9f..7e7d733f5961 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_resume_engine_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_resume_engine_sync.py @@ -49,5 +49,4 @@ def sample_resume_engine(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_EngineService_ResumeEngine_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_tune_engine_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_tune_engine_async.py index 5c75147411e6..20385b004ff2 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_tune_engine_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_tune_engine_async.py @@ -53,5 +53,4 @@ async def sample_tune_engine(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_EngineService_TuneEngine_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_tune_engine_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_tune_engine_sync.py index 938238939249..1b4cbb27efeb 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_tune_engine_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_tune_engine_sync.py @@ -53,5 +53,4 @@ def sample_tune_engine(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_EngineService_TuneEngine_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_update_engine_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_update_engine_async.py index 69e1d3f64738..5d37e6ae178a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_update_engine_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_update_engine_async.py @@ -53,5 +53,4 @@ async def sample_update_engine(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_EngineService_UpdateEngine_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_update_engine_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_update_engine_sync.py index b9df1182c0e6..1daeb4dcd96f 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_update_engine_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_engine_service_update_engine_sync.py @@ -53,5 +53,4 @@ def sample_update_engine(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_EngineService_UpdateEngine_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_estimate_billing_service_estimate_data_size_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_estimate_billing_service_estimate_data_size_async.py index 32aa64253d7c..54d77b4f65a1 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_estimate_billing_service_estimate_data_size_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_estimate_billing_service_estimate_data_size_async.py @@ -53,5 +53,4 @@ async def sample_estimate_data_size(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_EstimateBillingService_EstimateDataSize_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_estimate_billing_service_estimate_data_size_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_estimate_billing_service_estimate_data_size_sync.py index e1777c322f2a..463c6f288913 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_estimate_billing_service_estimate_data_size_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_estimate_billing_service_estimate_data_size_sync.py @@ -53,5 +53,4 @@ def sample_estimate_data_size(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_EstimateBillingService_EstimateDataSize_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_create_evaluation_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_create_evaluation_async.py index 5fcb5543a1ce..6e82cfa98969 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_create_evaluation_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_create_evaluation_async.py @@ -41,9 +41,7 @@ async def sample_create_evaluation(): # Initialize request argument(s) evaluation = discoveryengine_v1alpha.Evaluation() evaluation.evaluation_spec.search_request.serving_config = "serving_config_value" - evaluation.evaluation_spec.query_set_spec.sample_query_set = ( - "sample_query_set_value" - ) + evaluation.evaluation_spec.query_set_spec.sample_query_set = "sample_query_set_value" request = discoveryengine_v1alpha.CreateEvaluationRequest( parent="parent_value", @@ -60,5 +58,4 @@ async def sample_create_evaluation(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_EvaluationService_CreateEvaluation_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_create_evaluation_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_create_evaluation_sync.py index 78fed03b65b0..ba9640ba9522 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_create_evaluation_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_create_evaluation_sync.py @@ -41,9 +41,7 @@ def sample_create_evaluation(): # Initialize request argument(s) evaluation = discoveryengine_v1alpha.Evaluation() evaluation.evaluation_spec.search_request.serving_config = "serving_config_value" - evaluation.evaluation_spec.query_set_spec.sample_query_set = ( - "sample_query_set_value" - ) + evaluation.evaluation_spec.query_set_spec.sample_query_set = "sample_query_set_value" request = discoveryengine_v1alpha.CreateEvaluationRequest( parent="parent_value", @@ -60,5 +58,4 @@ def sample_create_evaluation(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_EvaluationService_CreateEvaluation_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_get_evaluation_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_get_evaluation_async.py index 167b1e00c8cb..f95a701be525 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_get_evaluation_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_get_evaluation_async.py @@ -49,5 +49,4 @@ async def sample_get_evaluation(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_EvaluationService_GetEvaluation_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_get_evaluation_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_get_evaluation_sync.py index f02e082b8f45..f6ff957e324a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_get_evaluation_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_get_evaluation_sync.py @@ -49,5 +49,4 @@ def sample_get_evaluation(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_EvaluationService_GetEvaluation_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_list_evaluation_results_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_list_evaluation_results_async.py index c5a276f61f42..4288af4b667d 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_list_evaluation_results_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_list_evaluation_results_async.py @@ -50,5 +50,4 @@ async def sample_list_evaluation_results(): async for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_EvaluationService_ListEvaluationResults_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_list_evaluation_results_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_list_evaluation_results_sync.py index cb87980d8fec..848b3be9f56b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_list_evaluation_results_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_list_evaluation_results_sync.py @@ -50,5 +50,4 @@ def sample_list_evaluation_results(): for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_EvaluationService_ListEvaluationResults_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_list_evaluations_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_list_evaluations_async.py index d521256947f2..b51ab1b1ddf2 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_list_evaluations_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_list_evaluations_async.py @@ -50,5 +50,4 @@ async def sample_list_evaluations(): async for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_EvaluationService_ListEvaluations_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_list_evaluations_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_list_evaluations_sync.py index a04a933e08e0..0e90a4dd1db6 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_list_evaluations_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_evaluation_service_list_evaluations_sync.py @@ -50,5 +50,4 @@ def sample_list_evaluations(): for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_EvaluationService_ListEvaluations_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_grounded_generation_service_check_grounding_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_grounded_generation_service_check_grounding_async.py index f7e0f01aeb9d..08703e1da868 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_grounded_generation_service_check_grounding_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_grounded_generation_service_check_grounding_async.py @@ -49,5 +49,4 @@ async def sample_check_grounding(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_GroundedGenerationService_CheckGrounding_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_grounded_generation_service_check_grounding_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_grounded_generation_service_check_grounding_sync.py index 1cff75e7513e..600a4247c546 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_grounded_generation_service_check_grounding_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_grounded_generation_service_check_grounding_sync.py @@ -49,5 +49,4 @@ def sample_check_grounding(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_GroundedGenerationService_CheckGrounding_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_project_service_get_project_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_project_service_get_project_async.py index 333e26b6513b..fe56cd7dd76c 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_project_service_get_project_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_project_service_get_project_async.py @@ -49,5 +49,4 @@ async def sample_get_project(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ProjectService_GetProject_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_project_service_get_project_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_project_service_get_project_sync.py index d9bf316b8b98..2d844697a0b0 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_project_service_get_project_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_project_service_get_project_sync.py @@ -49,5 +49,4 @@ def sample_get_project(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ProjectService_GetProject_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_project_service_provision_project_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_project_service_provision_project_async.py index 2ecd0c00b19d..f2199124fe62 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_project_service_provision_project_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_project_service_provision_project_async.py @@ -55,5 +55,4 @@ async def sample_provision_project(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ProjectService_ProvisionProject_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_project_service_provision_project_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_project_service_provision_project_sync.py index 23194c4c45f2..b8d12e187b1f 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_project_service_provision_project_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_project_service_provision_project_sync.py @@ -55,5 +55,4 @@ def sample_provision_project(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ProjectService_ProvisionProject_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_project_service_report_consent_change_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_project_service_report_consent_change_async.py index 346d0f178892..f1c0f6ebf361 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_project_service_report_consent_change_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_project_service_report_consent_change_async.py @@ -52,5 +52,4 @@ async def sample_report_consent_change(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ProjectService_ReportConsentChange_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_project_service_report_consent_change_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_project_service_report_consent_change_sync.py index 9af2c0fd52b2..fbc73e70492a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_project_service_report_consent_change_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_project_service_report_consent_change_sync.py @@ -52,5 +52,4 @@ def sample_report_consent_change(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ProjectService_ReportConsentChange_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_rank_service_rank_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_rank_service_rank_async.py index cf5e0136660d..4c036535a45a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_rank_service_rank_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_rank_service_rank_async.py @@ -49,5 +49,4 @@ async def sample_rank(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_RankService_Rank_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_rank_service_rank_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_rank_service_rank_sync.py index 2a8041faa92f..2efed5396a0a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_rank_service_rank_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_rank_service_rank_sync.py @@ -49,5 +49,4 @@ def sample_rank(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_RankService_Rank_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_recommendation_service_recommend_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_recommendation_service_recommend_async.py index e94f5260fbf0..0ba782716381 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_recommendation_service_recommend_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_recommendation_service_recommend_async.py @@ -54,5 +54,4 @@ async def sample_recommend(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_RecommendationService_Recommend_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_recommendation_service_recommend_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_recommendation_service_recommend_sync.py index 26e98cdc2ac8..d28071625f38 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_recommendation_service_recommend_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_recommendation_service_recommend_sync.py @@ -54,5 +54,4 @@ def sample_recommend(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_RecommendationService_Recommend_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_create_sample_query_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_create_sample_query_async.py index 2b4f806c8482..0f214cc619cc 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_create_sample_query_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_create_sample_query_async.py @@ -54,5 +54,4 @@ async def sample_create_sample_query(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SampleQueryService_CreateSampleQuery_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_create_sample_query_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_create_sample_query_sync.py index 3d19939b6bc2..efef7323b224 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_create_sample_query_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_create_sample_query_sync.py @@ -54,5 +54,4 @@ def sample_create_sample_query(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SampleQueryService_CreateSampleQuery_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_get_sample_query_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_get_sample_query_async.py index 4582eaca0005..092eaa46168a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_get_sample_query_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_get_sample_query_async.py @@ -49,5 +49,4 @@ async def sample_get_sample_query(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SampleQueryService_GetSampleQuery_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_get_sample_query_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_get_sample_query_sync.py index bc0763770e95..e181cba1a494 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_get_sample_query_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_get_sample_query_sync.py @@ -49,5 +49,4 @@ def sample_get_sample_query(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SampleQueryService_GetSampleQuery_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_import_sample_queries_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_import_sample_queries_async.py index 70fdfd9674f4..3104e2480295 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_import_sample_queries_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_import_sample_queries_async.py @@ -57,5 +57,4 @@ async def sample_import_sample_queries(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SampleQueryService_ImportSampleQueries_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_import_sample_queries_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_import_sample_queries_sync.py index 3427e0f20830..4f7869681e29 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_import_sample_queries_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_import_sample_queries_sync.py @@ -57,5 +57,4 @@ def sample_import_sample_queries(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SampleQueryService_ImportSampleQueries_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_list_sample_queries_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_list_sample_queries_async.py index 420b3e36baa7..c8eb699e3ee1 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_list_sample_queries_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_list_sample_queries_async.py @@ -50,5 +50,4 @@ async def sample_list_sample_queries(): async for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_SampleQueryService_ListSampleQueries_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_list_sample_queries_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_list_sample_queries_sync.py index 391ce9a5bd32..660fa84281d1 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_list_sample_queries_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_list_sample_queries_sync.py @@ -50,5 +50,4 @@ def sample_list_sample_queries(): for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_SampleQueryService_ListSampleQueries_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_update_sample_query_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_update_sample_query_async.py index 05614896de02..a04b175ea83e 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_update_sample_query_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_update_sample_query_async.py @@ -52,5 +52,4 @@ async def sample_update_sample_query(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SampleQueryService_UpdateSampleQuery_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_update_sample_query_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_update_sample_query_sync.py index 990711aa8c70..e370eca65dff 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_update_sample_query_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_service_update_sample_query_sync.py @@ -52,5 +52,4 @@ def sample_update_sample_query(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SampleQueryService_UpdateSampleQuery_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_create_sample_query_set_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_create_sample_query_set_async.py index 4cbfc9a06764..cb6f0b4ca80a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_create_sample_query_set_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_create_sample_query_set_async.py @@ -54,5 +54,4 @@ async def sample_create_sample_query_set(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SampleQuerySetService_CreateSampleQuerySet_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_create_sample_query_set_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_create_sample_query_set_sync.py index a660c9077567..a633eace71fd 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_create_sample_query_set_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_create_sample_query_set_sync.py @@ -54,5 +54,4 @@ def sample_create_sample_query_set(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SampleQuerySetService_CreateSampleQuerySet_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_get_sample_query_set_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_get_sample_query_set_async.py index d53101922df1..620b6a4ac4fc 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_get_sample_query_set_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_get_sample_query_set_async.py @@ -49,5 +49,4 @@ async def sample_get_sample_query_set(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SampleQuerySetService_GetSampleQuerySet_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_get_sample_query_set_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_get_sample_query_set_sync.py index 2b839b387105..d0382ad0b3fe 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_get_sample_query_set_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_get_sample_query_set_sync.py @@ -49,5 +49,4 @@ def sample_get_sample_query_set(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SampleQuerySetService_GetSampleQuerySet_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_list_sample_query_sets_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_list_sample_query_sets_async.py index f853b649e8fa..5bdb03c0812d 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_list_sample_query_sets_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_list_sample_query_sets_async.py @@ -50,5 +50,4 @@ async def sample_list_sample_query_sets(): async for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_SampleQuerySetService_ListSampleQuerySets_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_list_sample_query_sets_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_list_sample_query_sets_sync.py index 5c0fb69f2b88..2a58f59979ca 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_list_sample_query_sets_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_list_sample_query_sets_sync.py @@ -50,5 +50,4 @@ def sample_list_sample_query_sets(): for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_SampleQuerySetService_ListSampleQuerySets_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_update_sample_query_set_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_update_sample_query_set_async.py index c1e1d1d9f778..24171f9493bb 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_update_sample_query_set_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_update_sample_query_set_async.py @@ -52,5 +52,4 @@ async def sample_update_sample_query_set(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SampleQuerySetService_UpdateSampleQuerySet_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_update_sample_query_set_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_update_sample_query_set_sync.py index 3da3ffc7d050..d3c1ecd33451 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_update_sample_query_set_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_sample_query_set_service_update_sample_query_set_sync.py @@ -52,5 +52,4 @@ def sample_update_sample_query_set(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SampleQuerySetService_UpdateSampleQuerySet_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_create_schema_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_create_schema_async.py index 288e3de80e06..1dd8ae925737 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_create_schema_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_create_schema_async.py @@ -54,5 +54,4 @@ async def sample_create_schema(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SchemaService_CreateSchema_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_create_schema_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_create_schema_sync.py index e64948f87ede..2709e1191148 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_create_schema_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_create_schema_sync.py @@ -54,5 +54,4 @@ def sample_create_schema(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SchemaService_CreateSchema_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_delete_schema_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_delete_schema_async.py index 8e917638fd78..198b43640a32 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_delete_schema_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_delete_schema_async.py @@ -53,5 +53,4 @@ async def sample_delete_schema(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SchemaService_DeleteSchema_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_delete_schema_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_delete_schema_sync.py index 1ac824502f9c..8414bd16ce7a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_delete_schema_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_delete_schema_sync.py @@ -53,5 +53,4 @@ def sample_delete_schema(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SchemaService_DeleteSchema_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_get_schema_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_get_schema_async.py index 5f9de27e462a..df581c89414a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_get_schema_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_get_schema_async.py @@ -49,5 +49,4 @@ async def sample_get_schema(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SchemaService_GetSchema_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_get_schema_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_get_schema_sync.py index af0f84c9dfd5..1cebb5650e1e 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_get_schema_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_get_schema_sync.py @@ -49,5 +49,4 @@ def sample_get_schema(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SchemaService_GetSchema_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_list_schemas_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_list_schemas_async.py index d7707560a859..f5e57c3b0a0d 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_list_schemas_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_list_schemas_async.py @@ -50,5 +50,4 @@ async def sample_list_schemas(): async for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_SchemaService_ListSchemas_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_list_schemas_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_list_schemas_sync.py index c64ccb4c98e7..b606badb0d3f 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_list_schemas_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_list_schemas_sync.py @@ -50,5 +50,4 @@ def sample_list_schemas(): for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_SchemaService_ListSchemas_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_update_schema_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_update_schema_async.py index 2530dc074aec..9c99ab0df61d 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_update_schema_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_update_schema_async.py @@ -39,7 +39,8 @@ async def sample_update_schema(): client = discoveryengine_v1alpha.SchemaServiceAsyncClient() # Initialize request argument(s) - request = discoveryengine_v1alpha.UpdateSchemaRequest() + request = discoveryengine_v1alpha.UpdateSchemaRequest( + ) # Make the request operation = client.update_schema(request=request) @@ -51,5 +52,4 @@ async def sample_update_schema(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SchemaService_UpdateSchema_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_update_schema_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_update_schema_sync.py index 431c1f751b48..9ac03f214727 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_update_schema_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_schema_service_update_schema_sync.py @@ -39,7 +39,8 @@ def sample_update_schema(): client = discoveryengine_v1alpha.SchemaServiceClient() # Initialize request argument(s) - request = discoveryengine_v1alpha.UpdateSchemaRequest() + request = discoveryengine_v1alpha.UpdateSchemaRequest( + ) # Make the request operation = client.update_schema(request=request) @@ -51,5 +52,4 @@ def sample_update_schema(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SchemaService_UpdateSchema_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_search_service_search_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_search_service_search_async.py index 4f1bef680a8b..ea6578894923 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_search_service_search_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_search_service_search_async.py @@ -50,5 +50,4 @@ async def sample_search(): async for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_SearchService_Search_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_search_service_search_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_search_service_search_sync.py index fb5649fc68ea..d123c7b2e27d 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_search_service_search_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_search_service_search_sync.py @@ -50,5 +50,4 @@ def sample_search(): for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_SearchService_Search_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_search_tuning_service_list_custom_models_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_search_tuning_service_list_custom_models_async.py index a5ca5ca8efd9..03ac79fba5db 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_search_tuning_service_list_custom_models_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_search_tuning_service_list_custom_models_async.py @@ -49,5 +49,4 @@ async def sample_list_custom_models(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SearchTuningService_ListCustomModels_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_search_tuning_service_list_custom_models_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_search_tuning_service_list_custom_models_sync.py index bc5b18192548..e066f601627e 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_search_tuning_service_list_custom_models_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_search_tuning_service_list_custom_models_sync.py @@ -49,5 +49,4 @@ def sample_list_custom_models(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SearchTuningService_ListCustomModels_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_search_tuning_service_train_custom_model_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_search_tuning_service_train_custom_model_async.py index a2f080d45ee1..67ae86ee90b8 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_search_tuning_service_train_custom_model_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_search_tuning_service_train_custom_model_async.py @@ -53,5 +53,4 @@ async def sample_train_custom_model(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SearchTuningService_TrainCustomModel_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_search_tuning_service_train_custom_model_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_search_tuning_service_train_custom_model_sync.py index 67f95c80b1d1..16eca0b6717c 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_search_tuning_service_train_custom_model_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_search_tuning_service_train_custom_model_sync.py @@ -53,5 +53,4 @@ def sample_train_custom_model(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SearchTuningService_TrainCustomModel_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_serving_config_service_get_serving_config_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_serving_config_service_get_serving_config_async.py index bed035e8ce4b..e06af0b9b4e7 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_serving_config_service_get_serving_config_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_serving_config_service_get_serving_config_async.py @@ -49,5 +49,4 @@ async def sample_get_serving_config(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ServingConfigService_GetServingConfig_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_serving_config_service_get_serving_config_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_serving_config_service_get_serving_config_sync.py index e82105085654..797469967a1b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_serving_config_service_get_serving_config_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_serving_config_service_get_serving_config_sync.py @@ -49,5 +49,4 @@ def sample_get_serving_config(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ServingConfigService_GetServingConfig_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_serving_config_service_list_serving_configs_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_serving_config_service_list_serving_configs_async.py index f9f0b7a66a00..6c04e39d0569 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_serving_config_service_list_serving_configs_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_serving_config_service_list_serving_configs_async.py @@ -50,5 +50,4 @@ async def sample_list_serving_configs(): async for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_ServingConfigService_ListServingConfigs_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_serving_config_service_list_serving_configs_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_serving_config_service_list_serving_configs_sync.py index 29d5b6177e12..b0b37f617ca4 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_serving_config_service_list_serving_configs_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_serving_config_service_list_serving_configs_sync.py @@ -50,5 +50,4 @@ def sample_list_serving_configs(): for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_ServingConfigService_ListServingConfigs_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_serving_config_service_update_serving_config_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_serving_config_service_update_serving_config_async.py index d6ebbe6f77d1..75c185135e03 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_serving_config_service_update_serving_config_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_serving_config_service_update_serving_config_async.py @@ -54,5 +54,4 @@ async def sample_update_serving_config(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ServingConfigService_UpdateServingConfig_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_serving_config_service_update_serving_config_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_serving_config_service_update_serving_config_sync.py index 905089cf49d9..fd3c15a9d2f6 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_serving_config_service_update_serving_config_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_serving_config_service_update_serving_config_sync.py @@ -54,5 +54,4 @@ def sample_update_serving_config(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_ServingConfigService_UpdateServingConfig_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_create_session_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_create_session_async.py index f3ce0644edf7..7752ea9d3db2 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_create_session_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_create_session_async.py @@ -49,5 +49,4 @@ async def sample_create_session(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SessionService_CreateSession_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_create_session_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_create_session_sync.py index 7938322b088c..40a6fc6eff7b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_create_session_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_create_session_sync.py @@ -49,5 +49,4 @@ def sample_create_session(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SessionService_CreateSession_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_get_session_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_get_session_async.py index 525666e334ac..10db816f172c 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_get_session_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_get_session_async.py @@ -49,5 +49,4 @@ async def sample_get_session(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SessionService_GetSession_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_get_session_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_get_session_sync.py index c67b59893b2e..052f67c8d00d 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_get_session_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_get_session_sync.py @@ -49,5 +49,4 @@ def sample_get_session(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SessionService_GetSession_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_list_files_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_list_files_async.py index 4a20a3b488ab..a9a9a6f59a79 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_list_files_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_list_files_async.py @@ -50,5 +50,4 @@ async def sample_list_files(): async for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_SessionService_ListFiles_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_list_files_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_list_files_sync.py index 8b6e2a936f87..e09b5e23802d 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_list_files_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_list_files_sync.py @@ -50,5 +50,4 @@ def sample_list_files(): for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_SessionService_ListFiles_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_list_sessions_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_list_sessions_async.py index 7b19740ccabe..d90662104289 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_list_sessions_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_list_sessions_async.py @@ -50,5 +50,4 @@ async def sample_list_sessions(): async for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_SessionService_ListSessions_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_list_sessions_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_list_sessions_sync.py index 4336b3738e65..3915ce7ce062 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_list_sessions_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_list_sessions_sync.py @@ -50,5 +50,4 @@ def sample_list_sessions(): for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_SessionService_ListSessions_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_update_session_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_update_session_async.py index 63d2846057f1..40675830f438 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_update_session_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_update_session_async.py @@ -39,7 +39,8 @@ async def sample_update_session(): client = discoveryengine_v1alpha.SessionServiceAsyncClient() # Initialize request argument(s) - request = discoveryengine_v1alpha.UpdateSessionRequest() + request = discoveryengine_v1alpha.UpdateSessionRequest( + ) # Make the request response = await client.update_session(request=request) @@ -47,5 +48,4 @@ async def sample_update_session(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SessionService_UpdateSession_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_update_session_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_update_session_sync.py index a9b7ebee6824..9d27b996bdcc 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_update_session_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_session_service_update_session_sync.py @@ -39,7 +39,8 @@ def sample_update_session(): client = discoveryengine_v1alpha.SessionServiceClient() # Initialize request argument(s) - request = discoveryengine_v1alpha.UpdateSessionRequest() + request = discoveryengine_v1alpha.UpdateSessionRequest( + ) # Make the request response = client.update_session(request=request) @@ -47,5 +48,4 @@ def sample_update_session(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SessionService_UpdateSession_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_batch_create_target_sites_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_batch_create_target_sites_async.py index 92fe90300af4..462cd27eb642 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_batch_create_target_sites_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_batch_create_target_sites_async.py @@ -58,5 +58,4 @@ async def sample_batch_create_target_sites(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_BatchCreateTargetSites_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_batch_create_target_sites_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_batch_create_target_sites_sync.py index 948306a6e3e8..dd73e24d8b25 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_batch_create_target_sites_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_batch_create_target_sites_sync.py @@ -58,5 +58,4 @@ def sample_batch_create_target_sites(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_BatchCreateTargetSites_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_batch_verify_target_sites_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_batch_verify_target_sites_async.py index 0135ef582f86..17257b60cf5c 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_batch_verify_target_sites_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_batch_verify_target_sites_async.py @@ -53,5 +53,4 @@ async def sample_batch_verify_target_sites(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_BatchVerifyTargetSites_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_batch_verify_target_sites_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_batch_verify_target_sites_sync.py index a0f4f5b58311..f19f70ba41aa 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_batch_verify_target_sites_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_batch_verify_target_sites_sync.py @@ -53,5 +53,4 @@ def sample_batch_verify_target_sites(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_BatchVerifyTargetSites_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_create_target_site_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_create_target_site_async.py index 0a8563cd4b09..198342e0959a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_create_target_site_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_create_target_site_async.py @@ -57,5 +57,4 @@ async def sample_create_target_site(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_CreateTargetSite_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_create_target_site_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_create_target_site_sync.py index 5ed0d7a455f5..c5ff6c39034f 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_create_target_site_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_create_target_site_sync.py @@ -57,5 +57,4 @@ def sample_create_target_site(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_CreateTargetSite_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_delete_target_site_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_delete_target_site_async.py index 9e453aeb618a..b9b67e120b57 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_delete_target_site_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_delete_target_site_async.py @@ -53,5 +53,4 @@ async def sample_delete_target_site(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_DeleteTargetSite_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_delete_target_site_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_delete_target_site_sync.py index ffb6fd69be41..63a646762419 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_delete_target_site_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_delete_target_site_sync.py @@ -53,5 +53,4 @@ def sample_delete_target_site(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_DeleteTargetSite_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_disable_advanced_site_search_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_disable_advanced_site_search_async.py index c38be99ecd91..e7c824094174 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_disable_advanced_site_search_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_disable_advanced_site_search_async.py @@ -53,5 +53,4 @@ async def sample_disable_advanced_site_search(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_DisableAdvancedSiteSearch_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_disable_advanced_site_search_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_disable_advanced_site_search_sync.py index 4fd53bea8dd6..59f4189b3a29 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_disable_advanced_site_search_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_disable_advanced_site_search_sync.py @@ -53,5 +53,4 @@ def sample_disable_advanced_site_search(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_DisableAdvancedSiteSearch_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_enable_advanced_site_search_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_enable_advanced_site_search_async.py index b78ee4faa8ce..89b85db06855 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_enable_advanced_site_search_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_enable_advanced_site_search_async.py @@ -53,5 +53,4 @@ async def sample_enable_advanced_site_search(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_EnableAdvancedSiteSearch_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_enable_advanced_site_search_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_enable_advanced_site_search_sync.py index b0d784e0e2f6..06d4c5deda60 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_enable_advanced_site_search_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_enable_advanced_site_search_sync.py @@ -53,5 +53,4 @@ def sample_enable_advanced_site_search(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_EnableAdvancedSiteSearch_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_fetch_domain_verification_status_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_fetch_domain_verification_status_async.py index 6bfd9d768e72..1a69a70c6976 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_fetch_domain_verification_status_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_fetch_domain_verification_status_async.py @@ -50,5 +50,4 @@ async def sample_fetch_domain_verification_status(): async for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_FetchDomainVerificationStatus_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_fetch_domain_verification_status_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_fetch_domain_verification_status_sync.py index e20e7a797dfe..ffcde8393c75 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_fetch_domain_verification_status_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_fetch_domain_verification_status_sync.py @@ -50,5 +50,4 @@ def sample_fetch_domain_verification_status(): for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_FetchDomainVerificationStatus_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_get_site_search_engine_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_get_site_search_engine_async.py index 1c4c2a7c1b4b..7082c00ca071 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_get_site_search_engine_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_get_site_search_engine_async.py @@ -49,5 +49,4 @@ async def sample_get_site_search_engine(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_GetSiteSearchEngine_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_get_site_search_engine_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_get_site_search_engine_sync.py index 34d912298df4..ce237f639bd5 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_get_site_search_engine_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_get_site_search_engine_sync.py @@ -49,5 +49,4 @@ def sample_get_site_search_engine(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_GetSiteSearchEngine_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_get_target_site_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_get_target_site_async.py index 9ae62fb5cf19..2cf37668b403 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_get_target_site_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_get_target_site_async.py @@ -49,5 +49,4 @@ async def sample_get_target_site(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_GetTargetSite_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_get_target_site_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_get_target_site_sync.py index 2a0d128f4388..8b1621704b49 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_get_target_site_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_get_target_site_sync.py @@ -49,5 +49,4 @@ def sample_get_target_site(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_GetTargetSite_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_get_uri_pattern_document_data_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_get_uri_pattern_document_data_async.py index 4e3915d6c0e5..4d2993b9898f 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_get_uri_pattern_document_data_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_get_uri_pattern_document_data_async.py @@ -49,5 +49,4 @@ async def sample_get_uri_pattern_document_data(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_GetUriPatternDocumentData_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_get_uri_pattern_document_data_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_get_uri_pattern_document_data_sync.py index d2615379d56f..913568107b59 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_get_uri_pattern_document_data_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_get_uri_pattern_document_data_sync.py @@ -49,5 +49,4 @@ def sample_get_uri_pattern_document_data(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_GetUriPatternDocumentData_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_list_target_sites_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_list_target_sites_async.py index de7e12045993..fb1e8ee109b0 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_list_target_sites_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_list_target_sites_async.py @@ -50,5 +50,4 @@ async def sample_list_target_sites(): async for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_ListTargetSites_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_list_target_sites_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_list_target_sites_sync.py index c34947f7ba97..e2228f03d8f2 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_list_target_sites_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_list_target_sites_sync.py @@ -50,5 +50,4 @@ def sample_list_target_sites(): for response in page_result: print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_ListTargetSites_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_recrawl_uris_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_recrawl_uris_async.py index edd10070eed1..320cf712c8f1 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_recrawl_uris_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_recrawl_uris_async.py @@ -41,7 +41,7 @@ async def sample_recrawl_uris(): # Initialize request argument(s) request = discoveryengine_v1alpha.RecrawlUrisRequest( site_search_engine="site_search_engine_value", - uris=["uris_value1", "uris_value2"], + uris=['uris_value1', 'uris_value2'], ) # Make the request @@ -54,5 +54,4 @@ async def sample_recrawl_uris(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_RecrawlUris_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_recrawl_uris_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_recrawl_uris_sync.py index 7ef7bf32ab9d..e4e411995df5 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_recrawl_uris_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_recrawl_uris_sync.py @@ -41,7 +41,7 @@ def sample_recrawl_uris(): # Initialize request argument(s) request = discoveryengine_v1alpha.RecrawlUrisRequest( site_search_engine="site_search_engine_value", - uris=["uris_value1", "uris_value2"], + uris=['uris_value1', 'uris_value2'], ) # Make the request @@ -54,5 +54,4 @@ def sample_recrawl_uris(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_RecrawlUris_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_set_uri_pattern_document_data_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_set_uri_pattern_document_data_async.py index 24c1b9314b3f..72ac2340e2d7 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_set_uri_pattern_document_data_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_set_uri_pattern_document_data_async.py @@ -53,5 +53,4 @@ async def sample_set_uri_pattern_document_data(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_SetUriPatternDocumentData_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_set_uri_pattern_document_data_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_set_uri_pattern_document_data_sync.py index e20f34391cfd..2c9f322aabaa 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_set_uri_pattern_document_data_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_set_uri_pattern_document_data_sync.py @@ -53,5 +53,4 @@ def sample_set_uri_pattern_document_data(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_SetUriPatternDocumentData_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_update_target_site_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_update_target_site_async.py index ea4fa5d2601e..d9b46500a880 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_update_target_site_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_update_target_site_async.py @@ -56,5 +56,4 @@ async def sample_update_target_site(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_UpdateTargetSite_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_update_target_site_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_update_target_site_sync.py index 689601e86bd6..b2a112379880 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_update_target_site_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_site_search_engine_service_update_target_site_sync.py @@ -56,5 +56,4 @@ def sample_update_target_site(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_SiteSearchEngineService_UpdateTargetSite_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_collect_user_event_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_collect_user_event_async.py index 6015adaddee9..80acbe1d34cc 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_collect_user_event_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_collect_user_event_async.py @@ -50,5 +50,4 @@ async def sample_collect_user_event(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_UserEventService_CollectUserEvent_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_collect_user_event_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_collect_user_event_sync.py index 1e0e71509f83..0c6d401bd899 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_collect_user_event_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_collect_user_event_sync.py @@ -50,5 +50,4 @@ def sample_collect_user_event(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_UserEventService_CollectUserEvent_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_import_user_events_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_import_user_events_async.py index d30028e86421..bfffa7d4bddc 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_import_user_events_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_import_user_events_async.py @@ -58,5 +58,4 @@ async def sample_import_user_events(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_UserEventService_ImportUserEvents_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_import_user_events_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_import_user_events_sync.py index 74f61e64a892..aa98e0cf16e3 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_import_user_events_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_import_user_events_sync.py @@ -58,5 +58,4 @@ def sample_import_user_events(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_UserEventService_ImportUserEvents_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_purge_user_events_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_purge_user_events_async.py index 62e5e91d8b43..129228658810 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_purge_user_events_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_purge_user_events_async.py @@ -54,5 +54,4 @@ async def sample_purge_user_events(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_UserEventService_PurgeUserEvents_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_purge_user_events_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_purge_user_events_sync.py index f5d7149a92f3..0b6f316b1c87 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_purge_user_events_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_purge_user_events_sync.py @@ -54,5 +54,4 @@ def sample_purge_user_events(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_UserEventService_PurgeUserEvents_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_write_user_event_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_write_user_event_async.py index 821bbec9aab5..c02bc52ec563 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_write_user_event_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_write_user_event_async.py @@ -49,5 +49,4 @@ async def sample_write_user_event(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_UserEventService_WriteUserEvent_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_write_user_event_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_write_user_event_sync.py index 94ea9279ba4a..16cb647bb237 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_write_user_event_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1alpha_generated_user_event_service_write_user_event_sync.py @@ -49,5 +49,4 @@ def sample_write_user_event(): # Handle the response print(response) - # [END discoveryengine_v1alpha_generated_UserEventService_WriteUserEvent_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_advanced_complete_query_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_advanced_complete_query_async.py index 1def36ab148b..1fbe3ee9c87a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_advanced_complete_query_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_advanced_complete_query_async.py @@ -50,5 +50,4 @@ async def sample_advanced_complete_query(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_CompletionService_AdvancedCompleteQuery_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_advanced_complete_query_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_advanced_complete_query_sync.py index e4d725464885..05ddce704771 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_advanced_complete_query_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_advanced_complete_query_sync.py @@ -50,5 +50,4 @@ def sample_advanced_complete_query(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_CompletionService_AdvancedCompleteQuery_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_complete_query_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_complete_query_async.py index d388c9ff0a9e..b0ac094a5410 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_complete_query_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_complete_query_async.py @@ -50,5 +50,4 @@ async def sample_complete_query(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_CompletionService_CompleteQuery_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_complete_query_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_complete_query_sync.py index 9f53693a3665..08e6ced1b01f 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_complete_query_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_complete_query_sync.py @@ -50,5 +50,4 @@ def sample_complete_query(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_CompletionService_CompleteQuery_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_import_completion_suggestions_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_import_completion_suggestions_async.py index fe018f7ab24c..cd9262b8db0d 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_import_completion_suggestions_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_import_completion_suggestions_async.py @@ -58,5 +58,4 @@ async def sample_import_completion_suggestions(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_CompletionService_ImportCompletionSuggestions_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_import_completion_suggestions_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_import_completion_suggestions_sync.py index 3d17fbb017f1..64d1045c9733 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_import_completion_suggestions_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_import_completion_suggestions_sync.py @@ -58,5 +58,4 @@ def sample_import_completion_suggestions(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_CompletionService_ImportCompletionSuggestions_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_import_suggestion_deny_list_entries_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_import_suggestion_deny_list_entries_async.py index 5762c56cb70f..0af511f1ef17 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_import_suggestion_deny_list_entries_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_import_suggestion_deny_list_entries_async.py @@ -58,5 +58,4 @@ async def sample_import_suggestion_deny_list_entries(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_CompletionService_ImportSuggestionDenyListEntries_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_import_suggestion_deny_list_entries_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_import_suggestion_deny_list_entries_sync.py index 0c0529aa79d3..8a82832ee6c2 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_import_suggestion_deny_list_entries_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_import_suggestion_deny_list_entries_sync.py @@ -58,5 +58,4 @@ def sample_import_suggestion_deny_list_entries(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_CompletionService_ImportSuggestionDenyListEntries_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_purge_completion_suggestions_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_purge_completion_suggestions_async.py index 7fa3f5a1c777..d09bc3d46e65 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_purge_completion_suggestions_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_purge_completion_suggestions_async.py @@ -53,5 +53,4 @@ async def sample_purge_completion_suggestions(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_CompletionService_PurgeCompletionSuggestions_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_purge_completion_suggestions_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_purge_completion_suggestions_sync.py index b9df6a09f213..e81220464e53 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_purge_completion_suggestions_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_purge_completion_suggestions_sync.py @@ -53,5 +53,4 @@ def sample_purge_completion_suggestions(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_CompletionService_PurgeCompletionSuggestions_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_purge_suggestion_deny_list_entries_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_purge_suggestion_deny_list_entries_async.py index 21de46dba2d2..f66b260ddc4a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_purge_suggestion_deny_list_entries_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_purge_suggestion_deny_list_entries_async.py @@ -53,5 +53,4 @@ async def sample_purge_suggestion_deny_list_entries(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_CompletionService_PurgeSuggestionDenyListEntries_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_purge_suggestion_deny_list_entries_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_purge_suggestion_deny_list_entries_sync.py index 7a71850d0b5b..9dd2d2f3e2d8 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_purge_suggestion_deny_list_entries_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_completion_service_purge_suggestion_deny_list_entries_sync.py @@ -53,5 +53,4 @@ def sample_purge_suggestion_deny_list_entries(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_CompletionService_PurgeSuggestionDenyListEntries_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_create_control_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_create_control_async.py index 7149f5fb4611..0df1b993dc6d 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_create_control_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_create_control_async.py @@ -58,5 +58,4 @@ async def sample_create_control(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ControlService_CreateControl_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_create_control_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_create_control_sync.py index de8d58ff0fad..14a4059ecc0f 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_create_control_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_create_control_sync.py @@ -58,5 +58,4 @@ def sample_create_control(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ControlService_CreateControl_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_get_control_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_get_control_async.py index 78eae5b09b01..c4bcbf380ab1 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_get_control_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_get_control_async.py @@ -49,5 +49,4 @@ async def sample_get_control(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ControlService_GetControl_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_get_control_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_get_control_sync.py index d22e5990ce7b..40b3cf11361a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_get_control_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_get_control_sync.py @@ -49,5 +49,4 @@ def sample_get_control(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ControlService_GetControl_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_list_controls_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_list_controls_async.py index 5dfc59abaefc..2a23a4eb3863 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_list_controls_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_list_controls_async.py @@ -50,5 +50,4 @@ async def sample_list_controls(): async for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_ControlService_ListControls_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_list_controls_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_list_controls_sync.py index 9daa8c982dc5..ba8d4d3e66ee 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_list_controls_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_list_controls_sync.py @@ -50,5 +50,4 @@ def sample_list_controls(): for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_ControlService_ListControls_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_update_control_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_update_control_async.py index 8ab8f7f2320f..8adfe0db41d1 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_update_control_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_update_control_async.py @@ -56,5 +56,4 @@ async def sample_update_control(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ControlService_UpdateControl_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_update_control_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_update_control_sync.py index 862119109294..b3273d3e3f09 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_update_control_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_control_service_update_control_sync.py @@ -56,5 +56,4 @@ def sample_update_control(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ControlService_UpdateControl_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_answer_query_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_answer_query_async.py index a66f6311146a..bcae176cf514 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_answer_query_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_answer_query_async.py @@ -53,5 +53,4 @@ async def sample_answer_query(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ConversationalSearchService_AnswerQuery_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_answer_query_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_answer_query_sync.py index e4f582e74d8c..8b1980e005dc 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_answer_query_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_answer_query_sync.py @@ -53,5 +53,4 @@ def sample_answer_query(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ConversationalSearchService_AnswerQuery_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_converse_conversation_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_converse_conversation_async.py index 16344de00221..cf78466592f2 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_converse_conversation_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_converse_conversation_async.py @@ -49,5 +49,4 @@ async def sample_converse_conversation(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ConversationalSearchService_ConverseConversation_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_converse_conversation_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_converse_conversation_sync.py index f9de6e692636..b964855ca7a2 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_converse_conversation_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_converse_conversation_sync.py @@ -49,5 +49,4 @@ def sample_converse_conversation(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ConversationalSearchService_ConverseConversation_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_create_conversation_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_create_conversation_async.py index 9f64b368aadf..dea8ae795347 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_create_conversation_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_create_conversation_async.py @@ -49,5 +49,4 @@ async def sample_create_conversation(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ConversationalSearchService_CreateConversation_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_create_conversation_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_create_conversation_sync.py index 0284c25184cf..5591144e4ba9 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_create_conversation_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_create_conversation_sync.py @@ -49,5 +49,4 @@ def sample_create_conversation(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ConversationalSearchService_CreateConversation_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_create_session_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_create_session_async.py index 4d7c238839c0..a204b694f3d6 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_create_session_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_create_session_async.py @@ -49,5 +49,4 @@ async def sample_create_session(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ConversationalSearchService_CreateSession_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_create_session_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_create_session_sync.py index 9d59fbcd28cf..56f3fcd104d5 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_create_session_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_create_session_sync.py @@ -49,5 +49,4 @@ def sample_create_session(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ConversationalSearchService_CreateSession_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_get_answer_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_get_answer_async.py index b3d4ce93bfe3..05319c634acd 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_get_answer_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_get_answer_async.py @@ -49,5 +49,4 @@ async def sample_get_answer(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ConversationalSearchService_GetAnswer_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_get_answer_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_get_answer_sync.py index def4e5576557..bdbf6cd00992 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_get_answer_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_get_answer_sync.py @@ -49,5 +49,4 @@ def sample_get_answer(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ConversationalSearchService_GetAnswer_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_get_conversation_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_get_conversation_async.py index 06c88a13ab62..bf4d0f12e140 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_get_conversation_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_get_conversation_async.py @@ -49,5 +49,4 @@ async def sample_get_conversation(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ConversationalSearchService_GetConversation_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_get_conversation_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_get_conversation_sync.py index 40ca34df4db3..f09ce5b67ce8 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_get_conversation_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_get_conversation_sync.py @@ -49,5 +49,4 @@ def sample_get_conversation(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ConversationalSearchService_GetConversation_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_get_session_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_get_session_async.py index 7d018a3aad8c..3f0cf0090b8e 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_get_session_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_get_session_async.py @@ -49,5 +49,4 @@ async def sample_get_session(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ConversationalSearchService_GetSession_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_get_session_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_get_session_sync.py index 31beac0d66e1..ecf50d604464 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_get_session_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_get_session_sync.py @@ -49,5 +49,4 @@ def sample_get_session(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ConversationalSearchService_GetSession_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_list_conversations_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_list_conversations_async.py index 89488e1be541..c4bcaabe378c 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_list_conversations_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_list_conversations_async.py @@ -50,5 +50,4 @@ async def sample_list_conversations(): async for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_ConversationalSearchService_ListConversations_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_list_conversations_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_list_conversations_sync.py index 060c46f449a6..2b872e040e9b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_list_conversations_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_list_conversations_sync.py @@ -50,5 +50,4 @@ def sample_list_conversations(): for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_ConversationalSearchService_ListConversations_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_list_sessions_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_list_sessions_async.py index d17e61226837..6c2d086fd0ce 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_list_sessions_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_list_sessions_async.py @@ -50,5 +50,4 @@ async def sample_list_sessions(): async for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_ConversationalSearchService_ListSessions_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_list_sessions_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_list_sessions_sync.py index 336aac772561..b9e04f2a2641 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_list_sessions_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_list_sessions_sync.py @@ -50,5 +50,4 @@ def sample_list_sessions(): for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_ConversationalSearchService_ListSessions_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_update_conversation_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_update_conversation_async.py index 5f53783bd459..2bb6b85708bd 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_update_conversation_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_update_conversation_async.py @@ -39,7 +39,8 @@ async def sample_update_conversation(): client = discoveryengine_v1beta.ConversationalSearchServiceAsyncClient() # Initialize request argument(s) - request = discoveryengine_v1beta.UpdateConversationRequest() + request = discoveryengine_v1beta.UpdateConversationRequest( + ) # Make the request response = await client.update_conversation(request=request) @@ -47,5 +48,4 @@ async def sample_update_conversation(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ConversationalSearchService_UpdateConversation_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_update_conversation_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_update_conversation_sync.py index 67f070ab7856..39ceaff3d34b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_update_conversation_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_update_conversation_sync.py @@ -39,7 +39,8 @@ def sample_update_conversation(): client = discoveryengine_v1beta.ConversationalSearchServiceClient() # Initialize request argument(s) - request = discoveryengine_v1beta.UpdateConversationRequest() + request = discoveryengine_v1beta.UpdateConversationRequest( + ) # Make the request response = client.update_conversation(request=request) @@ -47,5 +48,4 @@ def sample_update_conversation(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ConversationalSearchService_UpdateConversation_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_update_session_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_update_session_async.py index 4c9a93ab2e10..e8ec72858092 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_update_session_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_update_session_async.py @@ -39,7 +39,8 @@ async def sample_update_session(): client = discoveryengine_v1beta.ConversationalSearchServiceAsyncClient() # Initialize request argument(s) - request = discoveryengine_v1beta.UpdateSessionRequest() + request = discoveryengine_v1beta.UpdateSessionRequest( + ) # Make the request response = await client.update_session(request=request) @@ -47,5 +48,4 @@ async def sample_update_session(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ConversationalSearchService_UpdateSession_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_update_session_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_update_session_sync.py index 338b777fde31..c74b77b357ee 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_update_session_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_conversational_search_service_update_session_sync.py @@ -39,7 +39,8 @@ def sample_update_session(): client = discoveryengine_v1beta.ConversationalSearchServiceClient() # Initialize request argument(s) - request = discoveryengine_v1beta.UpdateSessionRequest() + request = discoveryengine_v1beta.UpdateSessionRequest( + ) # Make the request response = client.update_session(request=request) @@ -47,5 +48,4 @@ def sample_update_session(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ConversationalSearchService_UpdateSession_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_create_data_store_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_create_data_store_async.py index da8b88c98470..37e0b77c9a7e 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_create_data_store_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_create_data_store_async.py @@ -58,5 +58,4 @@ async def sample_create_data_store(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_DataStoreService_CreateDataStore_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_create_data_store_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_create_data_store_sync.py index c58849fb9039..d72761bbe111 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_create_data_store_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_create_data_store_sync.py @@ -58,5 +58,4 @@ def sample_create_data_store(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_DataStoreService_CreateDataStore_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_delete_data_store_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_delete_data_store_async.py index 38e8a2c26a3f..2da95c36650c 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_delete_data_store_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_delete_data_store_async.py @@ -53,5 +53,4 @@ async def sample_delete_data_store(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_DataStoreService_DeleteDataStore_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_delete_data_store_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_delete_data_store_sync.py index 1f2c1d3e1374..46c40613323b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_delete_data_store_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_delete_data_store_sync.py @@ -53,5 +53,4 @@ def sample_delete_data_store(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_DataStoreService_DeleteDataStore_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_get_data_store_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_get_data_store_async.py index 481f62262c5a..d6919c5ff7f4 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_get_data_store_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_get_data_store_async.py @@ -49,5 +49,4 @@ async def sample_get_data_store(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_DataStoreService_GetDataStore_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_get_data_store_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_get_data_store_sync.py index 25390c793e45..3da40939f5ed 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_get_data_store_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_get_data_store_sync.py @@ -49,5 +49,4 @@ def sample_get_data_store(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_DataStoreService_GetDataStore_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_list_data_stores_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_list_data_stores_async.py index 5bb2fceb91f2..364c9bc50ba2 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_list_data_stores_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_list_data_stores_async.py @@ -50,5 +50,4 @@ async def sample_list_data_stores(): async for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_DataStoreService_ListDataStores_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_list_data_stores_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_list_data_stores_sync.py index 1071f33c1268..41459c114cd3 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_list_data_stores_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_list_data_stores_sync.py @@ -50,5 +50,4 @@ def sample_list_data_stores(): for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_DataStoreService_ListDataStores_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_update_data_store_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_update_data_store_async.py index 40f493b2ef73..d53feb2daccf 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_update_data_store_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_update_data_store_async.py @@ -52,5 +52,4 @@ async def sample_update_data_store(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_DataStoreService_UpdateDataStore_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_update_data_store_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_update_data_store_sync.py index 3c255969e16e..0f7f33a0167b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_update_data_store_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_data_store_service_update_data_store_sync.py @@ -52,5 +52,4 @@ def sample_update_data_store(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_DataStoreService_UpdateDataStore_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_batch_get_documents_metadata_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_batch_get_documents_metadata_async.py index 4e5d739274f4..d7cfe48e1704 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_batch_get_documents_metadata_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_batch_get_documents_metadata_async.py @@ -49,5 +49,4 @@ async def sample_batch_get_documents_metadata(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_DocumentService_BatchGetDocumentsMetadata_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_batch_get_documents_metadata_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_batch_get_documents_metadata_sync.py index 54b5b3b866ee..4d2e08acb145 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_batch_get_documents_metadata_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_batch_get_documents_metadata_sync.py @@ -49,5 +49,4 @@ def sample_batch_get_documents_metadata(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_DocumentService_BatchGetDocumentsMetadata_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_create_document_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_create_document_async.py index 98d9aa87742c..575d2dd0b952 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_create_document_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_create_document_async.py @@ -50,5 +50,4 @@ async def sample_create_document(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_DocumentService_CreateDocument_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_create_document_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_create_document_sync.py index 8559251974e1..087fb55c7897 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_create_document_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_create_document_sync.py @@ -50,5 +50,4 @@ def sample_create_document(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_DocumentService_CreateDocument_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_get_document_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_get_document_async.py index b39099399401..2b1ba777ca94 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_get_document_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_get_document_async.py @@ -49,5 +49,4 @@ async def sample_get_document(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_DocumentService_GetDocument_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_get_document_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_get_document_sync.py index 22ed334b3f2b..93d9cd7dcaf8 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_get_document_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_get_document_sync.py @@ -49,5 +49,4 @@ def sample_get_document(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_DocumentService_GetDocument_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_import_documents_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_import_documents_async.py index b0b639a5d771..525d8ebb99d9 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_import_documents_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_import_documents_async.py @@ -53,5 +53,4 @@ async def sample_import_documents(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_DocumentService_ImportDocuments_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_import_documents_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_import_documents_sync.py index 7082ae015514..bbacd8805060 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_import_documents_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_import_documents_sync.py @@ -53,5 +53,4 @@ def sample_import_documents(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_DocumentService_ImportDocuments_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_list_documents_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_list_documents_async.py index e9e03c43c32f..f5561fdd0c92 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_list_documents_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_list_documents_async.py @@ -50,5 +50,4 @@ async def sample_list_documents(): async for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_DocumentService_ListDocuments_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_list_documents_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_list_documents_sync.py index c659bed262a1..43d7de020921 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_list_documents_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_list_documents_sync.py @@ -50,5 +50,4 @@ def sample_list_documents(): for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_DocumentService_ListDocuments_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_purge_documents_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_purge_documents_async.py index a8e9767d5a94..898f126d23b8 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_purge_documents_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_purge_documents_async.py @@ -40,7 +40,7 @@ async def sample_purge_documents(): # Initialize request argument(s) gcs_source = discoveryengine_v1beta.GcsSource() - gcs_source.input_uris = ["input_uris_value1", "input_uris_value2"] + gcs_source.input_uris = ['input_uris_value1', 'input_uris_value2'] request = discoveryengine_v1beta.PurgeDocumentsRequest( gcs_source=gcs_source, @@ -58,5 +58,4 @@ async def sample_purge_documents(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_DocumentService_PurgeDocuments_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_purge_documents_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_purge_documents_sync.py index 3a59a325bf1c..a8d2ae7e2954 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_purge_documents_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_purge_documents_sync.py @@ -40,7 +40,7 @@ def sample_purge_documents(): # Initialize request argument(s) gcs_source = discoveryengine_v1beta.GcsSource() - gcs_source.input_uris = ["input_uris_value1", "input_uris_value2"] + gcs_source.input_uris = ['input_uris_value1', 'input_uris_value2'] request = discoveryengine_v1beta.PurgeDocumentsRequest( gcs_source=gcs_source, @@ -58,5 +58,4 @@ def sample_purge_documents(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_DocumentService_PurgeDocuments_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_update_document_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_update_document_async.py index 5e1865d6a705..52192205c128 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_update_document_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_update_document_async.py @@ -39,7 +39,8 @@ async def sample_update_document(): client = discoveryengine_v1beta.DocumentServiceAsyncClient() # Initialize request argument(s) - request = discoveryengine_v1beta.UpdateDocumentRequest() + request = discoveryengine_v1beta.UpdateDocumentRequest( + ) # Make the request response = await client.update_document(request=request) @@ -47,5 +48,4 @@ async def sample_update_document(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_DocumentService_UpdateDocument_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_update_document_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_update_document_sync.py index 5f3b774e1d97..3f96bb85c2a4 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_update_document_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_document_service_update_document_sync.py @@ -39,7 +39,8 @@ def sample_update_document(): client = discoveryengine_v1beta.DocumentServiceClient() # Initialize request argument(s) - request = discoveryengine_v1beta.UpdateDocumentRequest() + request = discoveryengine_v1beta.UpdateDocumentRequest( + ) # Make the request response = client.update_document(request=request) @@ -47,5 +48,4 @@ def sample_update_document(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_DocumentService_UpdateDocument_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_create_engine_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_create_engine_async.py index aadf88b9f829..5cca3f5b14ae 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_create_engine_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_create_engine_async.py @@ -59,5 +59,4 @@ async def sample_create_engine(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_EngineService_CreateEngine_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_create_engine_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_create_engine_sync.py index ccd831426283..b8f3671bb5da 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_create_engine_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_create_engine_sync.py @@ -59,5 +59,4 @@ def sample_create_engine(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_EngineService_CreateEngine_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_delete_engine_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_delete_engine_async.py index 32c9dfec7cbe..371d6e132abd 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_delete_engine_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_delete_engine_async.py @@ -53,5 +53,4 @@ async def sample_delete_engine(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_EngineService_DeleteEngine_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_delete_engine_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_delete_engine_sync.py index 092c8e5ec02f..31c1e0dc948b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_delete_engine_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_delete_engine_sync.py @@ -53,5 +53,4 @@ def sample_delete_engine(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_EngineService_DeleteEngine_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_get_engine_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_get_engine_async.py index 08b09f20e17d..c3cdd32ceba3 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_get_engine_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_get_engine_async.py @@ -49,5 +49,4 @@ async def sample_get_engine(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_EngineService_GetEngine_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_get_engine_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_get_engine_sync.py index f532b7293935..ec8059793ce7 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_get_engine_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_get_engine_sync.py @@ -49,5 +49,4 @@ def sample_get_engine(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_EngineService_GetEngine_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_list_engines_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_list_engines_async.py index 432fe4667711..4a1d9608c5d5 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_list_engines_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_list_engines_async.py @@ -50,5 +50,4 @@ async def sample_list_engines(): async for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_EngineService_ListEngines_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_list_engines_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_list_engines_sync.py index 201c06c15dad..e42dd93a3d31 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_list_engines_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_list_engines_sync.py @@ -50,5 +50,4 @@ def sample_list_engines(): for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_EngineService_ListEngines_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_pause_engine_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_pause_engine_async.py index 27a7cf0d501b..e6292afa2cb8 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_pause_engine_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_pause_engine_async.py @@ -49,5 +49,4 @@ async def sample_pause_engine(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_EngineService_PauseEngine_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_pause_engine_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_pause_engine_sync.py index 5b162551bb11..0d7c5882347f 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_pause_engine_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_pause_engine_sync.py @@ -49,5 +49,4 @@ def sample_pause_engine(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_EngineService_PauseEngine_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_resume_engine_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_resume_engine_async.py index 2878c43159c6..9706e6d1ca38 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_resume_engine_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_resume_engine_async.py @@ -49,5 +49,4 @@ async def sample_resume_engine(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_EngineService_ResumeEngine_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_resume_engine_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_resume_engine_sync.py index 12e3b57e2581..7cfa26327c98 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_resume_engine_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_resume_engine_sync.py @@ -49,5 +49,4 @@ def sample_resume_engine(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_EngineService_ResumeEngine_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_tune_engine_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_tune_engine_async.py index b7b20da27963..291d5fe49fc3 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_tune_engine_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_tune_engine_async.py @@ -53,5 +53,4 @@ async def sample_tune_engine(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_EngineService_TuneEngine_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_tune_engine_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_tune_engine_sync.py index db238e9c3082..ed0e962a6456 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_tune_engine_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_tune_engine_sync.py @@ -53,5 +53,4 @@ def sample_tune_engine(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_EngineService_TuneEngine_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_update_engine_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_update_engine_async.py index d8575b124950..e44130bccdfe 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_update_engine_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_update_engine_async.py @@ -53,5 +53,4 @@ async def sample_update_engine(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_EngineService_UpdateEngine_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_update_engine_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_update_engine_sync.py index 7728a994688b..80a0752fde61 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_update_engine_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_engine_service_update_engine_sync.py @@ -53,5 +53,4 @@ def sample_update_engine(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_EngineService_UpdateEngine_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_create_evaluation_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_create_evaluation_async.py index 1db4917b7b18..06b3975a8790 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_create_evaluation_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_create_evaluation_async.py @@ -41,9 +41,7 @@ async def sample_create_evaluation(): # Initialize request argument(s) evaluation = discoveryengine_v1beta.Evaluation() evaluation.evaluation_spec.search_request.serving_config = "serving_config_value" - evaluation.evaluation_spec.query_set_spec.sample_query_set = ( - "sample_query_set_value" - ) + evaluation.evaluation_spec.query_set_spec.sample_query_set = "sample_query_set_value" request = discoveryengine_v1beta.CreateEvaluationRequest( parent="parent_value", @@ -60,5 +58,4 @@ async def sample_create_evaluation(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_EvaluationService_CreateEvaluation_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_create_evaluation_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_create_evaluation_sync.py index ce6ad4822bf1..c10c03564a2b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_create_evaluation_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_create_evaluation_sync.py @@ -41,9 +41,7 @@ def sample_create_evaluation(): # Initialize request argument(s) evaluation = discoveryengine_v1beta.Evaluation() evaluation.evaluation_spec.search_request.serving_config = "serving_config_value" - evaluation.evaluation_spec.query_set_spec.sample_query_set = ( - "sample_query_set_value" - ) + evaluation.evaluation_spec.query_set_spec.sample_query_set = "sample_query_set_value" request = discoveryengine_v1beta.CreateEvaluationRequest( parent="parent_value", @@ -60,5 +58,4 @@ def sample_create_evaluation(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_EvaluationService_CreateEvaluation_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_get_evaluation_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_get_evaluation_async.py index b5cc13d382c2..252e3b39a6f2 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_get_evaluation_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_get_evaluation_async.py @@ -49,5 +49,4 @@ async def sample_get_evaluation(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_EvaluationService_GetEvaluation_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_get_evaluation_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_get_evaluation_sync.py index d15a650e5281..734fc5203bc1 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_get_evaluation_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_get_evaluation_sync.py @@ -49,5 +49,4 @@ def sample_get_evaluation(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_EvaluationService_GetEvaluation_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_list_evaluation_results_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_list_evaluation_results_async.py index 8609ab8124e5..d7d809fa12a6 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_list_evaluation_results_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_list_evaluation_results_async.py @@ -50,5 +50,4 @@ async def sample_list_evaluation_results(): async for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_EvaluationService_ListEvaluationResults_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_list_evaluation_results_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_list_evaluation_results_sync.py index f7e77e3ec0e8..4107b32f0869 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_list_evaluation_results_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_list_evaluation_results_sync.py @@ -50,5 +50,4 @@ def sample_list_evaluation_results(): for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_EvaluationService_ListEvaluationResults_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_list_evaluations_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_list_evaluations_async.py index 6f8d6791df5f..f14219a511aa 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_list_evaluations_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_list_evaluations_async.py @@ -50,5 +50,4 @@ async def sample_list_evaluations(): async for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_EvaluationService_ListEvaluations_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_list_evaluations_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_list_evaluations_sync.py index a249a578cef2..1cf9e7062a8d 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_list_evaluations_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_evaluation_service_list_evaluations_sync.py @@ -50,5 +50,4 @@ def sample_list_evaluations(): for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_EvaluationService_ListEvaluations_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_grounded_generation_service_check_grounding_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_grounded_generation_service_check_grounding_async.py index d2d70a60f75b..a5b7f84245ab 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_grounded_generation_service_check_grounding_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_grounded_generation_service_check_grounding_async.py @@ -49,5 +49,4 @@ async def sample_check_grounding(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_GroundedGenerationService_CheckGrounding_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_grounded_generation_service_check_grounding_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_grounded_generation_service_check_grounding_sync.py index 796a431e5028..b223fb481457 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_grounded_generation_service_check_grounding_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_grounded_generation_service_check_grounding_sync.py @@ -49,5 +49,4 @@ def sample_check_grounding(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_GroundedGenerationService_CheckGrounding_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_grounded_generation_service_generate_grounded_content_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_grounded_generation_service_generate_grounded_content_async.py index 9cf5875212bf..d20e6f4e4324 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_grounded_generation_service_generate_grounded_content_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_grounded_generation_service_generate_grounded_content_async.py @@ -49,5 +49,4 @@ async def sample_generate_grounded_content(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_GroundedGenerationService_GenerateGroundedContent_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_grounded_generation_service_generate_grounded_content_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_grounded_generation_service_generate_grounded_content_sync.py index 6c1d52c5bf9c..f7f66be7659a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_grounded_generation_service_generate_grounded_content_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_grounded_generation_service_generate_grounded_content_sync.py @@ -49,5 +49,4 @@ def sample_generate_grounded_content(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_GroundedGenerationService_GenerateGroundedContent_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_grounded_generation_service_stream_generate_grounded_content_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_grounded_generation_service_stream_generate_grounded_content_async.py index 7706efc8e2bb..b568854e8aee 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_grounded_generation_service_stream_generate_grounded_content_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_grounded_generation_service_stream_generate_grounded_content_async.py @@ -60,5 +60,4 @@ def request_generator(): async for response in stream: print(response) - # [END discoveryengine_v1beta_generated_GroundedGenerationService_StreamGenerateGroundedContent_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_grounded_generation_service_stream_generate_grounded_content_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_grounded_generation_service_stream_generate_grounded_content_sync.py index 8b8063e6c6e1..fa3d1b65ac94 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_grounded_generation_service_stream_generate_grounded_content_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_grounded_generation_service_stream_generate_grounded_content_sync.py @@ -60,5 +60,4 @@ def request_generator(): for response in stream: print(response) - # [END discoveryengine_v1beta_generated_GroundedGenerationService_StreamGenerateGroundedContent_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_project_service_provision_project_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_project_service_provision_project_async.py index 2be06c4f9bbc..c428db18cef5 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_project_service_provision_project_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_project_service_provision_project_async.py @@ -55,5 +55,4 @@ async def sample_provision_project(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ProjectService_ProvisionProject_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_project_service_provision_project_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_project_service_provision_project_sync.py index 03c17f7d527d..c9760c1cde1d 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_project_service_provision_project_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_project_service_provision_project_sync.py @@ -55,5 +55,4 @@ def sample_provision_project(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ProjectService_ProvisionProject_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_rank_service_rank_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_rank_service_rank_async.py index 4c3e5b876bed..a75a560b768c 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_rank_service_rank_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_rank_service_rank_async.py @@ -49,5 +49,4 @@ async def sample_rank(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_RankService_Rank_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_rank_service_rank_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_rank_service_rank_sync.py index 8419e1e66495..da45839b3e48 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_rank_service_rank_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_rank_service_rank_sync.py @@ -49,5 +49,4 @@ def sample_rank(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_RankService_Rank_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_recommendation_service_recommend_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_recommendation_service_recommend_async.py index 5cdda55da141..028405ce52be 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_recommendation_service_recommend_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_recommendation_service_recommend_async.py @@ -54,5 +54,4 @@ async def sample_recommend(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_RecommendationService_Recommend_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_recommendation_service_recommend_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_recommendation_service_recommend_sync.py index 541952801f5c..15dc55ed1b00 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_recommendation_service_recommend_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_recommendation_service_recommend_sync.py @@ -54,5 +54,4 @@ def sample_recommend(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_RecommendationService_Recommend_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_create_sample_query_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_create_sample_query_async.py index c91f8499e836..5cb35512d03e 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_create_sample_query_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_create_sample_query_async.py @@ -54,5 +54,4 @@ async def sample_create_sample_query(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SampleQueryService_CreateSampleQuery_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_create_sample_query_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_create_sample_query_sync.py index 65c0123e34e1..7f288056579a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_create_sample_query_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_create_sample_query_sync.py @@ -54,5 +54,4 @@ def sample_create_sample_query(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SampleQueryService_CreateSampleQuery_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_get_sample_query_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_get_sample_query_async.py index 08f3b7d4566a..7f14bf22d662 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_get_sample_query_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_get_sample_query_async.py @@ -49,5 +49,4 @@ async def sample_get_sample_query(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SampleQueryService_GetSampleQuery_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_get_sample_query_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_get_sample_query_sync.py index dffb9a6910fe..97b93cf476de 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_get_sample_query_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_get_sample_query_sync.py @@ -49,5 +49,4 @@ def sample_get_sample_query(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SampleQueryService_GetSampleQuery_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_import_sample_queries_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_import_sample_queries_async.py index 78b48bd9d6e5..53564210acfb 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_import_sample_queries_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_import_sample_queries_async.py @@ -57,5 +57,4 @@ async def sample_import_sample_queries(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SampleQueryService_ImportSampleQueries_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_import_sample_queries_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_import_sample_queries_sync.py index 4987e0887b3a..f48328d16752 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_import_sample_queries_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_import_sample_queries_sync.py @@ -57,5 +57,4 @@ def sample_import_sample_queries(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SampleQueryService_ImportSampleQueries_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_list_sample_queries_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_list_sample_queries_async.py index 76a682b8530f..f8468806412f 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_list_sample_queries_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_list_sample_queries_async.py @@ -50,5 +50,4 @@ async def sample_list_sample_queries(): async for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_SampleQueryService_ListSampleQueries_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_list_sample_queries_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_list_sample_queries_sync.py index 9577fb8109e5..587554a3785f 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_list_sample_queries_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_list_sample_queries_sync.py @@ -50,5 +50,4 @@ def sample_list_sample_queries(): for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_SampleQueryService_ListSampleQueries_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_update_sample_query_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_update_sample_query_async.py index 3e9d9f56cc50..93311530969e 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_update_sample_query_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_update_sample_query_async.py @@ -52,5 +52,4 @@ async def sample_update_sample_query(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SampleQueryService_UpdateSampleQuery_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_update_sample_query_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_update_sample_query_sync.py index 62c7f80626b7..720baa89d217 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_update_sample_query_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_service_update_sample_query_sync.py @@ -52,5 +52,4 @@ def sample_update_sample_query(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SampleQueryService_UpdateSampleQuery_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_create_sample_query_set_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_create_sample_query_set_async.py index f338fdc35da2..aa16a0142899 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_create_sample_query_set_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_create_sample_query_set_async.py @@ -54,5 +54,4 @@ async def sample_create_sample_query_set(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SampleQuerySetService_CreateSampleQuerySet_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_create_sample_query_set_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_create_sample_query_set_sync.py index 9760a607d2bc..8a646f7fb6a0 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_create_sample_query_set_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_create_sample_query_set_sync.py @@ -54,5 +54,4 @@ def sample_create_sample_query_set(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SampleQuerySetService_CreateSampleQuerySet_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_get_sample_query_set_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_get_sample_query_set_async.py index 5f6cba86bede..b8125c866f68 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_get_sample_query_set_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_get_sample_query_set_async.py @@ -49,5 +49,4 @@ async def sample_get_sample_query_set(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SampleQuerySetService_GetSampleQuerySet_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_get_sample_query_set_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_get_sample_query_set_sync.py index 33ebb9cfc54c..bdd757feb427 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_get_sample_query_set_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_get_sample_query_set_sync.py @@ -49,5 +49,4 @@ def sample_get_sample_query_set(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SampleQuerySetService_GetSampleQuerySet_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_list_sample_query_sets_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_list_sample_query_sets_async.py index c42dcd0a0555..252df087b32b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_list_sample_query_sets_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_list_sample_query_sets_async.py @@ -50,5 +50,4 @@ async def sample_list_sample_query_sets(): async for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_SampleQuerySetService_ListSampleQuerySets_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_list_sample_query_sets_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_list_sample_query_sets_sync.py index 64a7a70dfe03..53d28268fb19 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_list_sample_query_sets_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_list_sample_query_sets_sync.py @@ -50,5 +50,4 @@ def sample_list_sample_query_sets(): for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_SampleQuerySetService_ListSampleQuerySets_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_update_sample_query_set_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_update_sample_query_set_async.py index 73ef55e3a6cc..55b95ed7a61a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_update_sample_query_set_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_update_sample_query_set_async.py @@ -52,5 +52,4 @@ async def sample_update_sample_query_set(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SampleQuerySetService_UpdateSampleQuerySet_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_update_sample_query_set_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_update_sample_query_set_sync.py index 7c784b5ca9f0..1bdabbadfecb 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_update_sample_query_set_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_sample_query_set_service_update_sample_query_set_sync.py @@ -52,5 +52,4 @@ def sample_update_sample_query_set(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SampleQuerySetService_UpdateSampleQuerySet_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_create_schema_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_create_schema_async.py index 427db20bd2fa..2388d2329fdd 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_create_schema_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_create_schema_async.py @@ -54,5 +54,4 @@ async def sample_create_schema(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SchemaService_CreateSchema_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_create_schema_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_create_schema_sync.py index bfa62aea172d..8dfbb990b5b2 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_create_schema_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_create_schema_sync.py @@ -54,5 +54,4 @@ def sample_create_schema(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SchemaService_CreateSchema_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_delete_schema_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_delete_schema_async.py index 808a82dbd698..a67486ad00c4 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_delete_schema_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_delete_schema_async.py @@ -53,5 +53,4 @@ async def sample_delete_schema(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SchemaService_DeleteSchema_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_delete_schema_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_delete_schema_sync.py index f19a39e41eef..e200ef4c390b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_delete_schema_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_delete_schema_sync.py @@ -53,5 +53,4 @@ def sample_delete_schema(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SchemaService_DeleteSchema_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_get_schema_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_get_schema_async.py index 47d24083ffa2..16a84098a1b3 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_get_schema_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_get_schema_async.py @@ -49,5 +49,4 @@ async def sample_get_schema(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SchemaService_GetSchema_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_get_schema_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_get_schema_sync.py index f7ed43526433..9c3e3d5486c3 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_get_schema_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_get_schema_sync.py @@ -49,5 +49,4 @@ def sample_get_schema(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SchemaService_GetSchema_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_list_schemas_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_list_schemas_async.py index 64b4212220ee..2f5faa7fe6bb 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_list_schemas_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_list_schemas_async.py @@ -50,5 +50,4 @@ async def sample_list_schemas(): async for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_SchemaService_ListSchemas_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_list_schemas_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_list_schemas_sync.py index a50c8b8501f8..0567a4c61c79 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_list_schemas_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_list_schemas_sync.py @@ -50,5 +50,4 @@ def sample_list_schemas(): for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_SchemaService_ListSchemas_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_update_schema_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_update_schema_async.py index 52cc10cd47cf..1a717ee9c0b4 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_update_schema_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_update_schema_async.py @@ -39,7 +39,8 @@ async def sample_update_schema(): client = discoveryengine_v1beta.SchemaServiceAsyncClient() # Initialize request argument(s) - request = discoveryengine_v1beta.UpdateSchemaRequest() + request = discoveryengine_v1beta.UpdateSchemaRequest( + ) # Make the request operation = client.update_schema(request=request) @@ -51,5 +52,4 @@ async def sample_update_schema(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SchemaService_UpdateSchema_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_update_schema_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_update_schema_sync.py index 73a47f023035..b6cb1aef6649 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_update_schema_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_schema_service_update_schema_sync.py @@ -39,7 +39,8 @@ def sample_update_schema(): client = discoveryengine_v1beta.SchemaServiceClient() # Initialize request argument(s) - request = discoveryengine_v1beta.UpdateSchemaRequest() + request = discoveryengine_v1beta.UpdateSchemaRequest( + ) # Make the request operation = client.update_schema(request=request) @@ -51,5 +52,4 @@ def sample_update_schema(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SchemaService_UpdateSchema_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_service_search_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_service_search_async.py index 4cedf528afc9..ece458d7bca0 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_service_search_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_service_search_async.py @@ -50,5 +50,4 @@ async def sample_search(): async for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_SearchService_Search_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_service_search_lite_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_service_search_lite_async.py index c8989b5e097a..5130990de4cd 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_service_search_lite_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_service_search_lite_async.py @@ -50,5 +50,4 @@ async def sample_search_lite(): async for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_SearchService_SearchLite_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_service_search_lite_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_service_search_lite_sync.py index dcd84909276f..0bd3a27af21a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_service_search_lite_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_service_search_lite_sync.py @@ -50,5 +50,4 @@ def sample_search_lite(): for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_SearchService_SearchLite_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_service_search_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_service_search_sync.py index 434c0931e3a5..bfccb4bb655d 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_service_search_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_service_search_sync.py @@ -50,5 +50,4 @@ def sample_search(): for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_SearchService_Search_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_tuning_service_list_custom_models_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_tuning_service_list_custom_models_async.py index 5b7b8406b6c1..760a28302863 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_tuning_service_list_custom_models_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_tuning_service_list_custom_models_async.py @@ -49,5 +49,4 @@ async def sample_list_custom_models(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SearchTuningService_ListCustomModels_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_tuning_service_list_custom_models_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_tuning_service_list_custom_models_sync.py index 949578557b21..db937b3bedef 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_tuning_service_list_custom_models_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_tuning_service_list_custom_models_sync.py @@ -49,5 +49,4 @@ def sample_list_custom_models(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SearchTuningService_ListCustomModels_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_tuning_service_train_custom_model_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_tuning_service_train_custom_model_async.py index 9999df29fdde..cae8e4b1d16c 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_tuning_service_train_custom_model_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_tuning_service_train_custom_model_async.py @@ -53,5 +53,4 @@ async def sample_train_custom_model(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SearchTuningService_TrainCustomModel_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_tuning_service_train_custom_model_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_tuning_service_train_custom_model_sync.py index 6636c9a257d9..389fa72b8c14 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_tuning_service_train_custom_model_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_search_tuning_service_train_custom_model_sync.py @@ -53,5 +53,4 @@ def sample_train_custom_model(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SearchTuningService_TrainCustomModel_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_serving_config_service_get_serving_config_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_serving_config_service_get_serving_config_async.py index e8451788d212..4af54cfdafbc 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_serving_config_service_get_serving_config_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_serving_config_service_get_serving_config_async.py @@ -49,5 +49,4 @@ async def sample_get_serving_config(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ServingConfigService_GetServingConfig_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_serving_config_service_get_serving_config_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_serving_config_service_get_serving_config_sync.py index 4a4daedd24ab..69142e64eb82 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_serving_config_service_get_serving_config_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_serving_config_service_get_serving_config_sync.py @@ -49,5 +49,4 @@ def sample_get_serving_config(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ServingConfigService_GetServingConfig_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_serving_config_service_list_serving_configs_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_serving_config_service_list_serving_configs_async.py index 84b21a2afce9..47705f09f067 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_serving_config_service_list_serving_configs_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_serving_config_service_list_serving_configs_async.py @@ -50,5 +50,4 @@ async def sample_list_serving_configs(): async for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_ServingConfigService_ListServingConfigs_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_serving_config_service_list_serving_configs_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_serving_config_service_list_serving_configs_sync.py index 11d04027cd4a..bd462e0cc797 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_serving_config_service_list_serving_configs_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_serving_config_service_list_serving_configs_sync.py @@ -50,5 +50,4 @@ def sample_list_serving_configs(): for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_ServingConfigService_ListServingConfigs_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_serving_config_service_update_serving_config_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_serving_config_service_update_serving_config_async.py index 11e76ab7d6e6..ef634bc07d67 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_serving_config_service_update_serving_config_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_serving_config_service_update_serving_config_async.py @@ -54,5 +54,4 @@ async def sample_update_serving_config(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ServingConfigService_UpdateServingConfig_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_serving_config_service_update_serving_config_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_serving_config_service_update_serving_config_sync.py index 1ff247e58c27..3c8aa435e214 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_serving_config_service_update_serving_config_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_serving_config_service_update_serving_config_sync.py @@ -54,5 +54,4 @@ def sample_update_serving_config(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_ServingConfigService_UpdateServingConfig_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_create_session_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_create_session_async.py index 7f7b4e75dfc9..e304c248332b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_create_session_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_create_session_async.py @@ -49,5 +49,4 @@ async def sample_create_session(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SessionService_CreateSession_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_create_session_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_create_session_sync.py index 403b3434f056..abb16a2c770a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_create_session_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_create_session_sync.py @@ -49,5 +49,4 @@ def sample_create_session(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SessionService_CreateSession_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_get_session_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_get_session_async.py index a5cd1c472221..237762f0cc7b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_get_session_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_get_session_async.py @@ -49,5 +49,4 @@ async def sample_get_session(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SessionService_GetSession_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_get_session_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_get_session_sync.py index 22c996049f02..5abc90914f30 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_get_session_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_get_session_sync.py @@ -49,5 +49,4 @@ def sample_get_session(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SessionService_GetSession_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_list_sessions_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_list_sessions_async.py index 4374ffb9a3fa..3c8cc2b99022 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_list_sessions_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_list_sessions_async.py @@ -50,5 +50,4 @@ async def sample_list_sessions(): async for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_SessionService_ListSessions_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_list_sessions_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_list_sessions_sync.py index cf8481af68d6..bef0aaf5ba51 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_list_sessions_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_list_sessions_sync.py @@ -50,5 +50,4 @@ def sample_list_sessions(): for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_SessionService_ListSessions_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_update_session_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_update_session_async.py index 82e34a7bf413..a290d21f01b2 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_update_session_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_update_session_async.py @@ -39,7 +39,8 @@ async def sample_update_session(): client = discoveryengine_v1beta.SessionServiceAsyncClient() # Initialize request argument(s) - request = discoveryengine_v1beta.UpdateSessionRequest() + request = discoveryengine_v1beta.UpdateSessionRequest( + ) # Make the request response = await client.update_session(request=request) @@ -47,5 +48,4 @@ async def sample_update_session(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SessionService_UpdateSession_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_update_session_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_update_session_sync.py index e3e260fec9be..c85a58bf9e3f 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_update_session_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_session_service_update_session_sync.py @@ -39,7 +39,8 @@ def sample_update_session(): client = discoveryengine_v1beta.SessionServiceClient() # Initialize request argument(s) - request = discoveryengine_v1beta.UpdateSessionRequest() + request = discoveryengine_v1beta.UpdateSessionRequest( + ) # Make the request response = client.update_session(request=request) @@ -47,5 +48,4 @@ def sample_update_session(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SessionService_UpdateSession_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_batch_create_target_sites_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_batch_create_target_sites_async.py index 135230c74deb..adc5f4b0b5a0 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_batch_create_target_sites_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_batch_create_target_sites_async.py @@ -58,5 +58,4 @@ async def sample_batch_create_target_sites(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_BatchCreateTargetSites_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_batch_create_target_sites_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_batch_create_target_sites_sync.py index 31d83defa863..4953dc945de9 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_batch_create_target_sites_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_batch_create_target_sites_sync.py @@ -58,5 +58,4 @@ def sample_batch_create_target_sites(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_BatchCreateTargetSites_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_batch_verify_target_sites_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_batch_verify_target_sites_async.py index 3edadc61080c..ab71ae6a8c99 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_batch_verify_target_sites_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_batch_verify_target_sites_async.py @@ -53,5 +53,4 @@ async def sample_batch_verify_target_sites(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_BatchVerifyTargetSites_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_batch_verify_target_sites_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_batch_verify_target_sites_sync.py index c4dde7665253..c54a9ce03114 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_batch_verify_target_sites_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_batch_verify_target_sites_sync.py @@ -53,5 +53,4 @@ def sample_batch_verify_target_sites(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_BatchVerifyTargetSites_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_create_sitemap_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_create_sitemap_async.py index f185786cc94d..9a580866659b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_create_sitemap_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_create_sitemap_async.py @@ -57,5 +57,4 @@ async def sample_create_sitemap(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_CreateSitemap_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_create_sitemap_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_create_sitemap_sync.py index 5ec12cf1a470..55214f7da87d 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_create_sitemap_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_create_sitemap_sync.py @@ -57,5 +57,4 @@ def sample_create_sitemap(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_CreateSitemap_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_create_target_site_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_create_target_site_async.py index fb54592c7d96..2ae3ac2a3ddd 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_create_target_site_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_create_target_site_async.py @@ -57,5 +57,4 @@ async def sample_create_target_site(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_CreateTargetSite_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_create_target_site_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_create_target_site_sync.py index 5cc12a76178c..2564d8e60ae0 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_create_target_site_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_create_target_site_sync.py @@ -57,5 +57,4 @@ def sample_create_target_site(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_CreateTargetSite_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_delete_sitemap_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_delete_sitemap_async.py index 545ab48cea37..c3f2e6943e22 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_delete_sitemap_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_delete_sitemap_async.py @@ -53,5 +53,4 @@ async def sample_delete_sitemap(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_DeleteSitemap_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_delete_sitemap_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_delete_sitemap_sync.py index 5c91775dd685..738094c9eab5 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_delete_sitemap_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_delete_sitemap_sync.py @@ -53,5 +53,4 @@ def sample_delete_sitemap(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_DeleteSitemap_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_delete_target_site_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_delete_target_site_async.py index dab8cee9f877..1c30075c71a0 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_delete_target_site_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_delete_target_site_async.py @@ -53,5 +53,4 @@ async def sample_delete_target_site(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_DeleteTargetSite_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_delete_target_site_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_delete_target_site_sync.py index 7b5d7cf3286a..4fd73acb367e 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_delete_target_site_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_delete_target_site_sync.py @@ -53,5 +53,4 @@ def sample_delete_target_site(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_DeleteTargetSite_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_disable_advanced_site_search_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_disable_advanced_site_search_async.py index 5abbb88afdd1..ac3377978835 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_disable_advanced_site_search_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_disable_advanced_site_search_async.py @@ -53,5 +53,4 @@ async def sample_disable_advanced_site_search(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_DisableAdvancedSiteSearch_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_disable_advanced_site_search_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_disable_advanced_site_search_sync.py index 2f98f4a46b27..63b985e5543a 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_disable_advanced_site_search_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_disable_advanced_site_search_sync.py @@ -53,5 +53,4 @@ def sample_disable_advanced_site_search(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_DisableAdvancedSiteSearch_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_enable_advanced_site_search_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_enable_advanced_site_search_async.py index d344a6163fab..0cd027e5dee0 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_enable_advanced_site_search_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_enable_advanced_site_search_async.py @@ -53,5 +53,4 @@ async def sample_enable_advanced_site_search(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_EnableAdvancedSiteSearch_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_enable_advanced_site_search_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_enable_advanced_site_search_sync.py index 3b7b934415ed..672b69f9f297 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_enable_advanced_site_search_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_enable_advanced_site_search_sync.py @@ -53,5 +53,4 @@ def sample_enable_advanced_site_search(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_EnableAdvancedSiteSearch_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_fetch_domain_verification_status_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_fetch_domain_verification_status_async.py index 7d4d7e862beb..01b0aa1df3a4 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_fetch_domain_verification_status_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_fetch_domain_verification_status_async.py @@ -50,5 +50,4 @@ async def sample_fetch_domain_verification_status(): async for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_FetchDomainVerificationStatus_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_fetch_domain_verification_status_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_fetch_domain_verification_status_sync.py index 3443a814bcdd..51bc82cf404b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_fetch_domain_verification_status_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_fetch_domain_verification_status_sync.py @@ -50,5 +50,4 @@ def sample_fetch_domain_verification_status(): for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_FetchDomainVerificationStatus_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_fetch_sitemaps_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_fetch_sitemaps_async.py index e965eb9e552a..6f2c9d1d1512 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_fetch_sitemaps_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_fetch_sitemaps_async.py @@ -49,5 +49,4 @@ async def sample_fetch_sitemaps(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_FetchSitemaps_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_fetch_sitemaps_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_fetch_sitemaps_sync.py index 69715d08eadf..94a2086fdb2e 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_fetch_sitemaps_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_fetch_sitemaps_sync.py @@ -49,5 +49,4 @@ def sample_fetch_sitemaps(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_FetchSitemaps_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_get_site_search_engine_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_get_site_search_engine_async.py index 4f28066c931d..e9775b5cf3a3 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_get_site_search_engine_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_get_site_search_engine_async.py @@ -49,5 +49,4 @@ async def sample_get_site_search_engine(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_GetSiteSearchEngine_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_get_site_search_engine_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_get_site_search_engine_sync.py index 597de972e2b1..503d7e77915c 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_get_site_search_engine_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_get_site_search_engine_sync.py @@ -49,5 +49,4 @@ def sample_get_site_search_engine(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_GetSiteSearchEngine_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_get_target_site_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_get_target_site_async.py index ad8dd6cee6d0..cb3fb496aecd 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_get_target_site_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_get_target_site_async.py @@ -49,5 +49,4 @@ async def sample_get_target_site(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_GetTargetSite_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_get_target_site_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_get_target_site_sync.py index 11f87b7a66a1..8ad588c4086b 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_get_target_site_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_get_target_site_sync.py @@ -49,5 +49,4 @@ def sample_get_target_site(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_GetTargetSite_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_list_target_sites_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_list_target_sites_async.py index d61b900a353b..cf678adb4549 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_list_target_sites_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_list_target_sites_async.py @@ -50,5 +50,4 @@ async def sample_list_target_sites(): async for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_ListTargetSites_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_list_target_sites_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_list_target_sites_sync.py index f678f61698e2..8f4032b25f01 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_list_target_sites_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_list_target_sites_sync.py @@ -50,5 +50,4 @@ def sample_list_target_sites(): for response in page_result: print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_ListTargetSites_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_recrawl_uris_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_recrawl_uris_async.py index 2cb558283f83..83339b524223 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_recrawl_uris_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_recrawl_uris_async.py @@ -41,7 +41,7 @@ async def sample_recrawl_uris(): # Initialize request argument(s) request = discoveryengine_v1beta.RecrawlUrisRequest( site_search_engine="site_search_engine_value", - uris=["uris_value1", "uris_value2"], + uris=['uris_value1', 'uris_value2'], ) # Make the request @@ -54,5 +54,4 @@ async def sample_recrawl_uris(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_RecrawlUris_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_recrawl_uris_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_recrawl_uris_sync.py index 283dc2772dde..d6fd60e0fc9c 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_recrawl_uris_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_recrawl_uris_sync.py @@ -41,7 +41,7 @@ def sample_recrawl_uris(): # Initialize request argument(s) request = discoveryengine_v1beta.RecrawlUrisRequest( site_search_engine="site_search_engine_value", - uris=["uris_value1", "uris_value2"], + uris=['uris_value1', 'uris_value2'], ) # Make the request @@ -54,5 +54,4 @@ def sample_recrawl_uris(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_RecrawlUris_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_update_target_site_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_update_target_site_async.py index 49efea5e6824..7ed8b71fd2fc 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_update_target_site_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_update_target_site_async.py @@ -56,5 +56,4 @@ async def sample_update_target_site(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_UpdateTargetSite_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_update_target_site_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_update_target_site_sync.py index 5b723183b9c3..c3d05927ad83 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_update_target_site_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_site_search_engine_service_update_target_site_sync.py @@ -56,5 +56,4 @@ def sample_update_target_site(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_SiteSearchEngineService_UpdateTargetSite_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_collect_user_event_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_collect_user_event_async.py index 374ba980b5e4..ad5f120a828d 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_collect_user_event_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_collect_user_event_async.py @@ -50,5 +50,4 @@ async def sample_collect_user_event(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_UserEventService_CollectUserEvent_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_collect_user_event_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_collect_user_event_sync.py index 33c2084b7f77..e09f69b351bb 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_collect_user_event_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_collect_user_event_sync.py @@ -50,5 +50,4 @@ def sample_collect_user_event(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_UserEventService_CollectUserEvent_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_import_user_events_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_import_user_events_async.py index 3bc5651ff73e..5101e533497c 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_import_user_events_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_import_user_events_async.py @@ -58,5 +58,4 @@ async def sample_import_user_events(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_UserEventService_ImportUserEvents_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_import_user_events_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_import_user_events_sync.py index fb13f7b628e2..f300c1311e26 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_import_user_events_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_import_user_events_sync.py @@ -58,5 +58,4 @@ def sample_import_user_events(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_UserEventService_ImportUserEvents_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_purge_user_events_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_purge_user_events_async.py index 0522e19cac39..6807f93cbf14 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_purge_user_events_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_purge_user_events_async.py @@ -54,5 +54,4 @@ async def sample_purge_user_events(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_UserEventService_PurgeUserEvents_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_purge_user_events_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_purge_user_events_sync.py index 04c6ec6e2c39..88246dd8c12e 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_purge_user_events_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_purge_user_events_sync.py @@ -54,5 +54,4 @@ def sample_purge_user_events(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_UserEventService_PurgeUserEvents_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_write_user_event_async.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_write_user_event_async.py index 941bac6c5598..b75a2b50fcab 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_write_user_event_async.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_write_user_event_async.py @@ -49,5 +49,4 @@ async def sample_write_user_event(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_UserEventService_WriteUserEvent_async] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_write_user_event_sync.py b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_write_user_event_sync.py index cfd64343e18f..fb102e01689c 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_write_user_event_sync.py +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/discoveryengine_v1beta_generated_user_event_service_write_user_event_sync.py @@ -49,5 +49,4 @@ def sample_write_user_event(): # Handle the response print(response) - # [END discoveryengine_v1beta_generated_UserEventService_WriteUserEvent_sync] diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/snippet_metadata_google.cloud.discoveryengine.v1.json b/packages/google-cloud-discoveryengine/samples/generated_samples/snippet_metadata_google.cloud.discoveryengine.v1.json index 061eb71645ed..af933896aabc 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/snippet_metadata_google.cloud.discoveryengine.v1.json +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/snippet_metadata_google.cloud.discoveryengine.v1.json @@ -8,7 +8,7 @@ ], "language": "PYTHON", "name": "google-cloud-discoveryengine", - "version": "0.15.0" + "version": "0.4.0" }, "snippets": [ { diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/snippet_metadata_google.cloud.discoveryengine.v1alpha.json b/packages/google-cloud-discoveryengine/samples/generated_samples/snippet_metadata_google.cloud.discoveryengine.v1alpha.json index 8c60b426a4b1..b70a65161aa1 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/snippet_metadata_google.cloud.discoveryengine.v1alpha.json +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/snippet_metadata_google.cloud.discoveryengine.v1alpha.json @@ -8,7 +8,7 @@ ], "language": "PYTHON", "name": "google-cloud-discoveryengine", - "version": "0.15.0" + "version": "0.4.0" }, "snippets": [ { diff --git a/packages/google-cloud-discoveryengine/samples/generated_samples/snippet_metadata_google.cloud.discoveryengine.v1beta.json b/packages/google-cloud-discoveryengine/samples/generated_samples/snippet_metadata_google.cloud.discoveryengine.v1beta.json index 9c186ac39682..b2d0a745ffa9 100644 --- a/packages/google-cloud-discoveryengine/samples/generated_samples/snippet_metadata_google.cloud.discoveryengine.v1beta.json +++ b/packages/google-cloud-discoveryengine/samples/generated_samples/snippet_metadata_google.cloud.discoveryengine.v1beta.json @@ -8,7 +8,7 @@ ], "language": "PYTHON", "name": "google-cloud-discoveryengine", - "version": "0.15.0" + "version": "0.4.0" }, "snippets": [ {