# -*- coding: utf-8 -*- # Copyright 2024 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # import dataclasses import json # type: ignore import logging from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union import warnings from google.api_core import exceptions as core_exceptions from google.api_core import gapic_v1, rest_helpers, rest_streaming from google.api_core import retry as retries from google.auth import credentials as ga_credentials # type: ignore from google.auth.transport.requests import AuthorizedSession # type: ignore from google.protobuf import json_format from requests import __version__ as requests_version from google.ai.generativelanguage_v1beta2.types import discuss_service from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO from .rest_base import _BaseDiscussServiceRestTransport try: OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] except AttributeError: # pragma: NO COVER OptionalRetry = Union[retries.Retry, object, None] # type: ignore try: from google.api_core import client_logging # type: ignore CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER except ImportError: # pragma: NO COVER CLIENT_LOGGING_SUPPORTED = False _LOGGER = logging.getLogger(__name__) DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, grpc_version=None, rest_version=f"requests@{requests_version}", ) class DiscussServiceRestInterceptor: """Interceptor for DiscussService. Interceptors are used to manipulate requests, request metadata, and responses in arbitrary ways. Example use cases include: * Logging * Verifying requests according to service or custom semantics * Stripping extraneous information from responses These use cases and more can be enabled by injecting an instance of a custom subclass when constructing the DiscussServiceRestTransport. .. code-block:: python class MyCustomDiscussServiceInterceptor(DiscussServiceRestInterceptor): def pre_count_message_tokens(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata def post_count_message_tokens(self, response): logging.log(f"Received response: {response}") return response def pre_generate_message(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata def post_generate_message(self, response): logging.log(f"Received response: {response}") return response transport = DiscussServiceRestTransport(interceptor=MyCustomDiscussServiceInterceptor()) client = DiscussServiceClient(transport=transport) """ def pre_count_message_tokens( self, request: discuss_service.CountMessageTokensRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]], ) -> Tuple[ discuss_service.CountMessageTokensRequest, Sequence[Tuple[str, Union[str, bytes]]], ]: """Pre-rpc interceptor for count_message_tokens Override in a subclass to manipulate the request or metadata before they are sent to the DiscussService server. """ return request, metadata def post_count_message_tokens( self, response: discuss_service.CountMessageTokensResponse ) -> discuss_service.CountMessageTokensResponse: """Post-rpc interceptor for count_message_tokens Override in a subclass to manipulate the response after it is returned by the DiscussService server but before it is returned to user code. """ return response def pre_generate_message( self, request: discuss_service.GenerateMessageRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]], ) -> Tuple[ discuss_service.GenerateMessageRequest, Sequence[Tuple[str, Union[str, bytes]]] ]: """Pre-rpc interceptor for generate_message Override in a subclass to manipulate the request or metadata before they are sent to the DiscussService server. """ return request, metadata def post_generate_message( self, response: discuss_service.GenerateMessageResponse ) -> discuss_service.GenerateMessageResponse: """Post-rpc interceptor for generate_message Override in a subclass to manipulate the response after it is returned by the DiscussService server but before it is returned to user code. """ return response @dataclasses.dataclass class DiscussServiceRestStub: _session: AuthorizedSession _host: str _interceptor: DiscussServiceRestInterceptor class DiscussServiceRestTransport(_BaseDiscussServiceRestTransport): """REST backend synchronous transport for DiscussService. An API for using Generative Language Models (GLMs) in dialog applications. Also known as large language models (LLMs), this API provides models that are trained for multi-turn dialog. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation and call it. It sends JSON representations of protocol buffers over HTTP/1.1 """ def __init__( self, *, host: str = "generativelanguage.googleapis.com", credentials: Optional[ga_credentials.Credentials] = None, credentials_file: Optional[str] = None, scopes: Optional[Sequence[str]] = None, client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, quota_project_id: Optional[str] = None, client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, always_use_jwt_access: Optional[bool] = False, url_scheme: str = "https", interceptor: Optional[DiscussServiceRestInterceptor] = None, api_audience: Optional[str] = None, ) -> None: """Instantiate the transport. Args: host (Optional[str]): The hostname to connect to (default: 'generativelanguage.googleapis.com'). credentials (Optional[google.auth.credentials.Credentials]): The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. credentials_file (Optional[str]): A file with credentials that can be loaded with :func:`google.auth.load_credentials_from_file`. This argument is ignored if ``channel`` is provided. scopes (Optional(Sequence[str])): A list of scopes. This argument is ignored if ``channel`` is provided. client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client certificate to configure mutual TLS HTTP channel. It is ignored if ``channel`` is provided. quota_project_id (Optional[str]): An optional project to use for billing and quota. client_info (google.api_core.gapic_v1.client_info.ClientInfo): The client info used to send a user-agent string along with API requests. If ``None``, then default info will be used. Generally, you only need to set this if you are developing your own client library. always_use_jwt_access (Optional[bool]): Whether self signed JWT should be used for service account credentials. url_scheme: the protocol scheme for the API endpoint. Normally "https", but for testing or local servers, "http" can be specified. """ # Run the base constructor # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the # credentials object super().__init__( host=host, credentials=credentials, client_info=client_info, always_use_jwt_access=always_use_jwt_access, url_scheme=url_scheme, api_audience=api_audience, ) self._session = AuthorizedSession( self._credentials, default_host=self.DEFAULT_HOST ) if client_cert_source_for_mtls: self._session.configure_mtls_channel(client_cert_source_for_mtls) self._interceptor = interceptor or DiscussServiceRestInterceptor() self._prep_wrapped_messages(client_info) class _CountMessageTokens( _BaseDiscussServiceRestTransport._BaseCountMessageTokens, DiscussServiceRestStub ): def __hash__(self): return hash("DiscussServiceRestTransport.CountMessageTokens") @staticmethod def _get_response( host, metadata, query_params, session, timeout, transcoded_request, body=None, ): uri = transcoded_request["uri"] method = transcoded_request["method"] headers = dict(metadata) headers["Content-Type"] = "application/json" response = getattr(session, method)( "{host}{uri}".format(host=host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), data=body, ) return response def __call__( self, request: discuss_service.CountMessageTokensRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> discuss_service.CountMessageTokensResponse: r"""Call the count message tokens method over HTTP. Args: request (~.discuss_service.CountMessageTokensRequest): The request object. Counts the number of tokens in the ``prompt`` sent to a model. Models may tokenize text differently, so each model may return a different ``token_count``. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. Returns: ~.discuss_service.CountMessageTokensResponse: A response from ``CountMessageTokens``. It returns the model's ``token_count`` for the ``prompt``. """ http_options = ( _BaseDiscussServiceRestTransport._BaseCountMessageTokens._get_http_options() ) request, metadata = self._interceptor.pre_count_message_tokens( request, metadata ) transcoded_request = _BaseDiscussServiceRestTransport._BaseCountMessageTokens._get_transcoded_request( http_options, request ) body = _BaseDiscussServiceRestTransport._BaseCountMessageTokens._get_request_body_json( transcoded_request ) # Jsonify the query params query_params = _BaseDiscussServiceRestTransport._BaseCountMessageTokens._get_query_params_json( transcoded_request ) if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( logging.DEBUG ): # pragma: NO COVER request_url = "{host}{uri}".format( host=self._host, uri=transcoded_request["uri"] ) method = transcoded_request["method"] try: request_payload = type(request).to_json(request) except: request_payload = None http_request = { "payload": request_payload, "requestMethod": method, "requestUrl": request_url, "headers": dict(metadata), } _LOGGER.debug( f"Sending request for google.ai.generativelanguage_v1beta2.DiscussServiceClient.CountMessageTokens", extra={ "serviceName": "google.ai.generativelanguage.v1beta2.DiscussService", "rpcName": "CountMessageTokens", "httpRequest": http_request, "metadata": http_request["headers"], }, ) # Send the request response = DiscussServiceRestTransport._CountMessageTokens._get_response( self._host, metadata, query_params, self._session, timeout, transcoded_request, body, ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. if response.status_code >= 400: raise core_exceptions.from_http_response(response) # Return the response resp = discuss_service.CountMessageTokensResponse() pb_resp = discuss_service.CountMessageTokensResponse.pb(resp) json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) resp = self._interceptor.post_count_message_tokens(resp) if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( logging.DEBUG ): # pragma: NO COVER try: response_payload = ( discuss_service.CountMessageTokensResponse.to_json(response) ) except: response_payload = None http_response = { "payload": response_payload, "headers": dict(response.headers), "status": response.status_code, } _LOGGER.debug( "Received response for google.ai.generativelanguage_v1beta2.DiscussServiceClient.count_message_tokens", extra={ "serviceName": "google.ai.generativelanguage.v1beta2.DiscussService", "rpcName": "CountMessageTokens", "metadata": http_response["headers"], "httpResponse": http_response, }, ) return resp class _GenerateMessage( _BaseDiscussServiceRestTransport._BaseGenerateMessage, DiscussServiceRestStub ): def __hash__(self): return hash("DiscussServiceRestTransport.GenerateMessage") @staticmethod def _get_response( host, metadata, query_params, session, timeout, transcoded_request, body=None, ): uri = transcoded_request["uri"] method = transcoded_request["method"] headers = dict(metadata) headers["Content-Type"] = "application/json" response = getattr(session, method)( "{host}{uri}".format(host=host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), data=body, ) return response def __call__( self, request: discuss_service.GenerateMessageRequest, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> discuss_service.GenerateMessageResponse: r"""Call the generate message method over HTTP. Args: request (~.discuss_service.GenerateMessageRequest): The request object. Request to generate a message response from the model. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. Returns: ~.discuss_service.GenerateMessageResponse: The response from the model. This includes candidate messages and conversation history in the form of chronologically-ordered messages. """ http_options = ( _BaseDiscussServiceRestTransport._BaseGenerateMessage._get_http_options() ) request, metadata = self._interceptor.pre_generate_message( request, metadata ) transcoded_request = _BaseDiscussServiceRestTransport._BaseGenerateMessage._get_transcoded_request( http_options, request ) body = _BaseDiscussServiceRestTransport._BaseGenerateMessage._get_request_body_json( transcoded_request ) # Jsonify the query params query_params = _BaseDiscussServiceRestTransport._BaseGenerateMessage._get_query_params_json( transcoded_request ) if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( logging.DEBUG ): # pragma: NO COVER request_url = "{host}{uri}".format( host=self._host, uri=transcoded_request["uri"] ) method = transcoded_request["method"] try: request_payload = type(request).to_json(request) except: request_payload = None http_request = { "payload": request_payload, "requestMethod": method, "requestUrl": request_url, "headers": dict(metadata), } _LOGGER.debug( f"Sending request for google.ai.generativelanguage_v1beta2.DiscussServiceClient.GenerateMessage", extra={ "serviceName": "google.ai.generativelanguage.v1beta2.DiscussService", "rpcName": "GenerateMessage", "httpRequest": http_request, "metadata": http_request["headers"], }, ) # Send the request response = DiscussServiceRestTransport._GenerateMessage._get_response( self._host, metadata, query_params, self._session, timeout, transcoded_request, body, ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. if response.status_code >= 400: raise core_exceptions.from_http_response(response) # Return the response resp = discuss_service.GenerateMessageResponse() pb_resp = discuss_service.GenerateMessageResponse.pb(resp) json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) resp = self._interceptor.post_generate_message(resp) if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( logging.DEBUG ): # pragma: NO COVER try: response_payload = discuss_service.GenerateMessageResponse.to_json( response ) except: response_payload = None http_response = { "payload": response_payload, "headers": dict(response.headers), "status": response.status_code, } _LOGGER.debug( "Received response for google.ai.generativelanguage_v1beta2.DiscussServiceClient.generate_message", extra={ "serviceName": "google.ai.generativelanguage.v1beta2.DiscussService", "rpcName": "GenerateMessage", "metadata": http_response["headers"], "httpResponse": http_response, }, ) return resp @property def count_message_tokens( self, ) -> Callable[ [discuss_service.CountMessageTokensRequest], discuss_service.CountMessageTokensResponse, ]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast return self._CountMessageTokens(self._session, self._host, self._interceptor) # type: ignore @property def generate_message( self, ) -> Callable[ [discuss_service.GenerateMessageRequest], discuss_service.GenerateMessageResponse, ]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast return self._GenerateMessage(self._session, self._host, self._interceptor) # type: ignore @property def kind(self) -> str: return "rest" def close(self): self._session.close() __all__ = ("DiscussServiceRestTransport",)