...

Package dataqna

import "google.golang.org/genproto/googleapis/cloud/dataqna/v1alpha"
Overview
Index

Overview ▾

Package dataqna aliases all exported identifiers in package "cloud.google.com/go/dataqna/apiv1alpha/dataqnapb".

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb. Please read https://github.com/googleapis/google-cloud-go/blob/main/migration.md for more details.

Index ▾

Constants
Variables
func RegisterAutoSuggestionServiceServer(s *grpc.Server, srv AutoSuggestionServiceServer)
func RegisterQuestionServiceServer(s *grpc.Server, srv QuestionServiceServer)
type AnnotatedString
type AnnotatedString_SemanticMarkup
type AnnotatedString_SemanticMarkupType
type AutoSuggestionServiceClient
    func NewAutoSuggestionServiceClient(cc grpc.ClientConnInterface) AutoSuggestionServiceClient
type AutoSuggestionServiceServer
type BigQueryJob
type CreateQuestionRequest
type DataQuery
type DebugFlags
type ExecuteQuestionRequest
type ExecutionInfo
type ExecutionInfo_JobExecutionState
type GetQuestionRequest
type GetUserFeedbackRequest
type HumanReadable
type InterpretEntity
type InterpretError
type InterpretError_InterpretAmbiguityDetails
type InterpretError_InterpretErrorCode
type InterpretError_InterpretErrorDetails
type InterpretError_InterpretIncompleteQueryDetails
type InterpretError_InterpretUnsupportedDetails
type Interpretation
type InterpretationStructure
type InterpretationStructure_ColumnInfo
type InterpretationStructure_VisualizationType
type Question
type QuestionServiceClient
    func NewQuestionServiceClient(cc grpc.ClientConnInterface) QuestionServiceClient
type QuestionServiceServer
type SuggestQueriesRequest
type SuggestQueriesResponse
type Suggestion
type SuggestionInfo
type SuggestionInfo_MatchInfo
type SuggestionType
type UnimplementedAutoSuggestionServiceServer
type UnimplementedQuestionServiceServer
type UpdateUserFeedbackRequest
type UserFeedback
type UserFeedback_UserFeedbackRating

Package files

alias.go

Constants

Deprecated: Please use consts in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

