QuestionServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dataqna_v1alpha.services.question_service.transports.base.QuestionServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Service to interpret natural language queries. The service allows to
create Question resources that are interpreted and are filled
with one or more interpretations if the question could be
interpreted. Once a Question resource is created and has at
least one interpretation, an interpretation can be chosen for
execution, which triggers a query to the backend (for BigQuery, it
will create a job). Upon successful execution of that
interpretation, backend specific information will be returned so
that the client can retrieve the results from the backend.
The Question resources are named
projects/*/locations/*/questions/*.
The Question resource has a singletion sub-resource
UserFeedback named
projects/*/locations/*/questions/*/userFeedback, which allows
access to user feedback.
Inheritance
builtins.object > QuestionServiceClientProperties
transport
Returns the transport used by the client instance.
| Type | Description |
| QuestionServiceTransport | The transport used by the client instance. |
Methods
QuestionServiceClient
QuestionServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dataqna_v1alpha.services.question_service.transports.base.QuestionServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiates the question service client.
| Name | Description |
| 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. |
| transport |
Union[str, QuestionServiceTransport]
The transport to use. If set to None, a transport is chosen automatically. |
| client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
| 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 |
| Type | Description |
| google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)Releases underlying transport's resources.
common_billing_account_path
common_billing_account_path(billing_account: str)Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)Returns a fully-qualified project string.
create_question
create_question(request: Optional[Union[google.cloud.dataqna_v1alpha.types.question_service.CreateQuestionRequest, dict]] = None, *, parent: Optional[str] = None, question: Optional[google.cloud.dataqna_v1alpha.types.question.Question] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Creates a question.
from google.cloud import dataqna_v1alpha
def sample_create_question():
# Create a client
client = dataqna_v1alpha.QuestionServiceClient()
# Initialize request argument(s)
question = dataqna_v1alpha.Question()
question.scopes = ['scopes_value_1', 'scopes_value_2']
question.query = "query_value"
request = dataqna_v1alpha.CreateQuestionRequest(
parent="parent_value",
question=question,
)
# Make the request
response = client.create_question(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.dataqna_v1alpha.types.CreateQuestionRequest, dict]
The request object. Request to create a question resource. |
| parent |
str
Required. The name of the project this data source reference belongs to. Example: |
| question |
google.cloud.dataqna_v1alpha.types.Question
Required. The question to create. This corresponds to the |
| 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, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.dataqna_v1alpha.types.Question | The question resource represents a natural language query, its settings, understanding generated by the system, and answer retrieval status. A question cannot be modified. |
execute_question
execute_question(request: Optional[Union[google.cloud.dataqna_v1alpha.types.question_service.ExecuteQuestionRequest, dict]] = None, *, name: Optional[str] = None, interpretation_index: Optional[int] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Executes an interpretation.
from google.cloud import dataqna_v1alpha
def sample_execute_question():
# Create a client
client = dataqna_v1alpha.QuestionServiceClient()
# Initialize request argument(s)
request = dataqna_v1alpha.ExecuteQuestionRequest(
name="name_value",
interpretation_index=2159,
)
# Make the request
response = client.execute_question(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.dataqna_v1alpha.types.ExecuteQuestionRequest, dict]
The request object. Request to execute an interpretation. |
| name |
str
Required. The unique identifier for the question. Example: |
| interpretation_index |
int
Required. Index of the interpretation to execute. This corresponds to the |
| 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, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.dataqna_v1alpha.types.Question | The question resource represents a natural language query, its settings, understanding generated by the system, and answer retrieval status. A question cannot be modified. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
| filename |
str
The path to the service account private key json file. |
| Type | Description |
| QuestionServiceClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
| Name | Description |
| info |
dict
The service account private key info. |
| Type | Description |
| QuestionServiceClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
| filename |
str
The path to the service account private key json file. |
| Type | Description |
| QuestionServiceClient | The constructed client. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
| Name | Description |
| client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
| Type | Description |
| google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
| Type | Description |
| Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_question
get_question(request: Optional[Union[google.cloud.dataqna_v1alpha.types.question_service.GetQuestionRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets a previously created question.
from google.cloud import dataqna_v1alpha
def sample_get_question():
# Create a client
client = dataqna_v1alpha.QuestionServiceClient()
# Initialize request argument(s)
request = dataqna_v1alpha.GetQuestionRequest(
name="name_value",
)
# Make the request
response = client.get_question(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.dataqna_v1alpha.types.GetQuestionRequest, dict]
The request object. A request to get a previously created question. |
| name |
str
Required. The unique identifier for the question. Example: |
| 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, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.dataqna_v1alpha.types.Question | The question resource represents a natural language query, its settings, understanding generated by the system, and answer retrieval status. A question cannot be modified. |
get_user_feedback
get_user_feedback(request: Optional[Union[google.cloud.dataqna_v1alpha.types.question_service.GetUserFeedbackRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets previously created user feedback.
from google.cloud import dataqna_v1alpha
def sample_get_user_feedback():
# Create a client
client = dataqna_v1alpha.QuestionServiceClient()
# Initialize request argument(s)
request = dataqna_v1alpha.GetUserFeedbackRequest(
name="name_value",
)
# Make the request
response = client.get_user_feedback(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.dataqna_v1alpha.types.GetUserFeedbackRequest, dict]
The request object. Request to get user feedback. |
| name |
str
Required. The unique identifier for the user feedback. User feedback is a singleton resource on a Question. Example: |
| 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, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.dataqna_v1alpha.types.UserFeedback | Feedback provided by a user. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)Parse a project path into its component segments.
parse_question_path
parse_question_path(path: str)Parses a question path into its component segments.
parse_user_feedback_path
parse_user_feedback_path(path: str)Parses a user_feedback path into its component segments.
question_path
question_path(project: str, location: str, question: str)Returns a fully-qualified question string.
update_user_feedback
update_user_feedback(request: Optional[Union[google.cloud.dataqna_v1alpha.types.question_service.UpdateUserFeedbackRequest, dict]] = None, *, user_feedback: Optional[google.cloud.dataqna_v1alpha.types.user_feedback.UserFeedback] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Updates user feedback. This creates user feedback if there was none before (upsert).
from google.cloud import dataqna_v1alpha
def sample_update_user_feedback():
# Create a client
client = dataqna_v1alpha.QuestionServiceClient()
# Initialize request argument(s)
user_feedback = dataqna_v1alpha.UserFeedback()
user_feedback.name = "name_value"
request = dataqna_v1alpha.UpdateUserFeedbackRequest(
user_feedback=user_feedback,
)
# Make the request
response = client.update_user_feedback(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.dataqna_v1alpha.types.UpdateUserFeedbackRequest, dict]
The request object. Request to updates user feedback. |
| user_feedback |
google.cloud.dataqna_v1alpha.types.UserFeedback
Required. The user feedback to update. This can be called even if there is no user feedback so far. The feedback's name field is used to identify the user feedback (and the corresponding question) to update. This corresponds to the |
| update_mask |
google.protobuf.field_mask_pb2.FieldMask
The list of fields to be updated. This corresponds to the |
| 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, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.dataqna_v1alpha.types.UserFeedback | Feedback provided by a user. |
user_feedback_path
user_feedback_path(project: str, location: str, question: str)Returns a fully-qualified user_feedback string.