feat: [google-cloud-discoveryengine] promote search tuning service to…

… v1 (#13049) - [ ] Regenerate this pull request now. BEGIN_COMMIT_OVERRIDE feat(v1): promote search tuning service to v1 feat(v1): promot user event purge to v1 feat(v1): return structured document info in answers feat(v1): return index status in document feat(v1): support batch documents purge with GCS input feat(v1): support batch get documents metadata by uri patterns feat(v1): return joined status in user event docs(v1): keep the API doc up-to-date with recent changes feat(v1beta): support natural language understanding in search feat(v1beta): allow set relevance threshold on search feat(v1beta): support one box search feat(v1beta): return structured document info in answers feat(v1beta): return index status in document feat(v1beta): support batch documents purge with GCS input feat(v1beta): support batch get documents metadata by uri patterns feat(v1beta): return joined status in user event docs(v1beta): keep the API doc up-to-date with recent changes feat(v1alpha): return index status in document feat(v1alpha): support creating workspace search data stores feat(v1alpha): support batch get documents metadata by uri patterns feat(v1alpha): return query segment in NL query understanding feat(v1alpha): return joined status in user event docs(v1alpha): keep the API doc up-to-date with recent changes END_COMMIT_OVERRIDE PiperOrigin-RevId: 670771871 Source-Link: googleapis/googleapis@5314818 Source-Link: googleapis/googleapis-gen@85cebbb Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRpc2NvdmVyeWVuZ2luZS8uT3dsQm90LnlhbWwiLCJoIjoiODVjZWJiYmU1YTEwMGZhMTA2ZDkzZGFjMzRkYWNiZjE5YTNhNmE0OCJ9 BEGIN_NESTED_COMMIT feat: [google-cloud-discoveryengine] support natural language understanding in search feat: allow set relevance threshold on search feat: support one box search feat: return structured document info in answers feat: return index status in document feat: support batch documents purge with GCS input feat: support batch get documents metadata by uri patterns feat: return joined status in user event docs: keep the API doc up-to-date with recent changes PiperOrigin-RevId: 670771759 Source-Link: googleapis/googleapis@6cb0a97 Source-Link: googleapis/googleapis-gen@ad7bcde Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRpc2NvdmVyeWVuZ2luZS8uT3dsQm90LnlhbWwiLCJoIjoiYWQ3YmNkZTkxNWRjNTUwNThkZjMyMDc3YTQ0ZGU3YTVjZjVjYjFmYyJ9 END_NESTED_COMMIT BEGIN_NESTED_COMMIT feat: [google-cloud-discoveryengine] return index status in document feat: support creating workspace search data stores feat: support batch get documents metadata by uri patterns feat: return query segment in NL query understanding feat: return joined status in user event docs: keep the API doc up-to-date with recent changes PiperOrigin-RevId: 670770678 Source-Link: googleapis/googleapis@ce9d188 Source-Link: googleapis/googleapis-gen@a0866c4 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRpc2NvdmVyeWVuZ2luZS8uT3dsQm90LnlhbWwiLCJoIjoiYTA4NjZjNGNkMGIyMGUwYWI1MDI1OTBiNTIyOGMxOTdlNDJkYzE3ZSJ9 END_NESTED_COMMIT --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
googleapis · Sep 4, 2024 · 51947fb · 51947fb
1 parent c1252ca
commit 51947fb
Show file tree

Hide file tree

Showing 132 changed files with 18,228 additions and 2,219 deletions.
diff --git a/.../google-cloud-discoveryengine/docs/discoveryengine_v1/search_tuning_service.rst b/.../google-cloud-discoveryengine/docs/discoveryengine_v1/search_tuning_service.rst
@@ -0,0 +1,6 @@
+SearchTuningService
+-------------------------------------
+
+.. automodule:: google.cloud.discoveryengine_v1.services.search_tuning_service
+    :members:
+    :inherited-members:
diff --git a/packages/google-cloud-discoveryengine/docs/discoveryengine_v1/services_.rst b/packages/google-cloud-discoveryengine/docs/discoveryengine_v1/services_.rst
@@ -15,5 +15,6 @@ Services for Google Cloud Discoveryengine v1 API
     recommendation_service
     schema_service
     search_service
+    search_tuning_service
     site_search_engine_service
     user_event_service
diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine/__init__.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine/__init__.py
@@ -208,6 +208,8 @@
     DocumentProcessingConfig,
 )
 from google.cloud.discoveryengine_v1beta.types.document_service import (
+    BatchGetDocumentsMetadataRequest,
+    BatchGetDocumentsMetadataResponse,
     CreateDocumentRequest,
     DeleteDocumentRequest,
     GetDocumentRequest,
@@ -289,6 +291,7 @@
     PurgeDocumentsMetadata,
     PurgeDocumentsRequest,
     PurgeDocumentsResponse,
+    PurgeErrorConfig,
     PurgeSuggestionDenyListEntriesMetadata,
     PurgeSuggestionDenyListEntriesRequest,
     PurgeSuggestionDenyListEntriesResponse,
@@ -501,6 +504,8 @@
     "UpdateDataStoreRequest",
     "Document",
     "DocumentProcessingConfig",
+    "BatchGetDocumentsMetadataRequest",
+    "BatchGetDocumentsMetadataResponse",
     "CreateDocumentRequest",
     "DeleteDocumentRequest",
     "GetDocumentRequest",
@@ -569,6 +574,7 @@
     "PurgeDocumentsMetadata",
     "PurgeDocumentsRequest",
     "PurgeDocumentsResponse",
+    "PurgeErrorConfig",
     "PurgeSuggestionDenyListEntriesMetadata",
     "PurgeSuggestionDenyListEntriesRequest",
     "PurgeSuggestionDenyListEntriesResponse",

diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/__init__.py b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/__init__.py
@@ -45,6 +45,10 @@
 )
 from .services.schema_service import SchemaServiceAsyncClient, SchemaServiceClient
 from .services.search_service import SearchServiceAsyncClient, SearchServiceClient