const (
    AnnotatedString_BLOCKED                                = src.AnnotatedString_BLOCKED
    AnnotatedString_DIMENSION                              = src.AnnotatedString_DIMENSION
    AnnotatedString_FILTER                                 = src.AnnotatedString_FILTER
    AnnotatedString_MARKUP_TYPE_UNSPECIFIED                = src.AnnotatedString_MARKUP_TYPE_UNSPECIFIED
    AnnotatedString_METRIC                                 = src.AnnotatedString_METRIC
    AnnotatedString_ROW                                    = src.AnnotatedString_ROW
    AnnotatedString_UNUSED                                 = src.AnnotatedString_UNUSED
    ExecutionInfo_FAILED                                   = src.ExecutionInfo_FAILED
    ExecutionInfo_JOB_EXECUTION_STATE_UNSPECIFIED          = src.ExecutionInfo_JOB_EXECUTION_STATE_UNSPECIFIED
    ExecutionInfo_NOT_EXECUTED                             = src.ExecutionInfo_NOT_EXECUTED
    ExecutionInfo_RUNNING                                  = src.ExecutionInfo_RUNNING
    ExecutionInfo_SUCCEEDED                                = src.ExecutionInfo_SUCCEEDED
    InterpretEntity_DIMENSION                              = src.InterpretEntity_DIMENSION
    InterpretEntity_INTERPRET_ENTITY_UNSPECIFIED           = src.InterpretEntity_INTERPRET_ENTITY_UNSPECIFIED
    InterpretEntity_METRIC                                 = src.InterpretEntity_METRIC
    InterpretError_FAILED_TO_ANSWER                        = src.InterpretError_FAILED_TO_ANSWER
    InterpretError_FAILED_TO_UNDERSTAND                    = src.InterpretError_FAILED_TO_UNDERSTAND
    InterpretError_INTERPRET_ERROR_CODE_UNSPECIFIED        = src.InterpretError_INTERPRET_ERROR_CODE_UNSPECIFIED
    InterpretError_INVALID_QUERY                           = src.InterpretError_INVALID_QUERY
    InterpretationStructure_AREA_CHART                     = src.InterpretationStructure_AREA_CHART
    InterpretationStructure_BAR_CHART                      = src.InterpretationStructure_BAR_CHART
    InterpretationStructure_CHART_NOT_UNDERSTOOD           = src.InterpretationStructure_CHART_NOT_UNDERSTOOD
    InterpretationStructure_COLUMN_CHART                   = src.InterpretationStructure_COLUMN_CHART
    InterpretationStructure_COMBO_CHART                    = src.InterpretationStructure_COMBO_CHART
    InterpretationStructure_GENERIC_CHART                  = src.InterpretationStructure_GENERIC_CHART
    InterpretationStructure_HISTOGRAM                      = src.InterpretationStructure_HISTOGRAM
    InterpretationStructure_LINE_CHART                     = src.InterpretationStructure_LINE_CHART
    InterpretationStructure_PIE_CHART                      = src.InterpretationStructure_PIE_CHART
    InterpretationStructure_SCATTER_PLOT                   = src.InterpretationStructure_SCATTER_PLOT
    InterpretationStructure_TABLE                          = src.InterpretationStructure_TABLE
    InterpretationStructure_TIMELINE                       = src.InterpretationStructure_TIMELINE
    InterpretationStructure_VISUALIZATION_TYPE_UNSPECIFIED = src.InterpretationStructure_VISUALIZATION_TYPE_UNSPECIFIED
    SuggestionType_ENTITY                                  = src.SuggestionType_ENTITY
    SuggestionType_SUGGESTION_TYPE_UNSPECIFIED             = src.SuggestionType_SUGGESTION_TYPE_UNSPECIFIED
    SuggestionType_TEMPLATE                                = src.SuggestionType_TEMPLATE
    UserFeedback_NEGATIVE                                  = src.UserFeedback_NEGATIVE
    UserFeedback_POSITIVE                                  = src.UserFeedback_POSITIVE
    UserFeedback_USER_FEEDBACK_RATING_UNSPECIFIED          = src.UserFeedback_USER_FEEDBACK_RATING_UNSPECIFIED
)

Variables

Deprecated: Please use vars in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

var (
    AnnotatedString_SemanticMarkupType_name                         = src.AnnotatedString_SemanticMarkupType_name
    AnnotatedString_SemanticMarkupType_value                        = src.AnnotatedString_SemanticMarkupType_value
    ExecutionInfo_JobExecutionState_name                            = src.ExecutionInfo_JobExecutionState_name
    ExecutionInfo_JobExecutionState_value                           = src.ExecutionInfo_JobExecutionState_value
    File_google_cloud_dataqna_v1alpha_annotated_string_proto        = src.File_google_cloud_dataqna_v1alpha_annotated_string_proto
    File_google_cloud_dataqna_v1alpha_auto_suggestion_service_proto = src.File_google_cloud_dataqna_v1alpha_auto_suggestion_service_proto
    File_google_cloud_dataqna_v1alpha_question_proto                = src.File_google_cloud_dataqna_v1alpha_question_proto
    File_google_cloud_dataqna_v1alpha_question_service_proto        = src.File_google_cloud_dataqna_v1alpha_question_service_proto
    File_google_cloud_dataqna_v1alpha_user_feedback_proto           = src.File_google_cloud_dataqna_v1alpha_user_feedback_proto
    InterpretEntity_name                                            = src.InterpretEntity_name
    InterpretEntity_value                                           = src.InterpretEntity_value
    InterpretError_InterpretErrorCode_name                          = src.InterpretError_InterpretErrorCode_name
    InterpretError_InterpretErrorCode_value                         = src.InterpretError_InterpretErrorCode_value
    InterpretationStructure_VisualizationType_name                  = src.InterpretationStructure_VisualizationType_name
    InterpretationStructure_VisualizationType_value                 = src.InterpretationStructure_VisualizationType_value
    SuggestionType_name                                             = src.SuggestionType_name
    SuggestionType_value                                            = src.SuggestionType_value
    UserFeedback_UserFeedbackRating_name                            = src.UserFeedback_UserFeedbackRating_name
    UserFeedback_UserFeedbackRating_value                           = src.UserFeedback_UserFeedbackRating_value
)

