Class QuestionServiceAsyncClient

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 > QuestionServiceAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
QuestionServiceTransportThe transport used by the client instance.

Methods

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

Parameter
NameDescription
billing_account str

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

Parameter
NameDescription
folder str

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

Parameters
NameDescription
project str
location str

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

Parameter
NameDescription
organization str

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

Parameter
NameDescription
project str

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, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a question.

Parameters
NameDescription
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: projects/foo/locations/bar This corresponds to the parent field on the request instance; if request is provided, this should not be set.

question Question

Required. The question to create. This corresponds to the question field on the request instance; if request is provided, this should not be set.

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.

Returns
TypeDescription
google.cloud.dataqna_v1alpha.types.QuestionThe 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, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Executes an interpretation.

Parameters
NameDescription
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: projects/foo/locations/bar/questions/1234 This corresponds to the name field on the request instance; if request is provided, this should not be set.

interpretation_index `int`

Required. Index of the interpretation to execute. This corresponds to the interpretation_index field on the request instance; if request is provided, this should not be set.

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.

Returns
TypeDescription
google.cloud.dataqna_v1alpha.types.QuestionThe 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.

Parameters
NameDescription
filename str

The path to the service account private key json file.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
QuestionServiceAsyncClientThe 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.

Parameters
NameDescription
info dict

The service account private key info.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
QuestionServiceAsyncClientThe 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.

Parameters
NameDescription
filename str

The path to the service account private key json file.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
QuestionServiceAsyncClientThe constructed client.

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, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a previously created question.

Parameters
NameDescription
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: projects/foo/locations/bar/questions/1234 This corresponds to the name field on the request instance; if request is provided, this should not be set.

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.

Returns
TypeDescription
google.cloud.dataqna_v1alpha.types.QuestionThe question resource represents a natural language query, its settings, understanding generated by the system, and answer retrieval status. A question cannot be modified.

get_transport_class

get_transport_class()

partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

Parameter
NameDescription
label str

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, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets previously created user feedback.

Parameters
NameDescription
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: projects/foo/locations/bar/questions/1234/userFeedback This corresponds to the name field on the request instance; if request is provided, this should not be set.

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.

Returns
TypeDescription
google.cloud.dataqna_v1alpha.types.UserFeedbackFeedback 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.

Parameter
NameDescription
path str

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

Parameter
NameDescription
path str

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

Parameter
NameDescription
path str

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

Parameter
NameDescription
path str

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

Parameter
NameDescription
path str

parse_question_path

parse_question_path(path: str)

Parses a question path into its component segments.

Parameter
NameDescription
path str

parse_user_feedback_path

parse_user_feedback_path(path: str)

Parses a user_feedback path into its component segments.

Parameter
NameDescription
path str

question_path

question_path(project: str, location: str, question: str)

Returns a fully-qualified question string.

Parameters
NameDescription
project str
location str
question str

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, object] = <_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).

Parameters
NameDescription
request Union[google.cloud.dataqna_v1alpha.types.UpdateUserFeedbackRequest, dict]

The request object. Request to updates user feedback.

user_feedback 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 user_feedback field on the request instance; if request is provided, this should not be set.

update_mask `google.protobuf.field_mask_pb2.FieldMask`

The list of fields to be updated. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

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.

Returns
TypeDescription
google.cloud.dataqna_v1alpha.types.UserFeedbackFeedback provided by a user.

user_feedback_path

user_feedback_path(project: str, location: str, question: str)

Returns a fully-qualified user_feedback string.

Parameters
NameDescription
project str
location str
question str