+from .services.search_tuning_service import (
+    SearchTuningServiceAsyncClient,
+    SearchTuningServiceClient,
+)
 from .services.site_search_engine_service import (
     SiteSearchEngineServiceAsyncClient,
     SiteSearchEngineServiceClient,
@@ -102,6 +106,7 @@
     UpdateConversationRequest,
     UpdateSessionRequest,
 )
+from .types.custom_tuning_model import CustomTuningModel
 from .types.data_store import DataStore
 from .types.data_store_service import (
     CreateDataStoreMetadata,
@@ -116,6 +121,8 @@
 from .types.document import Document
 from .types.document_processing_config import DocumentProcessingConfig
 from .types.document_service import (
+    BatchGetDocumentsMetadataRequest,
+    BatchGetDocumentsMetadataResponse,
     CreateDocumentRequest,
     DeleteDocumentRequest,
     GetDocumentRequest,
@@ -173,9 +180,13 @@
     PurgeDocumentsMetadata,
     PurgeDocumentsRequest,
     PurgeDocumentsResponse,
+    PurgeErrorConfig,
     PurgeSuggestionDenyListEntriesMetadata,
     PurgeSuggestionDenyListEntriesRequest,
     PurgeSuggestionDenyListEntriesResponse,
+    PurgeUserEventsMetadata,
+    PurgeUserEventsRequest,
+    PurgeUserEventsResponse,
 )
 from .types.rank_service import RankingRecord, RankRequest, RankResponse
 from .types.recommendation_service import RecommendRequest, RecommendResponse
@@ -192,6 +203,13 @@
     UpdateSchemaRequest,
 )
 from .types.search_service import SearchRequest, SearchResponse
