Package @google-cloud/data-qna (2.0.1)

Stay organized with collections Save and categorize content based on your preferences.

Classes

protos.google.api.CustomHttpPattern

Represents a CustomHttpPattern.

protos.google.api.Http

Represents a Http.

protos.google.api.HttpRule

Represents a HttpRule.

protos.google.api.ResourceDescriptor

Represents a ResourceDescriptor.

protos.google.api.ResourceReference

Represents a ResourceReference.

protos.google.cloud.dataqna.v1alpha.AnnotatedString

Represents an AnnotatedString.

protos.google.cloud.dataqna.v1alpha.AnnotatedString.SemanticMarkup

Represents a SemanticMarkup.

protos.google.cloud.dataqna.v1alpha.AutoSuggestionService

Represents an AutoSuggestionService

protos.google.cloud.dataqna.v1alpha.BigQueryJob

Represents a BigQueryJob.

protos.google.cloud.dataqna.v1alpha.CreateQuestionRequest

Represents a CreateQuestionRequest.

protos.google.cloud.dataqna.v1alpha.DataQuery

Represents a DataQuery.

protos.google.cloud.dataqna.v1alpha.DebugFlags

Represents a DebugFlags.

protos.google.cloud.dataqna.v1alpha.ExecuteQuestionRequest

Represents an ExecuteQuestionRequest.

protos.google.cloud.dataqna.v1alpha.ExecutionInfo

Represents an ExecutionInfo.

protos.google.cloud.dataqna.v1alpha.GetQuestionRequest

Represents a GetQuestionRequest.

protos.google.cloud.dataqna.v1alpha.GetUserFeedbackRequest

Represents a GetUserFeedbackRequest.

protos.google.cloud.dataqna.v1alpha.HumanReadable

Represents a HumanReadable.

protos.google.cloud.dataqna.v1alpha.Interpretation

Represents an Interpretation.

protos.google.cloud.dataqna.v1alpha.InterpretationStructure

Represents an InterpretationStructure.

protos.google.cloud.dataqna.v1alpha.InterpretationStructure.ColumnInfo

Represents a ColumnInfo.

protos.google.cloud.dataqna.v1alpha.InterpretError

Represents an InterpretError.

protos.google.cloud.dataqna.v1alpha.InterpretError.InterpretAmbiguityDetails

Represents an InterpretAmbiguityDetails.

protos.google.cloud.dataqna.v1alpha.InterpretError.InterpretErrorDetails

Represents an InterpretErrorDetails.

protos.google.cloud.dataqna.v1alpha.InterpretError.InterpretIncompleteQueryDetails

Represents an InterpretIncompleteQueryDetails.

protos.google.cloud.dataqna.v1alpha.InterpretError.InterpretUnsupportedDetails

Represents an InterpretUnsupportedDetails.

protos.google.cloud.dataqna.v1alpha.Question

Represents a Question.

protos.google.cloud.dataqna.v1alpha.QuestionService

Represents a QuestionService

protos.google.cloud.dataqna.v1alpha.Suggestion

Represents a Suggestion.

protos.google.cloud.dataqna.v1alpha.SuggestionInfo

Represents a SuggestionInfo.

protos.google.cloud.dataqna.v1alpha.SuggestionInfo.MatchInfo

Represents a MatchInfo.

protos.google.cloud.dataqna.v1alpha.SuggestQueriesRequest

Represents a SuggestQueriesRequest.

protos.google.cloud.dataqna.v1alpha.SuggestQueriesResponse

Represents a SuggestQueriesResponse.

protos.google.cloud.dataqna.v1alpha.UpdateUserFeedbackRequest

Represents an UpdateUserFeedbackRequest.

protos.google.cloud.dataqna.v1alpha.UserFeedback

Represents a UserFeedback.

protos.google.protobuf.Any

Represents an Any.

protos.google.protobuf.DescriptorProto

Represents a DescriptorProto.

protos.google.protobuf.DescriptorProto.ExtensionRange

Represents an ExtensionRange.

protos.google.protobuf.DescriptorProto.ReservedRange

Represents a ReservedRange.

protos.google.protobuf.EnumDescriptorProto

Represents an EnumDescriptorProto.

protos.google.protobuf.EnumDescriptorProto.EnumReservedRange

Represents an EnumReservedRange.

protos.google.protobuf.EnumOptions

Represents an EnumOptions.

protos.google.protobuf.EnumValueDescriptorProto

Represents an EnumValueDescriptorProto.

protos.google.protobuf.EnumValueOptions