func RegisterAutoSuggestionServiceServer

func RegisterAutoSuggestionServiceServer(s *grpc.Server, srv AutoSuggestionServiceServer)

Deprecated: Please use funcs in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

func RegisterQuestionServiceServer

func RegisterQuestionServiceServer(s *grpc.Server, srv QuestionServiceServer)

Deprecated: Please use funcs in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type AnnotatedString

Describes string annotation from both semantic and formatting perspectives. Example: User Query: top countries by population in Africa 0 4 14 17 28 31 37 Table Data: + "country" - dimension + "population" - metric + "Africa" - value in the "continent" column text_formatted = `"top countries by population in Africa"` html_formatted = `"top <b>countries</b> by <b>population</b> in <i>Africa</i>"` ``` markups = [ {DIMENSION, 4, 12}, // 'countries' {METRIC, 17, 26}, // 'population' {FILTER, 31, 36} // 'Africa' ] ``` Note that html formattings for 'DIMENSION' and 'METRIC' are the same, while semantic markups are different.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type AnnotatedString = src.AnnotatedString

type AnnotatedString_SemanticMarkup

Semantic markup denotes a substring (by index and length) with markup information.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type AnnotatedString_SemanticMarkup = src.AnnotatedString_SemanticMarkup

type AnnotatedString_SemanticMarkupType

Semantic markup types.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type AnnotatedString_SemanticMarkupType = src.AnnotatedString_SemanticMarkupType

type AutoSuggestionServiceClient

AutoSuggestionServiceClient is the client API for AutoSuggestionService service. For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type AutoSuggestionServiceClient = src.AutoSuggestionServiceClient

func NewAutoSuggestionServiceClient

func NewAutoSuggestionServiceClient(cc grpc.ClientConnInterface) AutoSuggestionServiceClient

Deprecated: Please use funcs in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type AutoSuggestionServiceServer

AutoSuggestionServiceServer is the server API for AutoSuggestionService service.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type AutoSuggestionServiceServer = src.AutoSuggestionServiceServer

type BigQueryJob

BigQuery job information. This can be used to query the BigQuery API and retrieve the current job's status (using [jobs.get](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/get)).

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type BigQueryJob = src.BigQueryJob

type CreateQuestionRequest

Request to create a question resource.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type CreateQuestionRequest = src.CreateQuestionRequest

type DataQuery

Representation of the data query for the backend. This is provided for informational purposes only. Clients should not use it to send it to the backend directly, but rather use the `execute` RPC to trigger the execution. Using the `execute` RPC is needed in order to track the state of a question and report on it correctly to the data administrators.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type DataQuery = src.DataQuery

type DebugFlags

Configuriation of debug flags.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type DebugFlags = src.DebugFlags

type ExecuteQuestionRequest

Request to execute an interpretation.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type ExecuteQuestionRequest = src.ExecuteQuestionRequest

type ExecutionInfo

Information about the backend status (such as BigQuery) of the execution.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type ExecutionInfo = src.ExecutionInfo

type ExecutionInfo_JobExecutionState

Enum of possible job execution statuses.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type ExecutionInfo_JobExecutionState = src.ExecutionInfo_JobExecutionState

type GetQuestionRequest

A request to get a previously created question.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type GetQuestionRequest = src.GetQuestionRequest

type GetUserFeedbackRequest

Request to get user feedback.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type GetUserFeedbackRequest = src.GetUserFeedbackRequest

type HumanReadable

Human readable interpretation.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type HumanReadable = src.HumanReadable

type InterpretEntity

Query entities of an interpretation.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type InterpretEntity = src.InterpretEntity

type InterpretError

Details on the failure to interpret the question.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type InterpretError = src.InterpretError

type InterpretError_InterpretAmbiguityDetails

Details about a query that was too ambiguous. Currently, the message has no fields and its presence signals that there was ambiguity.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type InterpretError_InterpretAmbiguityDetails = src.InterpretError_InterpretAmbiguityDetails