+from .types.search_tuning_service import (
+    ListCustomModelsRequest,
+    ListCustomModelsResponse,
+    TrainCustomModelMetadata,
+    TrainCustomModelRequest,
+    TrainCustomModelResponse,
+)
 from .types.session import Query, Session
 from .types.site_search_engine import SiteSearchEngine, SiteVerificationInfo, TargetSite
 from .types.site_search_engine_service import (
@@ -248,6 +266,7 @@
     "RecommendationServiceAsyncClient",
     "SchemaServiceAsyncClient",
     "SearchServiceAsyncClient",
+    "SearchTuningServiceAsyncClient",
     "SiteSearchEngineServiceAsyncClient",
     "UserEventServiceAsyncClient",
     "AlloyDbSource",
@@ -257,6 +276,8 @@
     "BatchCreateTargetSiteMetadata",
     "BatchCreateTargetSitesRequest",
     "BatchCreateTargetSitesResponse",
+    "BatchGetDocumentsMetadataRequest",
+    "BatchGetDocumentsMetadataResponse",
     "BatchVerifyTargetSitesMetadata",
     "BatchVerifyTargetSitesRequest",
     "BatchVerifyTargetSitesResponse",
@@ -296,6 +317,7 @@
     "CreateTargetSiteMetadata",
     "CreateTargetSiteRequest",
     "CustomAttribute",
+    "CustomTuningModel",
     "DataStore",
     "DataStoreServiceClient",
     "DeleteControlRequest",
@@ -359,6 +381,8 @@
     "ListControlsResponse",
     "ListConversationsRequest",
     "ListConversationsResponse",
+    "ListCustomModelsRequest",
+    "ListCustomModelsResponse",
     "ListDataStoresRequest",
     "ListDataStoresResponse",
     "ListDocumentsRequest",
@@ -384,9 +408,13 @@
     "PurgeDocumentsMetadata",
     "PurgeDocumentsRequest",
     "PurgeDocumentsResponse",
+    "PurgeErrorConfig",
     "PurgeSuggestionDenyListEntriesMetadata",
     "PurgeSuggestionDenyListEntriesRequest",
     "PurgeSuggestionDenyListEntriesResponse",
+    "PurgeUserEventsMetadata",
+    "PurgeUserEventsRequest",
+    "PurgeUserEventsResponse",
     "Query",
     "RankRequest",
     "RankResponse",
@@ -407,6 +435,7 @@
     "SearchResponse",
     "SearchServiceClient",
     "SearchTier",
+    "SearchTuningServiceClient",
     "SearchUseCase",
     "Session",
     "SiteSearchEngine",
@@ -417,6 +446,9 @@
     "SuggestionDenyListEntry",
     "TargetSite",
     "TextInput",
+    "TrainCustomModelMetadata",
+    "TrainCustomModelRequest",
+    "TrainCustomModelResponse",
     "TransactionInfo",
     "UpdateControlRequest",
     "UpdateConversationRequest",

diff --git a/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/gapic_metadata.json b/packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1/gapic_metadata.json
@@ -506,6 +506,11 @@
         "grpc": {
           "libraryClient": "DocumentServiceClient",
           "rpcs": {
+            "BatchGetDocumentsMetadata": {
+              "methods": [
+                "batch_get_documents_metadata"
+              ]
+            },
             "CreateDocument": {
               "methods": [
                 "create_document"
@@ -546,6 +551,11 @@
         "grpc-async": {
           "libraryClient": "DocumentServiceAsyncClient",
           "rpcs": {
+            "BatchGetDocumentsMetadata": {
+              "methods": [
+                "batch_get_documents_metadata"
+              ]
+            },
             "CreateDocument": {
               "methods": [
                 "create_document"
@@ -586,6 +596,11 @@
         "rest": {
           "libraryClient": "DocumentServiceClient",
           "rpcs": {
+            "BatchGetDocumentsMetadata": {
+              "methods": [
+                "batch_get_documents_metadata"
+              ]
+            },
             "CreateDocument": {
               "methods": [
                 "create_document"
@@ -983,6 +998,55 @@
         }
       }
     },
+    "SearchTuningService": {
+      "clients": {
+        "grpc": {
+          "libraryClient": "SearchTuningServiceClient",
+          "rpcs": {
+            "ListCustomModels": {
+              "methods": [
+                "list_custom_models"
+              ]
+            },
+            "TrainCustomModel": {
+              "methods": [
+                "train_custom_model"
+              ]
+            }
+          }
+        },
+        "grpc-async": {
+          "libraryClient": "SearchTuningServiceAsyncClient",
+          "rpcs": {
+            "ListCustomModels": {
+              "methods": [
+                "list_custom_models"
+              ]
+            },
+            "TrainCustomModel": {
+              "methods": [
+                "train_custom_model"
+              ]
+            }
+          }
+        },
+        "rest": {
+          "libraryClient": "SearchTuningServiceClient",
+          "rpcs": {
+            "ListCustomModels": {
+              "methods": [
+                "list_custom_models"
+              ]
+            },
+            "TrainCustomModel": {
+              "methods": [
+                "train_custom_model"
+              ]
+            }
+          }
+        }
+      }
+    },
     "SiteSearchEngineService": {
       "clients": {
         "grpc": {
@@ -1197,6 +1261,11 @@
                 "import_user_events"
               ]
             },
+            "PurgeUserEvents": {
+              "methods": [
+                "purge_user_events"
+              ]
+            },
             "WriteUserEvent": {
               "methods": [
                 "write_user_event"
@@ -1217,6 +1286,11 @@
                 "import_user_events"
               ]
             },
+            "PurgeUserEvents": {
+              "methods": [
+                "purge_user_events"
+              ]
+            },
             "WriteUserEvent": {
               "methods": [
                 "write_user_event"
@@ -1237,6 +1311,11 @@
                 "import_user_events"
               ]
             },
+            "PurgeUserEvents": {
+              "methods": [
+                "purge_user_events"
+              ]
+            },
             "WriteUserEvent": {
               "methods": [
                 "write_user_event"

diff --git a/...veryengine/google/cloud/discoveryengine_v1/services/completion_service/transports/rest.py b/...veryengine/google/cloud/discoveryengine_v1/services/completion_service/transports/rest.py
@@ -490,6 +490,10 @@ def operations_client(self) -> operations_v1.AbstractOperationsClient:
                         "method": "get",
                         "uri": "/v1/{name=projects/*/locations/*/dataStores/*/operations/*}",
                     },
+                    {
+                        "method": "get",
+                        "uri": "/v1/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}",
+                    },
                     {
                         "method": "get",
                         "uri": "/v1/{name=projects/*/locations/*/operations/*}",
@@ -552,6 +556,10 @@ def operations_client(self) -> operations_v1.AbstractOperationsClient:
                         "method": "get",
                         "uri": "/v1/{name=projects/*/locations/*/dataStores/*}/operations",
                     },
+                    {
+                        "method": "get",
+                        "uri": "/v1/{name=projects/*/locations/*/identity_mapping_stores/*}/operations",
+                    },
                     {
                         "method": "get",
                         "uri": "/v1/{name=projects/*/locations/*}/operations",
@@ -1302,6 +1310,10 @@ def __call__(
                     "method": "get",
                     "uri": "/v1/{name=projects/*/locations/*/dataStores/*/operations/*}",
                 },
+                {
+                    "method": "get",
+                    "uri": "/v1/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}",
+                },
                 {
                     "method": "get",
                     "uri": "/v1/{name=projects/*/locations/*/operations/*}",
@@ -1424,6 +1436,10 @@ def __call__(
                     "method": "get",
                     "uri": "/v1/{name=projects/*/locations/*/dataStores/*}/operations",
                 },
+                {
+                    "method": "get",
+                    "uri": "/v1/{name=projects/*/locations/*/identity_mapping_stores/*}/operations",
+                },
                 {
                     "method": "get",
                     "uri": "/v1/{name=projects/*/locations/*}/operations",

diff --git a/...-discoveryengine/google/cloud/discoveryengine_v1/services/control_service/async_client.py b/...-discoveryengine/google/cloud/discoveryengine_v1/services/control_service/async_client.py
@@ -358,8 +358,9 @@ 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][] to be
-                   considered at serving time. Permitted actions
+                   Must be attached to a
+                   [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig]
+                   to be considered at serving time. Permitted actions
                    dependent on SolutionType.
 
         """
@@ -590,8 +591,9 @@ 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][] to be
-                   considered at serving time. Permitted actions
+                   Must be attached to a
+                   [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig]
+                   to be considered at serving time. Permitted actions
                    dependent on SolutionType.
 
         """
@@ -702,8 +704,9 @@ 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][] to be
-                   considered at serving time. Permitted actions
+                   Must be attached to a
+                   [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig]
+                   to be considered at serving time. Permitted actions
                    dependent on SolutionType.
 
         """