Represents an EnumValueOptions.

protos.google.protobuf.ExtensionRangeOptions

Represents an ExtensionRangeOptions.

protos.google.protobuf.FieldDescriptorProto

Represents a FieldDescriptorProto.

protos.google.protobuf.FieldMask

Represents a FieldMask.

protos.google.protobuf.FieldOptions

Represents a FieldOptions.

protos.google.protobuf.FileDescriptorProto

Represents a FileDescriptorProto.

protos.google.protobuf.FileDescriptorSet

Represents a FileDescriptorSet.

protos.google.protobuf.FileOptions

Represents a FileOptions.

protos.google.protobuf.GeneratedCodeInfo

Represents a GeneratedCodeInfo.

protos.google.protobuf.GeneratedCodeInfo.Annotation

Represents an Annotation.

protos.google.protobuf.MessageOptions

Represents a MessageOptions.

protos.google.protobuf.MethodDescriptorProto

Represents a MethodDescriptorProto.

protos.google.protobuf.MethodOptions

Represents a MethodOptions.

protos.google.protobuf.OneofDescriptorProto

Represents an OneofDescriptorProto.

protos.google.protobuf.OneofOptions

Represents an OneofOptions.

protos.google.protobuf.ServiceDescriptorProto

Represents a ServiceDescriptorProto.

protos.google.protobuf.ServiceOptions

Represents a ServiceOptions.

protos.google.protobuf.SourceCodeInfo

Represents a SourceCodeInfo.

protos.google.protobuf.SourceCodeInfo.Location

Represents a Location.

protos.google.protobuf.Timestamp

Represents a Timestamp.

protos.google.protobuf.UninterpretedOption

Represents an UninterpretedOption.

protos.google.protobuf.UninterpretedOption.NamePart

Represents a NamePart.

protos.google.rpc.Status

Represents a Status.

v1alpha.AutoSuggestionServiceClient

This stateless API provides automatic suggestions for natural language queries for the data sources in the provided project and location.

The service provides a resourceless operation suggestQueries that can be called to get a list of suggestions for a given incomplete query and scope (or list of scopes) under which the query is to be interpreted.

There are two types of suggestions, ENTITY for single entity suggestions and TEMPLATE for full sentences. By default, both types are returned.

Example Request: ``` GetSuggestions({ parent: "locations/us/projects/my-project" scopes: "//bigquery.googleapis.com/projects/my-project/datasets/my-dataset/tables/my-table" query: "top it" }) ```

The service will retrieve information based on the given scope(s) and give suggestions based on that (e.g. "top item" for "top it" if "item" is a known dimension for the provided scope). ``` suggestions { suggestion_info { annotated_suggestion { text_formatted: "top item by sum of usd_revenue_net" markups { type: DIMENSION start_char_index: 4 length: 4 } markups { type: METRIC start_char_index: 19 length: 15 } } query_matches { start_char_index: 0 length: 6 } } suggestion_type: TEMPLATE ranking_score: 0.9 } suggestions { suggestion_info { annotated_suggestion { text_formatted: "item" markups { type: DIMENSION start_char_index: 4 length: 2 } } query_matches { start_char_index: 0 length: 6 } } suggestion_type: ENTITY ranking_score: 0.8 } ``` v1alpha

v1alpha.QuestionServiceClient

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. v1alpha

Interfaces

protos.google.api.ICustomHttpPattern

Properties of a CustomHttpPattern.

protos.google.api.IHttp

Properties of a Http.

protos.google.api.IHttpRule

Properties of a HttpRule.

protos.google.api.IResourceDescriptor

Properties of a ResourceDescriptor.

protos.google.api.IResourceReference

Properties of a ResourceReference.

protos.google.cloud.dataqna.v1alpha.AnnotatedString.ISemanticMarkup

Properties of a SemanticMarkup.

protos.google.cloud.dataqna.v1alpha.IAnnotatedString

Properties of an AnnotatedString.

protos.google.cloud.dataqna.v1alpha.IBigQueryJob

Properties of a BigQueryJob.

protos.google.cloud.dataqna.v1alpha.ICreateQuestionRequest

Properties of a CreateQuestionRequest.

protos.google.cloud.dataqna.v1alpha.IDataQuery

Properties of a DataQuery.

protos.google.cloud.dataqna.v1alpha.IDebugFlags

Properties of a DebugFlags.

protos.google.cloud.dataqna.v1alpha.IExecuteQuestionRequest

Properties of an ExecuteQuestionRequest.