type InterpretError_InterpretErrorCode

The interpret error code provides an error category why the interpretation failed.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type InterpretError_InterpretErrorCode = src.InterpretError_InterpretErrorCode

type InterpretError_InterpretErrorDetails

Details on interpretation failure.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type InterpretError_InterpretErrorDetails = src.InterpretError_InterpretErrorDetails

type InterpretError_InterpretIncompleteQueryDetails

Details about an incomplete query.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type InterpretError_InterpretIncompleteQueryDetails = src.InterpretError_InterpretIncompleteQueryDetails

type InterpretError_InterpretUnsupportedDetails

Details about unsupported parts in a query.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type InterpretError_InterpretUnsupportedDetails = src.InterpretError_InterpretUnsupportedDetails

type Interpretation

An interpretation of a natural language query.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type Interpretation = src.Interpretation

type InterpretationStructure

Information about the interpretation structure that helps to understand and visualize the response.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type InterpretationStructure = src.InterpretationStructure

type InterpretationStructure_ColumnInfo

Information about a column.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type InterpretationStructure_ColumnInfo = src.InterpretationStructure_ColumnInfo

type InterpretationStructure_VisualizationType

Enumeration of visualzation types to use for query response data.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type InterpretationStructure_VisualizationType = src.InterpretationStructure_VisualizationType

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

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type Question = src.Question

type QuestionServiceClient

QuestionServiceClient is the client API for QuestionService service. For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type QuestionServiceClient = src.QuestionServiceClient

func NewQuestionServiceClient

func NewQuestionServiceClient(cc grpc.ClientConnInterface) QuestionServiceClient

Deprecated: Please use funcs in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type QuestionServiceServer

QuestionServiceServer is the server API for QuestionService service.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type QuestionServiceServer = src.QuestionServiceServer

type SuggestQueriesRequest

Request for query suggestions.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type SuggestQueriesRequest = src.SuggestQueriesRequest

type SuggestQueriesResponse

Response to SuggestQueries.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type SuggestQueriesResponse = src.SuggestQueriesResponse

type Suggestion

A suggestion for a query with a ranking score.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type Suggestion = src.Suggestion

type SuggestionInfo

Detailed information about the suggestion.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type SuggestionInfo = src.SuggestionInfo

type SuggestionInfo_MatchInfo

MatchInfo describes which part of suggestion matched with data in user typed query. This can be used to highlight matching parts in the UI. This is different from the annotations provided in annotated_suggestion. The annotated_suggestion provides information about the semantic meaning, while this provides information about how it relates to the input. Example: user query: `top products` ``` annotated_suggestion { text_formatted = "top product_group" html_formatted = "top <b>product_group</b>" markups { {type: TEXT, start_char_index: 0, length: 3} {type: DIMENSION, start_char_index: 4, length: 13} } } query_matches { { start_char_index: 0, length: 3 } { start_char_index: 4, length: 7} } ```

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type SuggestionInfo_MatchInfo = src.SuggestionInfo_MatchInfo

type SuggestionType

The type of suggestion.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type SuggestionType = src.SuggestionType

type UnimplementedAutoSuggestionServiceServer

UnimplementedAutoSuggestionServiceServer can be embedded to have forward compatible implementations.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type UnimplementedAutoSuggestionServiceServer = src.UnimplementedAutoSuggestionServiceServer

type UnimplementedQuestionServiceServer

UnimplementedQuestionServiceServer can be embedded to have forward compatible implementations.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type UnimplementedQuestionServiceServer = src.UnimplementedQuestionServiceServer

type UpdateUserFeedbackRequest

Request to updates user feedback.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type UpdateUserFeedbackRequest = src.UpdateUserFeedbackRequest

type UserFeedback

Feedback provided by a user.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type UserFeedback = src.UserFeedback

type UserFeedback_UserFeedbackRating

Enumeration of feedback ratings.

Deprecated: Please use types in: cloud.google.com/go/dataqna/apiv1alpha/dataqnapb

type UserFeedback_UserFeedbackRating = src.UserFeedback_UserFeedbackRating