protos.google.cloud.dataqna.v1alpha.IExecutionInfo

Properties of an ExecutionInfo.

protos.google.cloud.dataqna.v1alpha.IGetQuestionRequest

Properties of a GetQuestionRequest.

protos.google.cloud.dataqna.v1alpha.IGetUserFeedbackRequest

Properties of a GetUserFeedbackRequest.

protos.google.cloud.dataqna.v1alpha.IHumanReadable

Properties of a HumanReadable.

protos.google.cloud.dataqna.v1alpha.IInterpretation

Properties of an Interpretation.

protos.google.cloud.dataqna.v1alpha.IInterpretationStructure

Properties of an InterpretationStructure.

protos.google.cloud.dataqna.v1alpha.IInterpretError

Properties of an InterpretError.

protos.google.cloud.dataqna.v1alpha.InterpretationStructure.IColumnInfo

Properties of a ColumnInfo.

protos.google.cloud.dataqna.v1alpha.InterpretError.IInterpretAmbiguityDetails

Properties of an InterpretAmbiguityDetails.

protos.google.cloud.dataqna.v1alpha.InterpretError.IInterpretErrorDetails

Properties of an InterpretErrorDetails.

protos.google.cloud.dataqna.v1alpha.InterpretError.IInterpretIncompleteQueryDetails

Properties of an InterpretIncompleteQueryDetails.

protos.google.cloud.dataqna.v1alpha.InterpretError.IInterpretUnsupportedDetails

Properties of an InterpretUnsupportedDetails.

protos.google.cloud.dataqna.v1alpha.IQuestion

Properties of a Question.

protos.google.cloud.dataqna.v1alpha.ISuggestion

Properties of a Suggestion.

protos.google.cloud.dataqna.v1alpha.ISuggestionInfo

Properties of a SuggestionInfo.

protos.google.cloud.dataqna.v1alpha.ISuggestQueriesRequest

Properties of a SuggestQueriesRequest.

protos.google.cloud.dataqna.v1alpha.ISuggestQueriesResponse

Properties of a SuggestQueriesResponse.

protos.google.cloud.dataqna.v1alpha.IUpdateUserFeedbackRequest

Properties of an UpdateUserFeedbackRequest.

protos.google.cloud.dataqna.v1alpha.IUserFeedback

Properties of a UserFeedback.

protos.google.cloud.dataqna.v1alpha.SuggestionInfo.IMatchInfo

Properties of a MatchInfo.

protos.google.protobuf.DescriptorProto.IExtensionRange

Properties of an ExtensionRange.

protos.google.protobuf.DescriptorProto.IReservedRange

Properties of a ReservedRange.

protos.google.protobuf.EnumDescriptorProto.IEnumReservedRange

Properties of an EnumReservedRange.

protos.google.protobuf.GeneratedCodeInfo.IAnnotation

Properties of an Annotation.

protos.google.protobuf.IAny

Properties of an Any.

protos.google.protobuf.IDescriptorProto

Properties of a DescriptorProto.

protos.google.protobuf.IEnumDescriptorProto

Properties of an EnumDescriptorProto.

protos.google.protobuf.IEnumOptions

Properties of an EnumOptions.

protos.google.protobuf.IEnumValueDescriptorProto

Properties of an EnumValueDescriptorProto.

protos.google.protobuf.IEnumValueOptions

Properties of an EnumValueOptions.

protos.google.protobuf.IExtensionRangeOptions

Properties of an ExtensionRangeOptions.

protos.google.protobuf.IFieldDescriptorProto

Properties of a FieldDescriptorProto.

protos.google.protobuf.IFieldMask

Properties of a FieldMask.

protos.google.protobuf.IFieldOptions

Properties of a FieldOptions.

protos.google.protobuf.IFileDescriptorProto

Properties of a FileDescriptorProto.

protos.google.protobuf.IFileDescriptorSet

Properties of a FileDescriptorSet.

protos.google.protobuf.IFileOptions

Properties of a FileOptions.

protos.google.protobuf.IGeneratedCodeInfo

Properties of a GeneratedCodeInfo.

protos.google.protobuf.IMessageOptions

Properties of a MessageOptions.

protos.google.protobuf.IMethodDescriptorProto

Properties of a MethodDescriptorProto.

protos.google.protobuf.IMethodOptions

Properties of a MethodOptions.

protos.google.protobuf.IOneofDescriptorProto

Properties of an OneofDescriptorProto.

protos.google.protobuf.IOneofOptions

Properties of an OneofOptions.

protos.google.protobuf.IServiceDescriptorProto

Properties of a ServiceDescriptorProto.

protos.google.protobuf.IServiceOptions

Properties of a ServiceOptions.

protos.google.protobuf.ISourceCodeInfo

Properties of a SourceCodeInfo.

protos.google.protobuf.ITimestamp

Properties of a Timestamp.

protos.google.protobuf.IUninterpretedOption

Properties of an UninterpretedOption.

protos.google.protobuf.SourceCodeInfo.ILocation

Properties of a Location.

protos.google.protobuf.UninterpretedOption.INamePart

Properties of a NamePart.

protos.google.rpc.IStatus

Properties of a Status.

Enums

protos.google.api.FieldBehavior

FieldBehavior enum.

protos.google.api.ResourceDescriptor.History

History enum.

protos.google.api.ResourceDescriptor.Style

Style enum.

protos.google.cloud.dataqna.v1alpha.AnnotatedString.SemanticMarkupType

SemanticMarkupType enum.

protos.google.cloud.dataqna.v1alpha.ExecutionInfo.JobExecutionState

JobExecutionState enum.

protos.google.cloud.dataqna.v1alpha.InterpretationStructure.VisualizationType

VisualizationType enum.

protos.google.cloud.dataqna.v1alpha.InterpretEntity

InterpretEntity enum.

protos.google.cloud.dataqna.v1alpha.InterpretError.InterpretErrorCode

InterpretErrorCode enum.

protos.google.cloud.dataqna.v1alpha.SuggestionType

SuggestionType enum.

protos.google.cloud.dataqna.v1alpha.UserFeedback.UserFeedbackRating

UserFeedbackRating enum.

protos.google.protobuf.FieldDescriptorProto.Label

Label enum.

protos.google.protobuf.FieldDescriptorProto.Type

Type enum.

protos.google.protobuf.FieldOptions.CType

CType enum.

protos.google.protobuf.FieldOptions.JSType

JSType enum.

protos.google.protobuf.FileOptions.OptimizeMode

OptimizeMode enum.

protos.google.protobuf.GeneratedCodeInfo.Annotation.Semantic

Semantic enum.

protos.google.protobuf.MethodOptions.IdempotencyLevel

IdempotencyLevel enum.

Variables

_default

_default: {
    v1alpha: typeof v1alpha;
    AutoSuggestionServiceClient: typeof v1alpha.AutoSuggestionServiceClient;
    QuestionServiceClient: typeof v1alpha.QuestionServiceClient;
}

AutoSuggestionServiceClient

AutoSuggestionServiceClient: typeof v1alpha.AutoSuggestionServiceClient

QuestionServiceClient

QuestionServiceClient: typeof v1alpha.QuestionServiceClient

Type Aliases

AutoSuggestionServiceClient

declare type AutoSuggestionServiceClient = v1alpha.AutoSuggestionServiceClient;

protos.google.cloud.dataqna.v1alpha.AutoSuggestionService.SuggestQueriesCallback

type SuggestQueriesCallback = (error: (Error|null), response?: google.cloud.dataqna.v1alpha.SuggestQueriesResponse) => void;

Callback as used by .

protos.google.cloud.dataqna.v1alpha.QuestionService.CreateQuestionCallback

type CreateQuestionCallback = (error: (Error|null), response?: google.cloud.dataqna.v1alpha.Question) => void;

Callback as used by .

protos.google.cloud.dataqna.v1alpha.QuestionService.ExecuteQuestionCallback

type ExecuteQuestionCallback = (error: (Error|null), response?: google.cloud.dataqna.v1alpha.Question) => void;

Callback as used by .

protos.google.cloud.dataqna.v1alpha.QuestionService.GetQuestionCallback

type GetQuestionCallback = (error: (Error|null), response?: google.cloud.dataqna.v1alpha.Question) => void;

Callback as used by .

protos.google.cloud.dataqna.v1alpha.QuestionService.GetUserFeedbackCallback

type GetUserFeedbackCallback = (error: (Error|null), response?: google.cloud.dataqna.v1alpha.UserFeedback) => void;

Callback as used by .

protos.google.cloud.dataqna.v1alpha.QuestionService.UpdateUserFeedbackCallback

type UpdateUserFeedbackCallback = (error: (Error|null), response?: google.cloud.dataqna.v1alpha.UserFeedback) => void;

Callback as used by .

QuestionServiceClient

declare type QuestionServiceClient = v1alpha.QuestionServiceClient;