Documentation
¶
Overview ¶
Package language provides access to the Cloud Natural Language API.
This package is DEPRECATED. Use package cloud.google.com/go/language/apiv1 instead.
For product documentation, see: https://cloud.google.com/natural-language/
Library status ¶
These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.
When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.
Creating a client ¶
Usage example:
import "google.golang.org/api/language/v1beta2" ... ctx := context.Background() languageService, err := language.NewService(ctx)
In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
Other authentication options ¶
By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use google.golang.org/api/option.WithScopes:
languageService, err := language.NewService(ctx, option.WithScopes(language.CloudPlatformScope))
To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:
languageService, err := language.NewService(ctx, option.WithAPIKey("AIza..."))
To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:
config := &oauth2.Config{...} // ... token, err := config.Exchange(ctx, ...) languageService, err := language.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
See google.golang.org/api/option.ClientOption for details on options.
Index ¶
- Constants
- type AnalyzeEntitiesRequest
- type AnalyzeEntitiesResponse
- type AnalyzeEntitySentimentRequest
- type AnalyzeEntitySentimentResponse
- type AnalyzeSentimentRequest
- type AnalyzeSentimentResponse
- type AnalyzeSyntaxRequest
- type AnalyzeSyntaxResponse
- type AnnotateTextRequest
- type AnnotateTextRequestFeatures
- type AnnotateTextResponse
- type ClassificationCategory
- type ClassificationModelOptions
- type ClassificationModelOptionsV1Model
- type ClassificationModelOptionsV2Model
- type ClassifyTextRequest
- type ClassifyTextResponse
- type Color
- type CpuMetric
- type DependencyEdge
- type DiskMetric
- type Document
- type DocumentsAnalyzeEntitiesCall
- func (c *DocumentsAnalyzeEntitiesCall) Context(ctx context.Context) *DocumentsAnalyzeEntitiesCall
- func (c *DocumentsAnalyzeEntitiesCall) Do(opts ...googleapi.CallOption) (*AnalyzeEntitiesResponse, error)
- func (c *DocumentsAnalyzeEntitiesCall) Fields(s ...googleapi.Field) *DocumentsAnalyzeEntitiesCall
- func (c *DocumentsAnalyzeEntitiesCall) Header() http.Header
- type DocumentsAnalyzeEntitySentimentCall
- func (c *DocumentsAnalyzeEntitySentimentCall) Context(ctx context.Context) *DocumentsAnalyzeEntitySentimentCall
- func (c *DocumentsAnalyzeEntitySentimentCall) Do(opts ...googleapi.CallOption) (*AnalyzeEntitySentimentResponse, error)
- func (c *DocumentsAnalyzeEntitySentimentCall) Fields(s ...googleapi.Field) *DocumentsAnalyzeEntitySentimentCall
- func (c *DocumentsAnalyzeEntitySentimentCall) Header() http.Header
- type DocumentsAnalyzeSentimentCall
- func (c *DocumentsAnalyzeSentimentCall) Context(ctx context.Context) *DocumentsAnalyzeSentimentCall
- func (c *DocumentsAnalyzeSentimentCall) Do(opts ...googleapi.CallOption) (*AnalyzeSentimentResponse, error)
- func (c *DocumentsAnalyzeSentimentCall) Fields(s ...googleapi.Field) *DocumentsAnalyzeSentimentCall
- func (c *DocumentsAnalyzeSentimentCall) Header() http.Header
- type DocumentsAnalyzeSyntaxCall
- func (c *DocumentsAnalyzeSyntaxCall) Context(ctx context.Context) *DocumentsAnalyzeSyntaxCall
- func (c *DocumentsAnalyzeSyntaxCall) Do(opts ...googleapi.CallOption) (*AnalyzeSyntaxResponse, error)
- func (c *DocumentsAnalyzeSyntaxCall) Fields(s ...googleapi.Field) *DocumentsAnalyzeSyntaxCall
- func (c *DocumentsAnalyzeSyntaxCall) Header() http.Header
- type DocumentsAnnotateTextCall
- func (c *DocumentsAnnotateTextCall) Context(ctx context.Context) *DocumentsAnnotateTextCall
- func (c *DocumentsAnnotateTextCall) Do(opts ...googleapi.CallOption) (*AnnotateTextResponse, error)
- func (c *DocumentsAnnotateTextCall) Fields(s ...googleapi.Field) *DocumentsAnnotateTextCall
- func (c *DocumentsAnnotateTextCall) Header() http.Header
- type DocumentsClassifyTextCall
- func (c *DocumentsClassifyTextCall) Context(ctx context.Context) *DocumentsClassifyTextCall
- func (c *DocumentsClassifyTextCall) Do(opts ...googleapi.CallOption) (*ClassifyTextResponse, error)
- func (c *DocumentsClassifyTextCall) Fields(s ...googleapi.Field) *DocumentsClassifyTextCall
- func (c *DocumentsClassifyTextCall) Header() http.Header
- type DocumentsModerateTextCall
- func (c *DocumentsModerateTextCall) Context(ctx context.Context) *DocumentsModerateTextCall
- func (c *DocumentsModerateTextCall) Do(opts ...googleapi.CallOption) (*ModerateTextResponse, error)
- func (c *DocumentsModerateTextCall) Fields(s ...googleapi.Field) *DocumentsModerateTextCall
- func (c *DocumentsModerateTextCall) Header() http.Header
- type DocumentsService
- func (r *DocumentsService) AnalyzeEntities(analyzeentitiesrequest *AnalyzeEntitiesRequest) *DocumentsAnalyzeEntitiesCall
- func (r *DocumentsService) AnalyzeEntitySentiment(analyzeentitysentimentrequest *AnalyzeEntitySentimentRequest) *DocumentsAnalyzeEntitySentimentCall
- func (r *DocumentsService) AnalyzeSentiment(analyzesentimentrequest *AnalyzeSentimentRequest) *DocumentsAnalyzeSentimentCall
- func (r *DocumentsService) AnalyzeSyntax(analyzesyntaxrequest *AnalyzeSyntaxRequest) *DocumentsAnalyzeSyntaxCall
- func (r *DocumentsService) AnnotateText(annotatetextrequest *AnnotateTextRequest) *DocumentsAnnotateTextCall
- func (r *DocumentsService) ClassifyText(classifytextrequest *ClassifyTextRequest) *DocumentsClassifyTextCall
- func (r *DocumentsService) ModerateText(moderatetextrequest *ModerateTextRequest) *DocumentsModerateTextCall
- type Entity
- type EntityMention
- type GpuMetric
- type InfraUsage
- type ModerateTextRequest
- type ModerateTextResponse
- type PartOfSpeech
- type RamMetric
- type Sentence
- type Sentiment
- type Service
- type Status
- type TextSpan
- type Token
- type TpuMetric
- type XPSArrayStats
- type XPSBatchPredictResponse
- type XPSBoundingBoxMetricsEntry
- type XPSBoundingBoxMetricsEntryConfidenceMetricsEntry
- type XPSCategoryStats
- type XPSCategoryStatsSingleCategoryStats
- type XPSClassificationEvaluationMetrics
- type XPSColorMap
- type XPSColorMapIntColor
- type XPSColumnSpec
- type XPSColumnSpecCorrelatedColumn
- type XPSColumnSpecForecastingMetadata
- type XPSCommonStats
- type XPSConfidenceMetricsEntry
- type XPSConfusionMatrix
- type XPSConfusionMatrixRow
- type XPSCoreMlFormat
- type XPSCorrelationStats
- type XPSDataErrors
- type XPSDataStats
- type XPSDataType
- type XPSDockerFormat
- type XPSEdgeTpuTfLiteFormat
- type XPSEvaluationMetrics
- type XPSEvaluationMetricsSet
- type XPSExampleSet
- type XPSExportModelOutputConfig
- type XPSFileSpec
- type XPSFloat64Stats
- type XPSFloat64StatsHistogramBucket
- type XPSImageClassificationTrainResponse
- type XPSImageExportModelSpec
- type XPSImageModelArtifactSpec
- type XPSImageModelServingSpec
- type XPSImageModelServingSpecModelThroughputEstimation
- type XPSImageObjectDetectionEvaluationMetrics
- type XPSImageObjectDetectionModelSpec
- type XPSImageSegmentationEvaluationMetrics
- type XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry
- type XPSImageSegmentationTrainResponse
- type XPSIntegratedGradientsAttribution
- type XPSMetricEntry
- type XPSMetricEntryLabel
- type XPSModelArtifactItem
- type XPSPreprocessResponse
- type XPSRegressionEvaluationMetrics
- type XPSRegressionMetricsEntry
- type XPSReportingMetrics
- type XPSResponseExplanationMetadata
- type XPSResponseExplanationMetadataInputMetadata
- type XPSResponseExplanationMetadataOutputMetadata
- type XPSResponseExplanationParameters
- type XPSResponseExplanationSpec
- type XPSRow
- type XPSSpeechEvaluationMetrics
- type XPSSpeechEvaluationMetricsSubModelEvaluationMetric
- type XPSSpeechModelSpec
- type XPSSpeechModelSpecSubModelSpec
- type XPSSpeechPreprocessResponse
- type XPSSpeechPreprocessStats
- type XPSStringStats
- type XPSStringStatsUnigramStats
- type XPSStructStats
- type XPSStructType
- type XPSTableSpec
- type XPSTablesClassificationMetrics
- type XPSTablesClassificationMetricsCurveMetrics
- type XPSTablesConfidenceMetricsEntry
- type XPSTablesDatasetMetadata
- type XPSTablesEvaluationMetrics
- type XPSTablesModelColumnInfo
- type XPSTablesModelStructure
- type XPSTablesModelStructureModelParameters
- type XPSTablesModelStructureModelParametersParameter
- type XPSTablesPreprocessResponse
- type XPSTablesRegressionMetrics
- type XPSTablesTrainResponse
- type XPSTablesTrainingOperationMetadata
- type XPSTextComponentModel
- type XPSTextExtractionEvaluationMetrics
- type XPSTextSentimentEvaluationMetrics
- type XPSTextToSpeechTrainResponse
- type XPSTextTrainResponse
- type XPSTfJsFormat
- type XPSTfLiteFormat
- type XPSTfSavedModelFormat
- type XPSTimestampStats
- type XPSTimestampStatsGranularStats
- type XPSTrackMetricsEntry
- type XPSTrackMetricsEntryConfidenceMetricsEntry
- type XPSTrainResponse
- type XPSTrainingObjectivePoint
- type XPSTranslationEvaluationMetrics
- type XPSTranslationPreprocessResponse
- type XPSTranslationTrainResponse
- type XPSTuningTrial
- type XPSVideoActionMetricsEntry
- type XPSVideoActionMetricsEntryConfidenceMetricsEntry
- type XPSVideoActionRecognitionEvaluationMetrics
- type XPSVideoActionRecognitionTrainResponse
- type XPSVideoBatchPredictOperationMetadata
- type XPSVideoClassificationTrainResponse
- type XPSVideoExportModelSpec
- type XPSVideoModelArtifactSpec
- type XPSVideoObjectTrackingEvaluationMetrics
- type XPSVideoObjectTrackingTrainResponse
- type XPSVideoTrainingOperationMetadata
- type XPSVisionErrorAnalysisConfig
- type XPSVisionTrainingOperationMetadata
- type XPSVisualization
- type XPSXpsOperationMetadata
- type XPSXraiAttribution
Constants ¶
const ( // Apply machine learning models to reveal the structure and meaning of // text CloudLanguageScope = "https://www.googleapis.com/auth/cloud-language" // See, edit, configure, and delete your Google Cloud data and see the // email address for your Google Account. CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform" )
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AnalyzeEntitiesRequest ¶
type AnalyzeEntitiesRequest struct { // Document: Required. Input document. Document *Document `json:"document,omitempty"` // EncodingType: The encoding type used by the API to calculate offsets. // // Possible values: // "NONE" - If `EncodingType` is not specified, encoding-dependent // information (such as `begin_offset`) will be set at `-1`. // "UTF8" - Encoding-dependent information (such as `begin_offset`) is // calculated based on the UTF-8 encoding of the input. C++ and Go are // examples of languages that use this encoding natively. // "UTF16" - Encoding-dependent information (such as `begin_offset`) // is calculated based on the UTF-16 encoding of the input. Java and // JavaScript are examples of languages that use this encoding natively. // "UTF32" - Encoding-dependent information (such as `begin_offset`) // is calculated based on the UTF-32 encoding of the input. Python is an // example of a language that uses this encoding natively. EncodingType string `json:"encodingType,omitempty"` // ForceSendFields is a list of field names (e.g. "Document") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Document") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AnalyzeEntitiesRequest: The entity analysis request message.
func (*AnalyzeEntitiesRequest) MarshalJSON ¶
func (s *AnalyzeEntitiesRequest) MarshalJSON() ([]byte, error)
type AnalyzeEntitiesResponse ¶
type AnalyzeEntitiesResponse struct { // Entities: The recognized entities in the input document. Entities []*Entity `json:"entities,omitempty"` // Language: The language of the text, which will be the same as the // language specified in the request or, if not specified, the // automatically-detected language. See Document.language field for more // details. Language string `json:"language,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Entities") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Entities") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AnalyzeEntitiesResponse: The entity analysis response message.
func (*AnalyzeEntitiesResponse) MarshalJSON ¶
func (s *AnalyzeEntitiesResponse) MarshalJSON() ([]byte, error)
type AnalyzeEntitySentimentRequest ¶
type AnalyzeEntitySentimentRequest struct { // Document: Required. Input document. Document *Document `json:"document,omitempty"` // EncodingType: The encoding type used by the API to calculate offsets. // // Possible values: // "NONE" - If `EncodingType` is not specified, encoding-dependent // information (such as `begin_offset`) will be set at `-1`. // "UTF8" - Encoding-dependent information (such as `begin_offset`) is // calculated based on the UTF-8 encoding of the input. C++ and Go are // examples of languages that use this encoding natively. // "UTF16" - Encoding-dependent information (such as `begin_offset`) // is calculated based on the UTF-16 encoding of the input. Java and // JavaScript are examples of languages that use this encoding natively. // "UTF32" - Encoding-dependent information (such as `begin_offset`) // is calculated based on the UTF-32 encoding of the input. Python is an // example of a language that uses this encoding natively. EncodingType string `json:"encodingType,omitempty"` // ForceSendFields is a list of field names (e.g. "Document") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Document") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AnalyzeEntitySentimentRequest: The entity-level sentiment analysis request message.
func (*AnalyzeEntitySentimentRequest) MarshalJSON ¶
func (s *AnalyzeEntitySentimentRequest) MarshalJSON() ([]byte, error)
type AnalyzeEntitySentimentResponse ¶
type AnalyzeEntitySentimentResponse struct { // Entities: The recognized entities in the input document with // associated sentiments. Entities []*Entity `json:"entities,omitempty"` // Language: The language of the text, which will be the same as the // language specified in the request or, if not specified, the // automatically-detected language. See Document.language field for more // details. Language string `json:"language,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Entities") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Entities") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AnalyzeEntitySentimentResponse: The entity-level sentiment analysis response message.
func (*AnalyzeEntitySentimentResponse) MarshalJSON ¶
func (s *AnalyzeEntitySentimentResponse) MarshalJSON() ([]byte, error)
type AnalyzeSentimentRequest ¶
type AnalyzeSentimentRequest struct { // Document: Required. Input document. Document *Document `json:"document,omitempty"` // EncodingType: The encoding type used by the API to calculate sentence // offsets for the sentence sentiment. // // Possible values: // "NONE" - If `EncodingType` is not specified, encoding-dependent // information (such as `begin_offset`) will be set at `-1`. // "UTF8" - Encoding-dependent information (such as `begin_offset`) is // calculated based on the UTF-8 encoding of the input. C++ and Go are // examples of languages that use this encoding natively. // "UTF16" - Encoding-dependent information (such as `begin_offset`) // is calculated based on the UTF-16 encoding of the input. Java and // JavaScript are examples of languages that use this encoding natively. // "UTF32" - Encoding-dependent information (such as `begin_offset`) // is calculated based on the UTF-32 encoding of the input. Python is an // example of a language that uses this encoding natively. EncodingType string `json:"encodingType,omitempty"` // ForceSendFields is a list of field names (e.g. "Document") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Document") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AnalyzeSentimentRequest: The sentiment analysis request message.
func (*AnalyzeSentimentRequest) MarshalJSON ¶
func (s *AnalyzeSentimentRequest) MarshalJSON() ([]byte, error)
type AnalyzeSentimentResponse ¶
type AnalyzeSentimentResponse struct { // DocumentSentiment: The overall sentiment of the input document. DocumentSentiment *Sentiment `json:"documentSentiment,omitempty"` // Language: The language of the text, which will be the same as the // language specified in the request or, if not specified, the // automatically-detected language. See Document.language field for more // details. Language string `json:"language,omitempty"` // Sentences: The sentiment for all the sentences in the document. Sentences []*Sentence `json:"sentences,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "DocumentSentiment") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DocumentSentiment") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
AnalyzeSentimentResponse: The sentiment analysis response message.
func (*AnalyzeSentimentResponse) MarshalJSON ¶
func (s *AnalyzeSentimentResponse) MarshalJSON() ([]byte, error)
type AnalyzeSyntaxRequest ¶
type AnalyzeSyntaxRequest struct { // Document: Required. Input document. Document *Document `json:"document,omitempty"` // EncodingType: The encoding type used by the API to calculate offsets. // // Possible values: // "NONE" - If `EncodingType` is not specified, encoding-dependent // information (such as `begin_offset`) will be set at `-1`. // "UTF8" - Encoding-dependent information (such as `begin_offset`) is // calculated based on the UTF-8 encoding of the input. C++ and Go are // examples of languages that use this encoding natively. // "UTF16" - Encoding-dependent information (such as `begin_offset`) // is calculated based on the UTF-16 encoding of the input. Java and // JavaScript are examples of languages that use this encoding natively. // "UTF32" - Encoding-dependent information (such as `begin_offset`) // is calculated based on the UTF-32 encoding of the input. Python is an // example of a language that uses this encoding natively. EncodingType string `json:"encodingType,omitempty"` // ForceSendFields is a list of field names (e.g. "Document") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Document") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AnalyzeSyntaxRequest: The syntax analysis request message.
func (*AnalyzeSyntaxRequest) MarshalJSON ¶
func (s *AnalyzeSyntaxRequest) MarshalJSON() ([]byte, error)
type AnalyzeSyntaxResponse ¶
type AnalyzeSyntaxResponse struct { // Language: The language of the text, which will be the same as the // language specified in the request or, if not specified, the // automatically-detected language. See Document.language field for more // details. Language string `json:"language,omitempty"` // Sentences: Sentences in the input document. Sentences []*Sentence `json:"sentences,omitempty"` // Tokens: Tokens, along with their syntactic information, in the input // document. Tokens []*Token `json:"tokens,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Language") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Language") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AnalyzeSyntaxResponse: The syntax analysis response message.
func (*AnalyzeSyntaxResponse) MarshalJSON ¶
func (s *AnalyzeSyntaxResponse) MarshalJSON() ([]byte, error)
type AnnotateTextRequest ¶
type AnnotateTextRequest struct { // Document: Required. Input document. Document *Document `json:"document,omitempty"` // EncodingType: The encoding type used by the API to calculate offsets. // // Possible values: // "NONE" - If `EncodingType` is not specified, encoding-dependent // information (such as `begin_offset`) will be set at `-1`. // "UTF8" - Encoding-dependent information (such as `begin_offset`) is // calculated based on the UTF-8 encoding of the input. C++ and Go are // examples of languages that use this encoding natively. // "UTF16" - Encoding-dependent information (such as `begin_offset`) // is calculated based on the UTF-16 encoding of the input. Java and // JavaScript are examples of languages that use this encoding natively. // "UTF32" - Encoding-dependent information (such as `begin_offset`) // is calculated based on the UTF-32 encoding of the input. Python is an // example of a language that uses this encoding natively. EncodingType string `json:"encodingType,omitempty"` // Features: Required. The enabled features. Features *AnnotateTextRequestFeatures `json:"features,omitempty"` // ForceSendFields is a list of field names (e.g. "Document") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Document") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AnnotateTextRequest: The request message for the text annotation API, which can perform multiple analysis types (sentiment, entities, and syntax) in one call.
func (*AnnotateTextRequest) MarshalJSON ¶
func (s *AnnotateTextRequest) MarshalJSON() ([]byte, error)
type AnnotateTextRequestFeatures ¶ added in v0.167.0
type AnnotateTextRequestFeatures struct { // ClassificationModelOptions: Optional. The model options to use for // classification. Defaults to v1 options if not specified. Only used if // `classify_text` is set to true. ClassificationModelOptions *ClassificationModelOptions `json:"classificationModelOptions,omitempty"` // ClassifyText: Classify the full document into categories. If this is // true, the API will use the default model which classifies into a // predefined taxonomy // (https://cloud.google.com/natural-language/docs/categories). ClassifyText bool `json:"classifyText,omitempty"` // ExtractDocumentSentiment: Extract document-level sentiment. ExtractDocumentSentiment bool `json:"extractDocumentSentiment,omitempty"` // ExtractEntities: Extract entities. ExtractEntities bool `json:"extractEntities,omitempty"` // ExtractEntitySentiment: Extract entities and their associated // sentiment. ExtractEntitySentiment bool `json:"extractEntitySentiment,omitempty"` // ExtractSyntax: Extract syntax information. ExtractSyntax bool `json:"extractSyntax,omitempty"` // ModerateText: Moderate the document for harmful and sensitive // categories. ModerateText bool `json:"moderateText,omitempty"` // ForceSendFields is a list of field names (e.g. // "ClassificationModelOptions") to unconditionally include in API // requests. By default, fields with empty or default values are omitted // from API requests. However, any non-pointer, non-interface field // appearing in ForceSendFields will be sent to the server regardless of // whether the field is empty or not. This may be used to include empty // fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. // "ClassificationModelOptions") to include in API requests with the // JSON null value. By default, fields with empty values are omitted // from API requests. However, any field with an empty value appearing // in NullFields will be sent to the server as null. It is an error if a // field in this list has a non-empty value. This may be used to include // null fields in Patch requests. NullFields []string `json:"-"` }
AnnotateTextRequestFeatures: All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input. Next ID: 12
func (*AnnotateTextRequestFeatures) MarshalJSON ¶ added in v0.167.0
func (s *AnnotateTextRequestFeatures) MarshalJSON() ([]byte, error)
type AnnotateTextResponse ¶
type AnnotateTextResponse struct { // Categories: Categories identified in the input document. Categories []*ClassificationCategory `json:"categories,omitempty"` // DocumentSentiment: The overall sentiment for the document. Populated // if the user enables // AnnotateTextRequest.Features.extract_document_sentiment. DocumentSentiment *Sentiment `json:"documentSentiment,omitempty"` // Entities: Entities, along with their semantic information, in the // input document. Populated if the user enables // AnnotateTextRequest.Features.extract_entities. Entities []*Entity `json:"entities,omitempty"` // Language: The language of the text, which will be the same as the // language specified in the request or, if not specified, the // automatically-detected language. See Document.language field for more // details. Language string `json:"language,omitempty"` // ModerationCategories: Harmful and sensitive categories identified in // the input document. ModerationCategories []*ClassificationCategory `json:"moderationCategories,omitempty"` // Sentences: Sentences in the input document. Populated if the user // enables AnnotateTextRequest.Features.extract_syntax. Sentences []*Sentence `json:"sentences,omitempty"` // Tokens: Tokens, along with their syntactic information, in the input // document. Populated if the user enables // AnnotateTextRequest.Features.extract_syntax. Tokens []*Token `json:"tokens,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Categories") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Categories") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AnnotateTextResponse: The text annotations response message.
func (*AnnotateTextResponse) MarshalJSON ¶
func (s *AnnotateTextResponse) MarshalJSON() ([]byte, error)
type ClassificationCategory ¶
type ClassificationCategory struct { // Confidence: The classifier's confidence of the category. Number // represents how certain the classifier is that this category // represents the given text. Confidence float64 `json:"confidence,omitempty"` // Name: The name of the category representing the document. Name string `json:"name,omitempty"` // ForceSendFields is a list of field names (e.g. "Confidence") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Confidence") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ClassificationCategory: Represents a category returned from the text classifier.
func (*ClassificationCategory) MarshalJSON ¶
func (s *ClassificationCategory) MarshalJSON() ([]byte, error)
func (*ClassificationCategory) UnmarshalJSON ¶
func (s *ClassificationCategory) UnmarshalJSON(data []byte) error
type ClassificationModelOptions ¶ added in v0.98.0
type ClassificationModelOptions struct { // V1Model: Setting this field will use the V1 model and V1 content // categories version. The V1 model is a legacy model; support for this // will be discontinued in the future. V1Model *ClassificationModelOptionsV1Model `json:"v1Model,omitempty"` // V2Model: Setting this field will use the V2 model with the // appropriate content categories version. The V2 model is a better // performing model. V2Model *ClassificationModelOptionsV2Model `json:"v2Model,omitempty"` // ForceSendFields is a list of field names (e.g. "V1Model") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "V1Model") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ClassificationModelOptions: Model options available for classification requests.
func (*ClassificationModelOptions) MarshalJSON ¶ added in v0.98.0
func (s *ClassificationModelOptions) MarshalJSON() ([]byte, error)
type ClassificationModelOptionsV1Model ¶ added in v0.167.0
type ClassificationModelOptionsV1Model struct { }
ClassificationModelOptionsV1Model: Options for the V1 model.
type ClassificationModelOptionsV2Model ¶ added in v0.167.0
type ClassificationModelOptionsV2Model struct { // ContentCategoriesVersion: The content categories used for // classification. // // Possible values: // "CONTENT_CATEGORIES_VERSION_UNSPECIFIED" - If // `ContentCategoriesVersion` is not specified, this option will default // to `V1`. // "V1" - Legacy content categories of our initial launch in 2017. // "V2" - Updated content categories in 2022. ContentCategoriesVersion string `json:"contentCategoriesVersion,omitempty"` // ForceSendFields is a list of field names (e.g. // "ContentCategoriesVersion") to unconditionally include in API // requests. By default, fields with empty or default values are omitted // from API requests. However, any non-pointer, non-interface field // appearing in ForceSendFields will be sent to the server regardless of // whether the field is empty or not. This may be used to include empty // fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ContentCategoriesVersion") // to include in API requests with the JSON null value. By default, // fields with empty values are omitted from API requests. However, any // field with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
ClassificationModelOptionsV2Model: Options for the V2 model.
func (*ClassificationModelOptionsV2Model) MarshalJSON ¶ added in v0.167.0
func (s *ClassificationModelOptionsV2Model) MarshalJSON() ([]byte, error)
type ClassifyTextRequest ¶
type ClassifyTextRequest struct { // ClassificationModelOptions: Optional. Model options to use for // classification. Defaults to v1 options if not specified. ClassificationModelOptions *ClassificationModelOptions `json:"classificationModelOptions,omitempty"` // Document: Required. Input document. Document *Document `json:"document,omitempty"` // ForceSendFields is a list of field names (e.g. // "ClassificationModelOptions") to unconditionally include in API // requests. By default, fields with empty or default values are omitted // from API requests. However, any non-pointer, non-interface field // appearing in ForceSendFields will be sent to the server regardless of // whether the field is empty or not. This may be used to include empty // fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. // "ClassificationModelOptions") to include in API requests with the // JSON null value. By default, fields with empty values are omitted // from API requests. However, any field with an empty value appearing // in NullFields will be sent to the server as null. It is an error if a // field in this list has a non-empty value. This may be used to include // null fields in Patch requests. NullFields []string `json:"-"` }
ClassifyTextRequest: The document classification request message.
func (*ClassifyTextRequest) MarshalJSON ¶
func (s *ClassifyTextRequest) MarshalJSON() ([]byte, error)
type ClassifyTextResponse ¶
type ClassifyTextResponse struct { // Categories: Categories representing the input document. Categories []*ClassificationCategory `json:"categories,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Categories") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Categories") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ClassifyTextResponse: The document classification response message.
func (*ClassifyTextResponse) MarshalJSON ¶
func (s *ClassifyTextResponse) MarshalJSON() ([]byte, error)
type Color ¶ added in v0.167.0
type Color struct { // Alpha: The fraction of this color that should be applied to the // pixel. That is, the final pixel color is defined by the equation: // `pixel color = alpha * (this color) + (1.0 - alpha) * (background // color)` This means that a value of 1.0 corresponds to a solid color, // whereas a value of 0.0 corresponds to a completely transparent color. // This uses a wrapper message rather than a simple float scalar so that // it is possible to distinguish between a default value and the value // being unset. If omitted, this color object is rendered as a solid // color (as if the alpha value had been explicitly given a value of // 1.0). Alpha float64 `json:"alpha,omitempty"` // Blue: The amount of blue in the color as a value in the interval [0, // 1]. Blue float64 `json:"blue,omitempty"` // Green: The amount of green in the color as a value in the interval // [0, 1]. Green float64 `json:"green,omitempty"` // Red: The amount of red in the color as a value in the interval [0, // 1]. Red float64 `json:"red,omitempty"` // ForceSendFields is a list of field names (e.g. "Alpha") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Alpha") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Color: Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(”); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(”); }; // ...
func (*Color) MarshalJSON ¶ added in v0.167.0
func (*Color) UnmarshalJSON ¶ added in v0.167.0
type CpuMetric ¶ added in v0.167.0
type CpuMetric struct { // CoreNumber: Required. Number of CPU cores. CoreNumber int64 `json:"coreNumber,omitempty,string"` // CoreSec: Required. Total seconds of core usage, e.g. 4. CoreSec int64 `json:"coreSec,omitempty,string"` // CpuType: Required. Type of cpu, e.g. N2. // // Possible values: // "UNKNOWN_CPU_TYPE" // "A2" - GPU-based machine, skip quota reporting. // "A3" - GPU-based machine, skip quota reporting. // "C2" - COMPUTE_OPTIMIZED // "C2D" // "CUSTOM" // "E2" // "G2" - GPU-based machine, skip quota reporting. // "C3" // "M2" - MEMORY_OPTIMIZED_UPGRADE_PREMIUM // "M1" - MEMORY_OPTIMIZED // "N1" // "N2_CUSTOM" // "N2" // "N2D" CpuType string `json:"cpuType,omitempty"` // MachineSpec: Required. Machine spec, e.g. N1_STANDARD_4. // // Possible values: // "UNKNOWN_MACHINE_SPEC" // "N1_STANDARD_2" // "N1_STANDARD_4" // "N1_STANDARD_8" // "N1_STANDARD_16" // "N1_STANDARD_32" // "N1_STANDARD_64" // "N1_STANDARD_96" // "N1_HIGHMEM_2" // "N1_HIGHMEM_4" // "N1_HIGHMEM_8" // "N1_HIGHMEM_16" // "N1_HIGHMEM_32" // "N1_HIGHMEM_64" // "N1_HIGHMEM_96" // "N1_HIGHCPU_2" // "N1_HIGHCPU_4" // "N1_HIGHCPU_8" // "N1_HIGHCPU_16" // "N1_HIGHCPU_32" // "N1_HIGHCPU_64" // "N1_HIGHCPU_96" // "A2_HIGHGPU_1G" // "A2_HIGHGPU_2G" // "A2_HIGHGPU_4G" // "A2_HIGHGPU_8G" // "A2_MEGAGPU_16G" // "A2_ULTRAGPU_1G" // "A2_ULTRAGPU_2G" // "A2_ULTRAGPU_4G" // "A2_ULTRAGPU_8G" // "A3_HIGHGPU_8G" // "E2_STANDARD_2" // "E2_STANDARD_4" // "E2_STANDARD_8" // "E2_STANDARD_16" // "E2_STANDARD_32" // "E2_HIGHMEM_2" // "E2_HIGHMEM_4" // "E2_HIGHMEM_8" // "E2_HIGHMEM_16" // "E2_HIGHCPU_2" // "E2_HIGHCPU_4" // "E2_HIGHCPU_8" // "E2_HIGHCPU_16" // "E2_HIGHCPU_32" // "N2_STANDARD_2" // "N2_STANDARD_4" // "N2_STANDARD_8" // "N2_STANDARD_16" // "N2_STANDARD_32" // "N2_STANDARD_48" // "N2_STANDARD_64" // "N2_STANDARD_80" // "N2_STANDARD_96" // "N2_STANDARD_128" // "N2_HIGHMEM_2" // "N2_HIGHMEM_4" // "N2_HIGHMEM_8" // "N2_HIGHMEM_16" // "N2_HIGHMEM_32" // "N2_HIGHMEM_48" // "N2_HIGHMEM_64" // "N2_HIGHMEM_80" // "N2_HIGHMEM_96" // "N2_HIGHMEM_128" // "N2_HIGHCPU_2" // "N2_HIGHCPU_4" // "N2_HIGHCPU_8" // "N2_HIGHCPU_16" // "N2_HIGHCPU_32" // "N2_HIGHCPU_48" // "N2_HIGHCPU_64" // "N2_HIGHCPU_80" // "N2_HIGHCPU_96" // "N2D_STANDARD_2" // "N2D_STANDARD_4" // "N2D_STANDARD_8" // "N2D_STANDARD_16" // "N2D_STANDARD_32" // "N2D_STANDARD_48" // "N2D_STANDARD_64" // "N2D_STANDARD_80" // "N2D_STANDARD_96" // "N2D_STANDARD_128" // "N2D_STANDARD_224" // "N2D_HIGHMEM_2" // "N2D_HIGHMEM_4" // "N2D_HIGHMEM_8" // "N2D_HIGHMEM_16" // "N2D_HIGHMEM_32" // "N2D_HIGHMEM_48" // "N2D_HIGHMEM_64" // "N2D_HIGHMEM_80" // "N2D_HIGHMEM_96" // "N2D_HIGHCPU_2" // "N2D_HIGHCPU_4" // "N2D_HIGHCPU_8" // "N2D_HIGHCPU_16" // "N2D_HIGHCPU_32" // "N2D_HIGHCPU_48" // "N2D_HIGHCPU_64" // "N2D_HIGHCPU_80" // "N2D_HIGHCPU_96" // "N2D_HIGHCPU_128" // "N2D_HIGHCPU_224" // "C2_STANDARD_4" // "C2_STANDARD_8" // "C2_STANDARD_16" // "C2_STANDARD_30" // "C2_STANDARD_60" // "C2D_STANDARD_2" // "C2D_STANDARD_4" // "C2D_STANDARD_8" // "C2D_STANDARD_16" // "C2D_STANDARD_32" // "C2D_STANDARD_56" // "C2D_STANDARD_112" // "C2D_HIGHCPU_2" // "C2D_HIGHCPU_4" // "C2D_HIGHCPU_8" // "C2D_HIGHCPU_16" // "C2D_HIGHCPU_32" // "C2D_HIGHCPU_56" // "C2D_HIGHCPU_112" // "C2D_HIGHMEM_2" // "C2D_HIGHMEM_4" // "C2D_HIGHMEM_8" // "C2D_HIGHMEM_16" // "C2D_HIGHMEM_32" // "C2D_HIGHMEM_56" // "C2D_HIGHMEM_112" // "G2_STANDARD_4" // "G2_STANDARD_8" // "G2_STANDARD_12" // "G2_STANDARD_16" // "G2_STANDARD_24" // "G2_STANDARD_32" // "G2_STANDARD_48" // "G2_STANDARD_96" // "C3_STANDARD_4" // "C3_STANDARD_8" // "C3_STANDARD_22" // "C3_STANDARD_44" // "C3_STANDARD_88" // "C3_STANDARD_176" // "C3_HIGHCPU_4" // "C3_HIGHCPU_8" // "C3_HIGHCPU_22" // "C3_HIGHCPU_44" // "C3_HIGHCPU_88" // "C3_HIGHCPU_176" // "C3_HIGHMEM_4" // "C3_HIGHMEM_8" // "C3_HIGHMEM_22" // "C3_HIGHMEM_44" // "C3_HIGHMEM_88" // "C3_HIGHMEM_176" MachineSpec string `json:"machineSpec,omitempty"` // TrackingLabels: Billing tracking labels. They do not contain any user // data but only the labels set by Vertex Core Infra itself. Tracking // labels' keys are defined with special format: goog-[\p{Ll}\p{N}]+ // E.g. "key": "goog-k8s-cluster-name","value": "us-east1-b4rk" TrackingLabels map[string]string `json:"trackingLabels,omitempty"` // ForceSendFields is a list of field names (e.g. "CoreNumber") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CoreNumber") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
CpuMetric: Metric for billing reports.
func (*CpuMetric) MarshalJSON ¶ added in v0.167.0
type DependencyEdge ¶
type DependencyEdge struct { // HeadTokenIndex: Represents the head of this token in the dependency // tree. This is the index of the token which has an arc going to this // token. The index is the position of the token in the array of tokens // returned by the API method. If this token is a root token, then the // `head_token_index` is its own index. HeadTokenIndex int64 `json:"headTokenIndex,omitempty"` // Label: The parse label for the token. // // Possible values: // "UNKNOWN" - Unknown // "ABBREV" - Abbreviation modifier // "ACOMP" - Adjectival complement // "ADVCL" - Adverbial clause modifier // "ADVMOD" - Adverbial modifier // "AMOD" - Adjectival modifier of an NP // "APPOS" - Appositional modifier of an NP // "ATTR" - Attribute dependent of a copular verb // "AUX" - Auxiliary (non-main) verb // "AUXPASS" - Passive auxiliary // "CC" - Coordinating conjunction // "CCOMP" - Clausal complement of a verb or adjective // "CONJ" - Conjunct // "CSUBJ" - Clausal subject // "CSUBJPASS" - Clausal passive subject // "DEP" - Dependency (unable to determine) // "DET" - Determiner // "DISCOURSE" - Discourse // "DOBJ" - Direct object // "EXPL" - Expletive // "GOESWITH" - Goes with (part of a word in a text not well edited) // "IOBJ" - Indirect object // "MARK" - Marker (word introducing a subordinate clause) // "MWE" - Multi-word expression // "MWV" - Multi-word verbal expression // "NEG" - Negation modifier // "NN" - Noun compound modifier // "NPADVMOD" - Noun phrase used as an adverbial modifier // "NSUBJ" - Nominal subject // "NSUBJPASS" - Passive nominal subject // "NUM" - Numeric modifier of a noun // "NUMBER" - Element of compound number // "P" - Punctuation mark // "PARATAXIS" - Parataxis relation // "PARTMOD" - Participial modifier // "PCOMP" - The complement of a preposition is a clause // "POBJ" - Object of a preposition // "POSS" - Possession modifier // "POSTNEG" - Postverbal negative particle // "PRECOMP" - Predicate complement // "PRECONJ" - Preconjunt // "PREDET" - Predeterminer // "PREF" - Prefix // "PREP" - Prepositional modifier // "PRONL" - The relationship between a verb and verbal morpheme // "PRT" - Particle // "PS" - Associative or possessive marker // "QUANTMOD" - Quantifier phrase modifier // "RCMOD" - Relative clause modifier // "RCMODREL" - Complementizer in relative clause // "RDROP" - Ellipsis without a preceding predicate // "REF" - Referent // "REMNANT" - Remnant // "REPARANDUM" - Reparandum // "ROOT" - Root // "SNUM" - Suffix specifying a unit of number // "SUFF" - Suffix // "TMOD" - Temporal modifier // "TOPIC" - Topic marker // "VMOD" - Clause headed by an infinite form of the verb that // modifies a noun // "VOCATIVE" - Vocative // "XCOMP" - Open clausal complement // "SUFFIX" - Name suffix // "TITLE" - Name title // "ADVPHMOD" - Adverbial phrase modifier // "AUXCAUS" - Causative auxiliary // "AUXVV" - Helper auxiliary // "DTMOD" - Rentaishi (Prenominal modifier) // "FOREIGN" - Foreign words // "KW" - Keyword // "LIST" - List for chains of comparable items // "NOMC" - Nominalized clause // "NOMCSUBJ" - Nominalized clausal subject // "NOMCSUBJPASS" - Nominalized clausal passive // "NUMC" - Compound of numeric modifier // "COP" - Copula // "DISLOCATED" - Dislocated relation (for fronted/topicalized // elements) // "ASP" - Aspect marker // "GMOD" - Genitive modifier // "GOBJ" - Genitive object // "INFMOD" - Infinitival modifier // "MES" - Measure // "NCOMP" - Nominal complement of a noun Label string `json:"label,omitempty"` // ForceSendFields is a list of field names (e.g. "HeadTokenIndex") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "HeadTokenIndex") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
DependencyEdge: Represents dependency parse tree information for a token.
func (*DependencyEdge) MarshalJSON ¶
func (s *DependencyEdge) MarshalJSON() ([]byte, error)
type DiskMetric ¶ added in v0.167.0
type DiskMetric struct { // DiskType: Required. Type of Disk, e.g. REGIONAL_SSD. // // Possible values: // "UNKNOWN_DISK_TYPE" // "REGIONAL_SSD" // "REGIONAL_STORAGE" // "PD_SSD" // "PD_STANDARD" // "STORAGE_SNAPSHOT" DiskType string `json:"diskType,omitempty"` // GibSec: Required. Seconds of physical disk usage, e.g. 3600. GibSec int64 `json:"gibSec,omitempty,string"` // ForceSendFields is a list of field names (e.g. "DiskType") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DiskType") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*DiskMetric) MarshalJSON ¶ added in v0.167.0
func (s *DiskMetric) MarshalJSON() ([]byte, error)
type Document ¶
type Document struct { // BoilerplateHandling: Indicates how detected boilerplate(e.g. // advertisements, copyright declarations, banners) should be handled // for this document. If not specified, boilerplate will be treated the // same as content. // // Possible values: // "BOILERPLATE_HANDLING_UNSPECIFIED" - The boilerplate handling is // not specified. // "SKIP_BOILERPLATE" - Do not analyze detected boilerplate. Reference // web URI is required for detecting boilerplate. // "KEEP_BOILERPLATE" - Treat boilerplate the same as content. BoilerplateHandling string `json:"boilerplateHandling,omitempty"` // Content: The content of the input in string format. Cloud audit // logging exempt since it is based on user data. Content string `json:"content,omitempty"` // GcsContentUri: The Google Cloud Storage URI where the file content is // located. This URI must be of the form: gs://bucket_name/object_name. // For more details, see // https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud // Storage object versioning is not supported. GcsContentUri string `json:"gcsContentUri,omitempty"` // Language: The language of the document (if not specified, the // language is automatically detected). Both ISO and BCP-47 language // codes are accepted. Language Support // (https://cloud.google.com/natural-language/docs/languages) lists // currently supported languages for each API method. If the language // (either specified by the caller or automatically detected) is not // supported by the called API method, an `INVALID_ARGUMENT` error is // returned. Language string `json:"language,omitempty"` // ReferenceWebUri: The web URI where the document comes from. This URI // is not used for fetching the content, but as a hint for analyzing the // document. ReferenceWebUri string `json:"referenceWebUri,omitempty"` // Type: Required. If the type is not set or is `TYPE_UNSPECIFIED`, // returns an `INVALID_ARGUMENT` error. // // Possible values: // "TYPE_UNSPECIFIED" - The content type is not specified. // "PLAIN_TEXT" - Plain text // "HTML" - HTML Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "BoilerplateHandling") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BoilerplateHandling") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
Document: Represents the input to API methods.
func (*Document) MarshalJSON ¶
type DocumentsAnalyzeEntitiesCall ¶
type DocumentsAnalyzeEntitiesCall struct {
// contains filtered or unexported fields
}
func (*DocumentsAnalyzeEntitiesCall) Context ¶
func (c *DocumentsAnalyzeEntitiesCall) Context(ctx context.Context) *DocumentsAnalyzeEntitiesCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*DocumentsAnalyzeEntitiesCall) Do ¶
func (c *DocumentsAnalyzeEntitiesCall) Do(opts ...googleapi.CallOption) (*AnalyzeEntitiesResponse, error)
Do executes the "language.documents.analyzeEntities" call. Exactly one of *AnalyzeEntitiesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AnalyzeEntitiesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*DocumentsAnalyzeEntitiesCall) Fields ¶
func (c *DocumentsAnalyzeEntitiesCall) Fields(s ...googleapi.Field) *DocumentsAnalyzeEntitiesCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*DocumentsAnalyzeEntitiesCall) Header ¶
func (c *DocumentsAnalyzeEntitiesCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type DocumentsAnalyzeEntitySentimentCall ¶
type DocumentsAnalyzeEntitySentimentCall struct {
// contains filtered or unexported fields
}
func (*DocumentsAnalyzeEntitySentimentCall) Context ¶
func (c *DocumentsAnalyzeEntitySentimentCall) Context(ctx context.Context) *DocumentsAnalyzeEntitySentimentCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*DocumentsAnalyzeEntitySentimentCall) Do ¶
func (c *DocumentsAnalyzeEntitySentimentCall) Do(opts ...googleapi.CallOption) (*AnalyzeEntitySentimentResponse, error)
Do executes the "language.documents.analyzeEntitySentiment" call. Exactly one of *AnalyzeEntitySentimentResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AnalyzeEntitySentimentResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*DocumentsAnalyzeEntitySentimentCall) Fields ¶
func (c *DocumentsAnalyzeEntitySentimentCall) Fields(s ...googleapi.Field) *DocumentsAnalyzeEntitySentimentCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*DocumentsAnalyzeEntitySentimentCall) Header ¶
func (c *DocumentsAnalyzeEntitySentimentCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type DocumentsAnalyzeSentimentCall ¶
type DocumentsAnalyzeSentimentCall struct {
// contains filtered or unexported fields
}
func (*DocumentsAnalyzeSentimentCall) Context ¶
func (c *DocumentsAnalyzeSentimentCall) Context(ctx context.Context) *DocumentsAnalyzeSentimentCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*DocumentsAnalyzeSentimentCall) Do ¶
func (c *DocumentsAnalyzeSentimentCall) Do(opts ...googleapi.CallOption) (*AnalyzeSentimentResponse, error)
Do executes the "language.documents.analyzeSentiment" call. Exactly one of *AnalyzeSentimentResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AnalyzeSentimentResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*DocumentsAnalyzeSentimentCall) Fields ¶
func (c *DocumentsAnalyzeSentimentCall) Fields(s ...googleapi.Field) *DocumentsAnalyzeSentimentCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*DocumentsAnalyzeSentimentCall) Header ¶
func (c *DocumentsAnalyzeSentimentCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type DocumentsAnalyzeSyntaxCall ¶
type DocumentsAnalyzeSyntaxCall struct {
// contains filtered or unexported fields
}
func (*DocumentsAnalyzeSyntaxCall) Context ¶
func (c *DocumentsAnalyzeSyntaxCall) Context(ctx context.Context) *DocumentsAnalyzeSyntaxCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*DocumentsAnalyzeSyntaxCall) Do ¶
func (c *DocumentsAnalyzeSyntaxCall) Do(opts ...googleapi.CallOption) (*AnalyzeSyntaxResponse, error)
Do executes the "language.documents.analyzeSyntax" call. Exactly one of *AnalyzeSyntaxResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AnalyzeSyntaxResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*DocumentsAnalyzeSyntaxCall) Fields ¶
func (c *DocumentsAnalyzeSyntaxCall) Fields(s ...googleapi.Field) *DocumentsAnalyzeSyntaxCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*DocumentsAnalyzeSyntaxCall) Header ¶
func (c *DocumentsAnalyzeSyntaxCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type DocumentsAnnotateTextCall ¶
type DocumentsAnnotateTextCall struct {
// contains filtered or unexported fields
}
func (*DocumentsAnnotateTextCall) Context ¶
func (c *DocumentsAnnotateTextCall) Context(ctx context.Context) *DocumentsAnnotateTextCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*DocumentsAnnotateTextCall) Do ¶
func (c *DocumentsAnnotateTextCall) Do(opts ...googleapi.CallOption) (*AnnotateTextResponse, error)
Do executes the "language.documents.annotateText" call. Exactly one of *AnnotateTextResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AnnotateTextResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*DocumentsAnnotateTextCall) Fields ¶
func (c *DocumentsAnnotateTextCall) Fields(s ...googleapi.Field) *DocumentsAnnotateTextCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*DocumentsAnnotateTextCall) Header ¶
func (c *DocumentsAnnotateTextCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type DocumentsClassifyTextCall ¶
type DocumentsClassifyTextCall struct {
// contains filtered or unexported fields
}
func (*DocumentsClassifyTextCall) Context ¶
func (c *DocumentsClassifyTextCall) Context(ctx context.Context) *DocumentsClassifyTextCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*DocumentsClassifyTextCall) Do ¶
func (c *DocumentsClassifyTextCall) Do(opts ...googleapi.CallOption) (*ClassifyTextResponse, error)
Do executes the "language.documents.classifyText" call. Exactly one of *ClassifyTextResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ClassifyTextResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*DocumentsClassifyTextCall) Fields ¶
func (c *DocumentsClassifyTextCall) Fields(s ...googleapi.Field) *DocumentsClassifyTextCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*DocumentsClassifyTextCall) Header ¶
func (c *DocumentsClassifyTextCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type DocumentsModerateTextCall ¶ added in v0.126.0
type DocumentsModerateTextCall struct {
// contains filtered or unexported fields
}
func (*DocumentsModerateTextCall) Context ¶ added in v0.126.0
func (c *DocumentsModerateTextCall) Context(ctx context.Context) *DocumentsModerateTextCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*DocumentsModerateTextCall) Do ¶ added in v0.126.0
func (c *DocumentsModerateTextCall) Do(opts ...googleapi.CallOption) (*ModerateTextResponse, error)
Do executes the "language.documents.moderateText" call. Exactly one of *ModerateTextResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ModerateTextResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*DocumentsModerateTextCall) Fields ¶ added in v0.126.0
func (c *DocumentsModerateTextCall) Fields(s ...googleapi.Field) *DocumentsModerateTextCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*DocumentsModerateTextCall) Header ¶ added in v0.126.0
func (c *DocumentsModerateTextCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type DocumentsService ¶
type DocumentsService struct {
// contains filtered or unexported fields
}
func NewDocumentsService ¶
func NewDocumentsService(s *Service) *DocumentsService
func (*DocumentsService) AnalyzeEntities ¶
func (r *DocumentsService) AnalyzeEntities(analyzeentitiesrequest *AnalyzeEntitiesRequest) *DocumentsAnalyzeEntitiesCall
AnalyzeEntities: Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties.
func (*DocumentsService) AnalyzeEntitySentiment ¶
func (r *DocumentsService) AnalyzeEntitySentiment(analyzeentitysentimentrequest *AnalyzeEntitySentimentRequest) *DocumentsAnalyzeEntitySentimentCall
AnalyzeEntitySentiment: Finds entities, similar to AnalyzeEntities in the text and analyzes sentiment associated with each entity and its mentions.
func (*DocumentsService) AnalyzeSentiment ¶
func (r *DocumentsService) AnalyzeSentiment(analyzesentimentrequest *AnalyzeSentimentRequest) *DocumentsAnalyzeSentimentCall
AnalyzeSentiment: Analyzes the sentiment of the provided text.
func (*DocumentsService) AnalyzeSyntax ¶
func (r *DocumentsService) AnalyzeSyntax(analyzesyntaxrequest *AnalyzeSyntaxRequest) *DocumentsAnalyzeSyntaxCall
AnalyzeSyntax: Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties.
func (*DocumentsService) AnnotateText ¶
func (r *DocumentsService) AnnotateText(annotatetextrequest *AnnotateTextRequest) *DocumentsAnnotateTextCall
AnnotateText: A convenience method that provides all syntax, sentiment, entity, and classification features in one call.
func (*DocumentsService) ClassifyText ¶
func (r *DocumentsService) ClassifyText(classifytextrequest *ClassifyTextRequest) *DocumentsClassifyTextCall
ClassifyText: Classifies a document into categories.
func (*DocumentsService) ModerateText ¶ added in v0.126.0
func (r *DocumentsService) ModerateText(moderatetextrequest *ModerateTextRequest) *DocumentsModerateTextCall
ModerateText: Moderates a document for harmful and sensitive categories.
type Entity ¶
type Entity struct { // Mentions: The mentions of this entity in the input document. The API // currently supports proper noun mentions. Mentions []*EntityMention `json:"mentions,omitempty"` // Metadata: Metadata associated with the entity. For most entity types, // the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph // MID (`mid`), if they are available. For the metadata associated with // other entity types, see the Type table below. Metadata map[string]string `json:"metadata,omitempty"` // Name: The representative name for the entity. Name string `json:"name,omitempty"` // Salience: The salience score associated with the entity in the [0, // 1.0] range. The salience score for an entity provides information // about the importance or centrality of that entity to the entire // document text. Scores closer to 0 are less salient, while scores // closer to 1.0 are highly salient. Salience float64 `json:"salience,omitempty"` // Sentiment: For calls to AnalyzeEntitySentiment or if // AnnotateTextRequest.Features.extract_entity_sentiment is set to true, // this field will contain the aggregate sentiment expressed for this // entity in the provided document. Sentiment *Sentiment `json:"sentiment,omitempty"` // Type: The entity type. // // Possible values: // "UNKNOWN" - Unknown // "PERSON" - Person // "LOCATION" - Location // "ORGANIZATION" - Organization // "EVENT" - Event // "WORK_OF_ART" - Artwork // "CONSUMER_GOOD" - Consumer product // "OTHER" - Other types of entities // "PHONE_NUMBER" - Phone number The metadata lists the phone number, // formatted according to local convention, plus whichever additional // elements appear in the text: * `number` - the actual number, broken // down into sections as per local convention * `national_prefix` - // country code, if detected * `area_code` - region or area code, if // detected * `extension` - phone extension (to be dialed after // connection), if detected // "ADDRESS" - Address The metadata identifies the street number and // locality plus whichever additional elements appear in the text: * // `street_number` - street number * `locality` - city or town * // `street_name` - street/route name, if detected * `postal_code` - // postal code, if detected * `country` - country, if detected< * // `broad_region` - administrative area, such as the state, if detected // * `narrow_region` - smaller administrative area, such as county, if // detected * `sublocality` - used in Asian addresses to demark a // district within a city, if detected // "DATE" - Date The metadata identifies the components of the date: * // `year` - four digit year, if detected * `month` - two digit month // number, if detected * `day` - two digit day number, if detected // "NUMBER" - Number The metadata is the number itself. // "PRICE" - Price The metadata identifies the `value` and `currency`. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Mentions") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Mentions") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Entity: Represents a phrase in the text that is a known entity, such as a person, an organization, or location. The API associates information, such as salience and mentions, with entities.
func (*Entity) MarshalJSON ¶
func (*Entity) UnmarshalJSON ¶
type EntityMention ¶
type EntityMention struct { // Sentiment: For calls to AnalyzeEntitySentiment or if // AnnotateTextRequest.Features.extract_entity_sentiment is set to true, // this field will contain the sentiment expressed for this mention of // the entity in the provided document. Sentiment *Sentiment `json:"sentiment,omitempty"` // Text: The mention text. Text *TextSpan `json:"text,omitempty"` // Type: The type of the entity mention. // // Possible values: // "TYPE_UNKNOWN" - Unknown // "PROPER" - Proper name // "COMMON" - Common noun (or noun compound) Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Sentiment") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Sentiment") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
EntityMention: Represents a mention for an entity in the text. Currently, proper noun mentions are supported.
func (*EntityMention) MarshalJSON ¶
func (s *EntityMention) MarshalJSON() ([]byte, error)
type GpuMetric ¶ added in v0.167.0
type GpuMetric struct { // GpuSec: Required. Seconds of GPU usage, e.g. 3600. GpuSec int64 `json:"gpuSec,omitempty,string"` // GpuType: Required. Type of GPU, e.g. NVIDIA_TESLA_V100. // // Possible values: // "UNKNOWN_GPU_TYPE" // "NVIDIA_TESLA_A100" // "NVIDIA_A100_80GB" // "NVIDIA_TESLA_K80" // "NVIDIA_L4" // "NVIDIA_TESLA_P100" // "NVIDIA_TESLA_P4" // "NVIDIA_TESLA_T4" // "NVIDIA_TESLA_V100" // "NVIDIA_H100_80GB" GpuType string `json:"gpuType,omitempty"` // MachineSpec: Required. Machine spec, e.g. N1_STANDARD_4. // // Possible values: // "UNKNOWN_MACHINE_SPEC" // "N1_STANDARD_2" // "N1_STANDARD_4" // "N1_STANDARD_8" // "N1_STANDARD_16" // "N1_STANDARD_32" // "N1_STANDARD_64" // "N1_STANDARD_96" // "N1_HIGHMEM_2" // "N1_HIGHMEM_4" // "N1_HIGHMEM_8" // "N1_HIGHMEM_16" // "N1_HIGHMEM_32" // "N1_HIGHMEM_64" // "N1_HIGHMEM_96" // "N1_HIGHCPU_2" // "N1_HIGHCPU_4" // "N1_HIGHCPU_8" // "N1_HIGHCPU_16" // "N1_HIGHCPU_32" // "N1_HIGHCPU_64" // "N1_HIGHCPU_96" // "A2_HIGHGPU_1G" // "A2_HIGHGPU_2G" // "A2_HIGHGPU_4G" // "A2_HIGHGPU_8G" // "A2_MEGAGPU_16G" // "A2_ULTRAGPU_1G" // "A2_ULTRAGPU_2G" // "A2_ULTRAGPU_4G" // "A2_ULTRAGPU_8G" // "A3_HIGHGPU_8G" // "E2_STANDARD_2" // "E2_STANDARD_4" // "E2_STANDARD_8" // "E2_STANDARD_16" // "E2_STANDARD_32" // "E2_HIGHMEM_2" // "E2_HIGHMEM_4" // "E2_HIGHMEM_8" // "E2_HIGHMEM_16" // "E2_HIGHCPU_2" // "E2_HIGHCPU_4" // "E2_HIGHCPU_8" // "E2_HIGHCPU_16" // "E2_HIGHCPU_32" // "N2_STANDARD_2" // "N2_STANDARD_4" // "N2_STANDARD_8" // "N2_STANDARD_16" // "N2_STANDARD_32" // "N2_STANDARD_48" // "N2_STANDARD_64" // "N2_STANDARD_80" // "N2_STANDARD_96" // "N2_STANDARD_128" // "N2_HIGHMEM_2" // "N2_HIGHMEM_4" // "N2_HIGHMEM_8" // "N2_HIGHMEM_16" // "N2_HIGHMEM_32" // "N2_HIGHMEM_48" // "N2_HIGHMEM_64" // "N2_HIGHMEM_80" // "N2_HIGHMEM_96" // "N2_HIGHMEM_128" // "N2_HIGHCPU_2" // "N2_HIGHCPU_4" // "N2_HIGHCPU_8" // "N2_HIGHCPU_16" // "N2_HIGHCPU_32" // "N2_HIGHCPU_48" // "N2_HIGHCPU_64" // "N2_HIGHCPU_80" // "N2_HIGHCPU_96" // "N2D_STANDARD_2" // "N2D_STANDARD_4" // "N2D_STANDARD_8" // "N2D_STANDARD_16" // "N2D_STANDARD_32" // "N2D_STANDARD_48" // "N2D_STANDARD_64" // "N2D_STANDARD_80" // "N2D_STANDARD_96" // "N2D_STANDARD_128" // "N2D_STANDARD_224" // "N2D_HIGHMEM_2" // "N2D_HIGHMEM_4" // "N2D_HIGHMEM_8" // "N2D_HIGHMEM_16" // "N2D_HIGHMEM_32" // "N2D_HIGHMEM_48" // "N2D_HIGHMEM_64" // "N2D_HIGHMEM_80" // "N2D_HIGHMEM_96" // "N2D_HIGHCPU_2" // "N2D_HIGHCPU_4" // "N2D_HIGHCPU_8" // "N2D_HIGHCPU_16" // "N2D_HIGHCPU_32" // "N2D_HIGHCPU_48" // "N2D_HIGHCPU_64" // "N2D_HIGHCPU_80" // "N2D_HIGHCPU_96" // "N2D_HIGHCPU_128" // "N2D_HIGHCPU_224" // "C2_STANDARD_4" // "C2_STANDARD_8" // "C2_STANDARD_16" // "C2_STANDARD_30" // "C2_STANDARD_60" // "C2D_STANDARD_2" // "C2D_STANDARD_4" // "C2D_STANDARD_8" // "C2D_STANDARD_16" // "C2D_STANDARD_32" // "C2D_STANDARD_56" // "C2D_STANDARD_112" // "C2D_HIGHCPU_2" // "C2D_HIGHCPU_4" // "C2D_HIGHCPU_8" // "C2D_HIGHCPU_16" // "C2D_HIGHCPU_32" // "C2D_HIGHCPU_56" // "C2D_HIGHCPU_112" // "C2D_HIGHMEM_2" // "C2D_HIGHMEM_4" // "C2D_HIGHMEM_8" // "C2D_HIGHMEM_16" // "C2D_HIGHMEM_32" // "C2D_HIGHMEM_56" // "C2D_HIGHMEM_112" // "G2_STANDARD_4" // "G2_STANDARD_8" // "G2_STANDARD_12" // "G2_STANDARD_16" // "G2_STANDARD_24" // "G2_STANDARD_32" // "G2_STANDARD_48" // "G2_STANDARD_96" // "C3_STANDARD_4" // "C3_STANDARD_8" // "C3_STANDARD_22" // "C3_STANDARD_44" // "C3_STANDARD_88" // "C3_STANDARD_176" // "C3_HIGHCPU_4" // "C3_HIGHCPU_8" // "C3_HIGHCPU_22" // "C3_HIGHCPU_44" // "C3_HIGHCPU_88" // "C3_HIGHCPU_176" // "C3_HIGHMEM_4" // "C3_HIGHMEM_8" // "C3_HIGHMEM_22" // "C3_HIGHMEM_44" // "C3_HIGHMEM_88" // "C3_HIGHMEM_176" MachineSpec string `json:"machineSpec,omitempty"` // TrackingLabels: Billing tracking labels. They do not contain any user // data but only the labels set by Vertex Core Infra itself. Tracking // labels' keys are defined with special format: goog-[\p{Ll}\p{N}]+ // E.g. "key": "goog-k8s-cluster-name","value": "us-east1-b4rk" TrackingLabels map[string]string `json:"trackingLabels,omitempty"` // ForceSendFields is a list of field names (e.g. "GpuSec") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "GpuSec") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*GpuMetric) MarshalJSON ¶ added in v0.167.0
type InfraUsage ¶ added in v0.167.0
type InfraUsage struct { // CpuMetrics: Aggregated core metrics since requested start_time. CpuMetrics []*CpuMetric `json:"cpuMetrics,omitempty"` // DiskMetrics: Aggregated persistent disk metrics since requested // start_time. DiskMetrics []*DiskMetric `json:"diskMetrics,omitempty"` // GpuMetrics: Aggregated gpu metrics since requested start_time. GpuMetrics []*GpuMetric `json:"gpuMetrics,omitempty"` // RamMetrics: Aggregated ram metrics since requested start_time. RamMetrics []*RamMetric `json:"ramMetrics,omitempty"` // TpuMetrics: Aggregated tpu metrics since requested start_time. TpuMetrics []*TpuMetric `json:"tpuMetrics,omitempty"` // ForceSendFields is a list of field names (e.g. "CpuMetrics") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CpuMetrics") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
InfraUsage: Infra Usage of billing metrics. Next ID: 6
func (*InfraUsage) MarshalJSON ¶ added in v0.167.0
func (s *InfraUsage) MarshalJSON() ([]byte, error)
type ModerateTextRequest ¶ added in v0.126.0
type ModerateTextRequest struct { // Document: Required. Input document. Document *Document `json:"document,omitempty"` // ForceSendFields is a list of field names (e.g. "Document") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Document") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ModerateTextRequest: The document moderation request message.
func (*ModerateTextRequest) MarshalJSON ¶ added in v0.126.0
func (s *ModerateTextRequest) MarshalJSON() ([]byte, error)
type ModerateTextResponse ¶ added in v0.126.0
type ModerateTextResponse struct { // ModerationCategories: Harmful and sensitive categories representing // the input document. ModerationCategories []*ClassificationCategory `json:"moderationCategories,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. // "ModerationCategories") to unconditionally include in API requests. // By default, fields with empty or default values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ModerationCategories") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
ModerateTextResponse: The document moderation response message.
func (*ModerateTextResponse) MarshalJSON ¶ added in v0.126.0
func (s *ModerateTextResponse) MarshalJSON() ([]byte, error)
type PartOfSpeech ¶
type PartOfSpeech struct { // Aspect: The grammatical aspect. // // Possible values: // "ASPECT_UNKNOWN" - Aspect is not applicable in the analyzed // language or is not predicted. // "PERFECTIVE" - Perfective // "IMPERFECTIVE" - Imperfective // "PROGRESSIVE" - Progressive Aspect string `json:"aspect,omitempty"` // Case: The grammatical case. // // Possible values: // "CASE_UNKNOWN" - Case is not applicable in the analyzed language or // is not predicted. // "ACCUSATIVE" - Accusative // "ADVERBIAL" - Adverbial // "COMPLEMENTIVE" - Complementive // "DATIVE" - Dative // "GENITIVE" - Genitive // "INSTRUMENTAL" - Instrumental // "LOCATIVE" - Locative // "NOMINATIVE" - Nominative // "OBLIQUE" - Oblique // "PARTITIVE" - Partitive // "PREPOSITIONAL" - Prepositional // "REFLEXIVE_CASE" - Reflexive // "RELATIVE_CASE" - Relative // "VOCATIVE" - Vocative Case string `json:"case,omitempty"` // Form: The grammatical form. // // Possible values: // "FORM_UNKNOWN" - Form is not applicable in the analyzed language or // is not predicted. // "ADNOMIAL" - Adnomial // "AUXILIARY" - Auxiliary // "COMPLEMENTIZER" - Complementizer // "FINAL_ENDING" - Final ending // "GERUND" - Gerund // "REALIS" - Realis // "IRREALIS" - Irrealis // "SHORT" - Short form // "LONG" - Long form // "ORDER" - Order form // "SPECIFIC" - Specific form Form string `json:"form,omitempty"` // Gender: The grammatical gender. // // Possible values: // "GENDER_UNKNOWN" - Gender is not applicable in the analyzed // language or is not predicted. // "FEMININE" - Feminine // "MASCULINE" - Masculine // "NEUTER" - Neuter Gender string `json:"gender,omitempty"` // Mood: The grammatical mood. // // Possible values: // "MOOD_UNKNOWN" - Mood is not applicable in the analyzed language or // is not predicted. // "CONDITIONAL_MOOD" - Conditional // "IMPERATIVE" - Imperative // "INDICATIVE" - Indicative // "INTERROGATIVE" - Interrogative // "JUSSIVE" - Jussive // "SUBJUNCTIVE" - Subjunctive Mood string `json:"mood,omitempty"` // Number: The grammatical number. // // Possible values: // "NUMBER_UNKNOWN" - Number is not applicable in the analyzed // language or is not predicted. // "SINGULAR" - Singular // "PLURAL" - Plural // "DUAL" - Dual Number string `json:"number,omitempty"` // Person: The grammatical person. // // Possible values: // "PERSON_UNKNOWN" - Person is not applicable in the analyzed // language or is not predicted. // "FIRST" - First // "SECOND" - Second // "THIRD" - Third // "REFLEXIVE_PERSON" - Reflexive Person string `json:"person,omitempty"` // Proper: The grammatical properness. // // Possible values: // "PROPER_UNKNOWN" - Proper is not applicable in the analyzed // language or is not predicted. // "PROPER" - Proper // "NOT_PROPER" - Not proper Proper string `json:"proper,omitempty"` // Reciprocity: The grammatical reciprocity. // // Possible values: // "RECIPROCITY_UNKNOWN" - Reciprocity is not applicable in the // analyzed language or is not predicted. // "RECIPROCAL" - Reciprocal // "NON_RECIPROCAL" - Non-reciprocal Reciprocity string `json:"reciprocity,omitempty"` // Tag: The part of speech tag. // // Possible values: // "UNKNOWN" - Unknown // "ADJ" - Adjective // "ADP" - Adposition (preposition and postposition) // "ADV" - Adverb // "CONJ" - Conjunction // "DET" - Determiner // "NOUN" - Noun (common and proper) // "NUM" - Cardinal number // "PRON" - Pronoun // "PRT" - Particle or other function word // "PUNCT" - Punctuation // "VERB" - Verb (all tenses and modes) // "X" - Other: foreign words, typos, abbreviations // "AFFIX" - Affix Tag string `json:"tag,omitempty"` // Tense: The grammatical tense. // // Possible values: // "TENSE_UNKNOWN" - Tense is not applicable in the analyzed language // or is not predicted. // "CONDITIONAL_TENSE" - Conditional // "FUTURE" - Future // "PAST" - Past // "PRESENT" - Present // "IMPERFECT" - Imperfect // "PLUPERFECT" - Pluperfect Tense string `json:"tense,omitempty"` // Voice: The grammatical voice. // // Possible values: // "VOICE_UNKNOWN" - Voice is not applicable in the analyzed language // or is not predicted. // "ACTIVE" - Active // "CAUSATIVE" - Causative // "PASSIVE" - Passive Voice string `json:"voice,omitempty"` // ForceSendFields is a list of field names (e.g. "Aspect") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Aspect") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
PartOfSpeech: Represents part of speech information for a token.
func (*PartOfSpeech) MarshalJSON ¶
func (s *PartOfSpeech) MarshalJSON() ([]byte, error)
type RamMetric ¶ added in v0.167.0
type RamMetric struct { // GibSec: Required. VM memory in Gigabyte second, e.g. 3600. Using // int64 type to match billing metrics definition. GibSec int64 `json:"gibSec,omitempty,string"` // MachineSpec: Required. Machine spec, e.g. N1_STANDARD_4. // // Possible values: // "UNKNOWN_MACHINE_SPEC" // "N1_STANDARD_2" // "N1_STANDARD_4" // "N1_STANDARD_8" // "N1_STANDARD_16" // "N1_STANDARD_32" // "N1_STANDARD_64" // "N1_STANDARD_96" // "N1_HIGHMEM_2" // "N1_HIGHMEM_4" // "N1_HIGHMEM_8" // "N1_HIGHMEM_16" // "N1_HIGHMEM_32" // "N1_HIGHMEM_64" // "N1_HIGHMEM_96" // "N1_HIGHCPU_2" // "N1_HIGHCPU_4" // "N1_HIGHCPU_8" // "N1_HIGHCPU_16" // "N1_HIGHCPU_32" // "N1_HIGHCPU_64" // "N1_HIGHCPU_96" // "A2_HIGHGPU_1G" // "A2_HIGHGPU_2G" // "A2_HIGHGPU_4G" // "A2_HIGHGPU_8G" // "A2_MEGAGPU_16G" // "A2_ULTRAGPU_1G" // "A2_ULTRAGPU_2G" // "A2_ULTRAGPU_4G" // "A2_ULTRAGPU_8G" // "A3_HIGHGPU_8G" // "E2_STANDARD_2" // "E2_STANDARD_4" // "E2_STANDARD_8" // "E2_STANDARD_16" // "E2_STANDARD_32" // "E2_HIGHMEM_2" // "E2_HIGHMEM_4" // "E2_HIGHMEM_8" // "E2_HIGHMEM_16" // "E2_HIGHCPU_2" // "E2_HIGHCPU_4" // "E2_HIGHCPU_8" // "E2_HIGHCPU_16" // "E2_HIGHCPU_32" // "N2_STANDARD_2" // "N2_STANDARD_4" // "N2_STANDARD_8" // "N2_STANDARD_16" // "N2_STANDARD_32" // "N2_STANDARD_48" // "N2_STANDARD_64" // "N2_STANDARD_80" // "N2_STANDARD_96" // "N2_STANDARD_128" // "N2_HIGHMEM_2" // "N2_HIGHMEM_4" // "N2_HIGHMEM_8" // "N2_HIGHMEM_16" // "N2_HIGHMEM_32" // "N2_HIGHMEM_48" // "N2_HIGHMEM_64" // "N2_HIGHMEM_80" // "N2_HIGHMEM_96" // "N2_HIGHMEM_128" // "N2_HIGHCPU_2" // "N2_HIGHCPU_4" // "N2_HIGHCPU_8" // "N2_HIGHCPU_16" // "N2_HIGHCPU_32" // "N2_HIGHCPU_48" // "N2_HIGHCPU_64" // "N2_HIGHCPU_80" // "N2_HIGHCPU_96" // "N2D_STANDARD_2" // "N2D_STANDARD_4" // "N2D_STANDARD_8" // "N2D_STANDARD_16" // "N2D_STANDARD_32" // "N2D_STANDARD_48" // "N2D_STANDARD_64" // "N2D_STANDARD_80" // "N2D_STANDARD_96" // "N2D_STANDARD_128" // "N2D_STANDARD_224" // "N2D_HIGHMEM_2" // "N2D_HIGHMEM_4" // "N2D_HIGHMEM_8" // "N2D_HIGHMEM_16" // "N2D_HIGHMEM_32" // "N2D_HIGHMEM_48" // "N2D_HIGHMEM_64" // "N2D_HIGHMEM_80" // "N2D_HIGHMEM_96" // "N2D_HIGHCPU_2" // "N2D_HIGHCPU_4" // "N2D_HIGHCPU_8" // "N2D_HIGHCPU_16" // "N2D_HIGHCPU_32" // "N2D_HIGHCPU_48" // "N2D_HIGHCPU_64" // "N2D_HIGHCPU_80" // "N2D_HIGHCPU_96" // "N2D_HIGHCPU_128" // "N2D_HIGHCPU_224" // "C2_STANDARD_4" // "C2_STANDARD_8" // "C2_STANDARD_16" // "C2_STANDARD_30" // "C2_STANDARD_60" // "C2D_STANDARD_2" // "C2D_STANDARD_4" // "C2D_STANDARD_8" // "C2D_STANDARD_16" // "C2D_STANDARD_32" // "C2D_STANDARD_56" // "C2D_STANDARD_112" // "C2D_HIGHCPU_2" // "C2D_HIGHCPU_4" // "C2D_HIGHCPU_8" // "C2D_HIGHCPU_16" // "C2D_HIGHCPU_32" // "C2D_HIGHCPU_56" // "C2D_HIGHCPU_112" // "C2D_HIGHMEM_2" // "C2D_HIGHMEM_4" // "C2D_HIGHMEM_8" // "C2D_HIGHMEM_16" // "C2D_HIGHMEM_32" // "C2D_HIGHMEM_56" // "C2D_HIGHMEM_112" // "G2_STANDARD_4" // "G2_STANDARD_8" // "G2_STANDARD_12" // "G2_STANDARD_16" // "G2_STANDARD_24" // "G2_STANDARD_32" // "G2_STANDARD_48" // "G2_STANDARD_96" // "C3_STANDARD_4" // "C3_STANDARD_8" // "C3_STANDARD_22" // "C3_STANDARD_44" // "C3_STANDARD_88" // "C3_STANDARD_176" // "C3_HIGHCPU_4" // "C3_HIGHCPU_8" // "C3_HIGHCPU_22" // "C3_HIGHCPU_44" // "C3_HIGHCPU_88" // "C3_HIGHCPU_176" // "C3_HIGHMEM_4" // "C3_HIGHMEM_8" // "C3_HIGHMEM_22" // "C3_HIGHMEM_44" // "C3_HIGHMEM_88" // "C3_HIGHMEM_176" MachineSpec string `json:"machineSpec,omitempty"` // Memories: Required. VM memory in gb. Memories float64 `json:"memories,omitempty"` // RamType: Required. Type of ram. // // Possible values: // "UNKNOWN_RAM_TYPE" // "A2" // "A3" // "C2" - COMPUTE_OPTIMIZED // "C2D" // "CUSTOM" // "E2" // "G2" // "C3" // "M2" - MEMORY_OPTIMIZED_UPGRADE_PREMIUM // "M1" - MEMORY_OPTIMIZED // "N1" // "N2_CUSTOM" // "N2" // "N2D" RamType string `json:"ramType,omitempty"` // TrackingLabels: Billing tracking labels. They do not contain any user // data but only the labels set by Vertex Core Infra itself. Tracking // labels' keys are defined with special format: goog-[\p{Ll}\p{N}]+ // E.g. "key": "goog-k8s-cluster-name","value": "us-east1-b4rk" TrackingLabels map[string]string `json:"trackingLabels,omitempty"` // ForceSendFields is a list of field names (e.g. "GibSec") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "GibSec") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*RamMetric) MarshalJSON ¶ added in v0.167.0
func (*RamMetric) UnmarshalJSON ¶ added in v0.167.0
type Sentence ¶
type Sentence struct { // Sentiment: For calls to AnalyzeSentiment or if // AnnotateTextRequest.Features.extract_document_sentiment is set to // true, this field will contain the sentiment for the sentence. Sentiment *Sentiment `json:"sentiment,omitempty"` // Text: The sentence text. Text *TextSpan `json:"text,omitempty"` // ForceSendFields is a list of field names (e.g. "Sentiment") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Sentiment") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Sentence: Represents a sentence in the input document.
func (*Sentence) MarshalJSON ¶
type Sentiment ¶
type Sentiment struct { // Magnitude: A non-negative number in the [0, +inf) range, which // represents the absolute magnitude of sentiment regardless of score // (positive or negative). Magnitude float64 `json:"magnitude,omitempty"` // Score: Sentiment score between -1.0 (negative sentiment) and 1.0 // (positive sentiment). Score float64 `json:"score,omitempty"` // ForceSendFields is a list of field names (e.g. "Magnitude") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Magnitude") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Sentiment: Represents the feeling associated with the entire text or entities in the text. Next ID: 6
func (*Sentiment) MarshalJSON ¶
func (*Sentiment) UnmarshalJSON ¶
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment Documents *DocumentsService // contains filtered or unexported fields }
func New
deprecated
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func NewService ¶ added in v0.3.0
NewService creates a new Service.
type Status ¶
type Status struct { // Code: The status code, which should be an enum value of // google.rpc.Code. Code int64 `json:"code,omitempty"` // Details: A list of messages that carry the error details. There is a // common set of message types for APIs to use. Details []googleapi.RawMessage `json:"details,omitempty"` // Message: A developer-facing error message, which should be in // English. Any user-facing error message should be localized and sent // in the google.rpc.Status.details field, or localized by the client. Message string `json:"message,omitempty"` // ForceSendFields is a list of field names (e.g. "Code") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Code") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).
func (*Status) MarshalJSON ¶
type TextSpan ¶
type TextSpan struct { // BeginOffset: The API calculates the beginning offset of the content // in the original document according to the EncodingType specified in // the API request. BeginOffset int64 `json:"beginOffset,omitempty"` // Content: The content of the text span, which is a substring of the // document. Content string `json:"content,omitempty"` // ForceSendFields is a list of field names (e.g. "BeginOffset") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BeginOffset") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
TextSpan: Represents a text span in the input document.
func (*TextSpan) MarshalJSON ¶
type Token ¶
type Token struct { // DependencyEdge: Dependency tree parse for this token. DependencyEdge *DependencyEdge `json:"dependencyEdge,omitempty"` // Lemma: Lemma (https://en.wikipedia.org/wiki/Lemma_%28morphology%29) // of the token. Lemma string `json:"lemma,omitempty"` // PartOfSpeech: Parts of speech tag for this token. PartOfSpeech *PartOfSpeech `json:"partOfSpeech,omitempty"` // Text: The token text. Text *TextSpan `json:"text,omitempty"` // ForceSendFields is a list of field names (e.g. "DependencyEdge") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DependencyEdge") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
Token: Represents the smallest syntactic building block of the text.
func (*Token) MarshalJSON ¶
type TpuMetric ¶ added in v0.167.0
type TpuMetric struct { // TpuSec: Required. Seconds of TPU usage, e.g. 3600. TpuSec int64 `json:"tpuSec,omitempty,string"` // TpuType: Required. Type of TPU, e.g. TPU_V2, TPU_V3_POD. // // Possible values: // "UNKNOWN_TPU_TYPE" // "TPU_V2_POD" // "TPU_V2" // "TPU_V3_POD" // "TPU_V3" // "TPU_V5_LITEPOD" TpuType string `json:"tpuType,omitempty"` // ForceSendFields is a list of field names (e.g. "TpuSec") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "TpuSec") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*TpuMetric) MarshalJSON ¶ added in v0.167.0
type XPSArrayStats ¶ added in v0.167.0
type XPSArrayStats struct { CommonStats *XPSCommonStats `json:"commonStats,omitempty"` // MemberStats: Stats of all the values of all arrays, as if they were a // single long series of data. The type depends on the element type of // the array. MemberStats *XPSDataStats `json:"memberStats,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonStats") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CommonStats") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSArrayStats: The data statistics of a series of ARRAY values.
func (*XPSArrayStats) MarshalJSON ¶ added in v0.167.0
func (s *XPSArrayStats) MarshalJSON() ([]byte, error)
type XPSBatchPredictResponse ¶ added in v0.167.0
type XPSBatchPredictResponse struct { // ExampleSet: Examples for batch prediction result. Under full API // implementation, results are stored in shared RecordIO of // AnnotatedExample protobufs, the annotations field of which is // populated by XPS backend. ExampleSet *XPSExampleSet `json:"exampleSet,omitempty"` // ForceSendFields is a list of field names (e.g. "ExampleSet") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ExampleSet") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*XPSBatchPredictResponse) MarshalJSON ¶ added in v0.167.0
func (s *XPSBatchPredictResponse) MarshalJSON() ([]byte, error)
type XPSBoundingBoxMetricsEntry ¶ added in v0.167.0
type XPSBoundingBoxMetricsEntry struct { // ConfidenceMetricsEntries: Metrics for each label-match // confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. ConfidenceMetricsEntries []*XPSBoundingBoxMetricsEntryConfidenceMetricsEntry `json:"confidenceMetricsEntries,omitempty"` // IouThreshold: The intersection-over-union threshold value used to // compute this metrics entry. IouThreshold float64 `json:"iouThreshold,omitempty"` // MeanAveragePrecision: The mean average precision. MeanAveragePrecision float64 `json:"meanAveragePrecision,omitempty"` // ForceSendFields is a list of field names (e.g. // "ConfidenceMetricsEntries") to unconditionally include in API // requests. By default, fields with empty or default values are omitted // from API requests. However, any non-pointer, non-interface field // appearing in ForceSendFields will be sent to the server regardless of // whether the field is empty or not. This may be used to include empty // fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ConfidenceMetricsEntries") // to include in API requests with the JSON null value. By default, // fields with empty values are omitted from API requests. However, any // field with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSBoundingBoxMetricsEntry: Bounding box matching model metrics for a single intersection-over-union threshold and multiple label match confidence thresholds.
func (*XPSBoundingBoxMetricsEntry) MarshalJSON ¶ added in v0.167.0
func (s *XPSBoundingBoxMetricsEntry) MarshalJSON() ([]byte, error)
func (*XPSBoundingBoxMetricsEntry) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSBoundingBoxMetricsEntry) UnmarshalJSON(data []byte) error
type XPSBoundingBoxMetricsEntryConfidenceMetricsEntry ¶ added in v0.167.0
type XPSBoundingBoxMetricsEntryConfidenceMetricsEntry struct { // ConfidenceThreshold: The confidence threshold value used to compute // the metrics. ConfidenceThreshold float64 `json:"confidenceThreshold,omitempty"` // F1Score: The harmonic mean of recall and precision. F1Score float64 `json:"f1Score,omitempty"` // Precision: Precision for the given confidence threshold. Precision float64 `json:"precision,omitempty"` // Recall: Recall for the given confidence threshold. Recall float64 `json:"recall,omitempty"` // ForceSendFields is a list of field names (e.g. "ConfidenceThreshold") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ConfidenceThreshold") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSBoundingBoxMetricsEntryConfidenceMetricsEntry: Metrics for a single confidence threshold.
func (*XPSBoundingBoxMetricsEntryConfidenceMetricsEntry) MarshalJSON ¶ added in v0.167.0
func (s *XPSBoundingBoxMetricsEntryConfidenceMetricsEntry) MarshalJSON() ([]byte, error)
func (*XPSBoundingBoxMetricsEntryConfidenceMetricsEntry) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSBoundingBoxMetricsEntryConfidenceMetricsEntry) UnmarshalJSON(data []byte) error
type XPSCategoryStats ¶ added in v0.167.0
type XPSCategoryStats struct { CommonStats *XPSCommonStats `json:"commonStats,omitempty"` // TopCategoryStats: The statistics of the top 20 CATEGORY values, // ordered by CategoryStats.SingleCategoryStats.count. TopCategoryStats []*XPSCategoryStatsSingleCategoryStats `json:"topCategoryStats,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonStats") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CommonStats") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSCategoryStats: The data statistics of a series of CATEGORY values.
func (*XPSCategoryStats) MarshalJSON ¶ added in v0.167.0
func (s *XPSCategoryStats) MarshalJSON() ([]byte, error)
type XPSCategoryStatsSingleCategoryStats ¶ added in v0.167.0
type XPSCategoryStatsSingleCategoryStats struct { // Count: The number of occurrences of this value in the series. Count int64 `json:"count,omitempty,string"` // Value: The CATEGORY value. Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "Count") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Count") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSCategoryStatsSingleCategoryStats: The statistics of a single CATEGORY value.
func (*XPSCategoryStatsSingleCategoryStats) MarshalJSON ¶ added in v0.167.0
func (s *XPSCategoryStatsSingleCategoryStats) MarshalJSON() ([]byte, error)
type XPSClassificationEvaluationMetrics ¶ added in v0.167.0
type XPSClassificationEvaluationMetrics struct { // AuPrc: The Area under precision recall curve metric. AuPrc float64 `json:"auPrc,omitempty"` // AuRoc: The Area Under Receiver Operating Characteristic curve metric. // Micro-averaged for the overall evaluation. AuRoc float64 `json:"auRoc,omitempty"` // BaseAuPrc: The Area under precision recall curve metric based on // priors. BaseAuPrc float64 `json:"baseAuPrc,omitempty"` // ConfidenceMetricsEntries: Metrics that have confidence thresholds. // Precision-recall curve can be derived from it. ConfidenceMetricsEntries []*XPSConfidenceMetricsEntry `json:"confidenceMetricsEntries,omitempty"` // ConfusionMatrix: Confusion matrix of the evaluation. Only set for // MULTICLASS classification problems where number of annotation specs // is no more than 10. Only set for model level evaluation, not for // evaluation per label. ConfusionMatrix *XPSConfusionMatrix `json:"confusionMatrix,omitempty"` // EvaluatedExamplesCount: The number of examples used for model // evaluation. EvaluatedExamplesCount int64 `json:"evaluatedExamplesCount,omitempty"` // LogLoss: The Log Loss metric. LogLoss float64 `json:"logLoss,omitempty"` // ForceSendFields is a list of field names (e.g. "AuPrc") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AuPrc") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSClassificationEvaluationMetrics: Model evaluation metrics for classification problems. It can be used for image and video classification. Next tag: 9.
func (*XPSClassificationEvaluationMetrics) MarshalJSON ¶ added in v0.167.0
func (s *XPSClassificationEvaluationMetrics) MarshalJSON() ([]byte, error)
func (*XPSClassificationEvaluationMetrics) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSClassificationEvaluationMetrics) UnmarshalJSON(data []byte) error
type XPSColorMap ¶ added in v0.167.0
type XPSColorMap struct { // AnnotationSpecIdToken: Should be used during training. AnnotationSpecIdToken string `json:"annotationSpecIdToken,omitempty"` // Color: This type is deprecated in favor of the IntColor below. This // is because google.type.Color represent color has a float which // semantically does not reflect discrete classes/categories concept. // Moreover, to handle it well we need to have some tolerance when // converting to a discretized color. As such, the recommendation is to // have API surface still use google.type.Color while internally // IntColor is used. Color *Color `json:"color,omitempty"` // DisplayName: Should be used during preprocessing. DisplayName string `json:"displayName,omitempty"` IntColor *XPSColorMapIntColor `json:"intColor,omitempty"` // ForceSendFields is a list of field names (e.g. // "AnnotationSpecIdToken") to unconditionally include in API requests. // By default, fields with empty or default values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AnnotationSpecIdToken") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSColorMap: Map from color to display name. Will only be used by Image Segmentation for uCAIP.
func (*XPSColorMap) MarshalJSON ¶ added in v0.167.0
func (s *XPSColorMap) MarshalJSON() ([]byte, error)
type XPSColorMapIntColor ¶ added in v0.167.0
type XPSColorMapIntColor struct { // Blue: The value should be in range of [0, 255]. Blue int64 `json:"blue,omitempty"` // Green: The value should be in range of [0, 255]. Green int64 `json:"green,omitempty"` // Red: The value should be in range of [0, 255]. Red int64 `json:"red,omitempty"` // ForceSendFields is a list of field names (e.g. "Blue") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Blue") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSColorMapIntColor: RGB color and each channel is represented by an integer.
func (*XPSColorMapIntColor) MarshalJSON ¶ added in v0.167.0
func (s *XPSColorMapIntColor) MarshalJSON() ([]byte, error)
type XPSColumnSpec ¶ added in v0.167.0
type XPSColumnSpec struct { // ColumnId: The unique id of the column. When Preprocess, the Tables BE // will popuate the order id of the column, which reflects the order of // the column inside the table, i.e. 0 means the first column in the // table, N-1 means the last column. AutoML BE will persist this order // id in Spanner and set the order id here when calling // RefreshTablesStats and Train. Note: it's different than the // column_spec_id that is generated in AutoML BE. ColumnId int64 `json:"columnId,omitempty"` // DataStats: The data stats of the column. It's outputed in // RefreshTablesStats and a required input for Train. DataStats *XPSDataStats `json:"dataStats,omitempty"` // DataType: The data type of the column. It's outputed in Preprocess // rpc and a required input for RefreshTablesStats and Train. DataType *XPSDataType `json:"dataType,omitempty"` // DisplayName: The display name of the column. It's outputed in // Preprocess and a required input for RefreshTablesStats and Train. DisplayName string `json:"displayName,omitempty"` ForecastingMetadata *XPSColumnSpecForecastingMetadata `json:"forecastingMetadata,omitempty"` // required input in Train. TopCorrelatedColumns []*XPSColumnSpecCorrelatedColumn `json:"topCorrelatedColumns,omitempty"` // ForceSendFields is a list of field names (e.g. "ColumnId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ColumnId") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*XPSColumnSpec) MarshalJSON ¶ added in v0.167.0
func (s *XPSColumnSpec) MarshalJSON() ([]byte, error)
type XPSColumnSpecCorrelatedColumn ¶ added in v0.167.0
type XPSColumnSpecCorrelatedColumn struct { // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSColumnSpecCorrelatedColumn: Identifies a table's column, and its correlation with the column this ColumnSpec describes.
func (*XPSColumnSpecCorrelatedColumn) MarshalJSON ¶ added in v0.167.0
func (s *XPSColumnSpecCorrelatedColumn) MarshalJSON() ([]byte, error)
type XPSColumnSpecForecastingMetadata ¶ added in v0.167.0
type XPSColumnSpecForecastingMetadata struct { // ColumnType: The type of the column for FORECASTING model training // purposes. // // Possible values: // "COLUMN_TYPE_UNSPECIFIED" - An un-set value of this enum. // "KEY" - Key columns are used to identify timeseries. // "KEY_METADATA" - This column contains information describing static // properties of the entities identified by the key column(s) (e.g. // city's ZIP code). // "TIME_SERIES_AVAILABLE_PAST_ONLY" - This column contains // information for the given entity, at any time poinrt, they are only // available in the time series before. // "TIME_SERIES_AVAILABLE_PAST_AND_FUTURE" - This column contains // information for the given entity is known both for the past and the // sufficiently far future. ColumnType string `json:"columnType,omitempty"` // ForceSendFields is a list of field names (e.g. "ColumnType") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ColumnType") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSColumnSpecForecastingMetadata: ====================================================================== ===== # The fields below are used exclusively for Forecasting.
func (*XPSColumnSpecForecastingMetadata) MarshalJSON ¶ added in v0.167.0
func (s *XPSColumnSpecForecastingMetadata) MarshalJSON() ([]byte, error)
type XPSCommonStats ¶ added in v0.167.0
type XPSCommonStats struct { DistinctValueCount int64 `json:"distinctValueCount,omitempty,string"` NullValueCount int64 `json:"nullValueCount,omitempty,string"` ValidValueCount int64 `json:"validValueCount,omitempty,string"` // ForceSendFields is a list of field names (e.g. "DistinctValueCount") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DistinctValueCount") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSCommonStats: Common statistics for a column with a specified data type.
func (*XPSCommonStats) MarshalJSON ¶ added in v0.167.0
func (s *XPSCommonStats) MarshalJSON() ([]byte, error)
type XPSConfidenceMetricsEntry ¶ added in v0.167.0
type XPSConfidenceMetricsEntry struct { // ConfidenceThreshold: Metrics are computed with an assumption that the // model never return predictions with score lower than this value. ConfidenceThreshold float64 `json:"confidenceThreshold,omitempty"` // F1Score: The harmonic mean of recall and precision. F1Score float64 `json:"f1Score,omitempty"` // F1ScoreAt1: The harmonic mean of recall_at1 and precision_at1. F1ScoreAt1 float64 `json:"f1ScoreAt1,omitempty"` // FalseNegativeCount: The number of ground truth labels that are not // matched by a model created label. FalseNegativeCount int64 `json:"falseNegativeCount,omitempty,string"` // FalsePositiveCount: The number of model created labels that do not // match a ground truth label. FalsePositiveCount int64 `json:"falsePositiveCount,omitempty,string"` // FalsePositiveRate: False Positive Rate for the given confidence // threshold. FalsePositiveRate float64 `json:"falsePositiveRate,omitempty"` // FalsePositiveRateAt1: The False Positive Rate when only considering // the label that has the highest prediction score and not below the // confidence threshold for each example. FalsePositiveRateAt1 float64 `json:"falsePositiveRateAt1,omitempty"` // PositionThreshold: Metrics are computed with an assumption that the // model always returns at most this many predictions (ordered by their // score, descendingly), but they all still need to meet the // confidence_threshold. PositionThreshold int64 `json:"positionThreshold,omitempty"` // Precision: Precision for the given confidence threshold. Precision float64 `json:"precision,omitempty"` // PrecisionAt1: The precision when only considering the label that has // the highest prediction score and not below the confidence threshold // for each example. PrecisionAt1 float64 `json:"precisionAt1,omitempty"` // Recall: Recall (true positive rate) for the given confidence // threshold. Recall float64 `json:"recall,omitempty"` // RecallAt1: The recall (true positive rate) when only considering the // label that has the highest prediction score and not below the // confidence threshold for each example. RecallAt1 float64 `json:"recallAt1,omitempty"` // TrueNegativeCount: The number of labels that were not created by the // model, but if they would, they would not match a ground truth label. TrueNegativeCount int64 `json:"trueNegativeCount,omitempty,string"` // TruePositiveCount: The number of model created labels that match a // ground truth label. TruePositiveCount int64 `json:"truePositiveCount,omitempty,string"` // ForceSendFields is a list of field names (e.g. "ConfidenceThreshold") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ConfidenceThreshold") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSConfidenceMetricsEntry: ConfidenceMetricsEntry includes generic precision, recall, f1 score etc. Next tag: 16.
func (*XPSConfidenceMetricsEntry) MarshalJSON ¶ added in v0.167.0
func (s *XPSConfidenceMetricsEntry) MarshalJSON() ([]byte, error)
func (*XPSConfidenceMetricsEntry) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSConfidenceMetricsEntry) UnmarshalJSON(data []byte) error
type XPSConfusionMatrix ¶ added in v0.167.0
type XPSConfusionMatrix struct { // AnnotationSpecIdToken: For the following three repeated fields, only // one is intended to be set. annotation_spec_id_token is preferable to // be set. ID tokens of the annotation specs used in the confusion // matrix. AnnotationSpecIdToken []string `json:"annotationSpecIdToken,omitempty"` // Category: Category (mainly for segmentation). Set only for image // segmentation models. Note: uCAIP Image Segmentation should use // annotation_spec_id_token. Category []int64 `json:"category,omitempty"` // Row: Rows in the confusion matrix. The number of rows is equal to the // size of `annotation_spec_id_token`. `row[i].value[j]` is the number // of examples that have ground truth of the // `annotation_spec_id_token[i]` and are predicted as // `annotation_spec_id_token[j]` by the model being evaluated. Row []*XPSConfusionMatrixRow `json:"row,omitempty"` // SentimentLabel: Sentiment labels used in the confusion matrix. Set // only for text sentiment models. For AutoML Text Revamp, use // `annotation_spec_id_token` instead and leave this field empty. SentimentLabel []int64 `json:"sentimentLabel,omitempty"` // ForceSendFields is a list of field names (e.g. // "AnnotationSpecIdToken") to unconditionally include in API requests. // By default, fields with empty or default values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AnnotationSpecIdToken") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSConfusionMatrix: Confusion matrix of the model running the classification.
func (*XPSConfusionMatrix) MarshalJSON ¶ added in v0.167.0
func (s *XPSConfusionMatrix) MarshalJSON() ([]byte, error)
type XPSConfusionMatrixRow ¶ added in v0.167.0
type XPSConfusionMatrixRow struct { // Count: Same as above except intended to represent other counts (for // e.g. for segmentation this is pixel count). NOTE(params): Only // example_count or count is set (oneoff does not support repeated // fields unless they are embedded inside another message). Count googleapi.Int64s `json:"count,omitempty"` // ExampleCount: Value of the specific cell in the confusion matrix. The // number of values each row has (i.e. the length of the row) is equal // to the length of the annotation_spec_id_token field. ExampleCount []int64 `json:"exampleCount,omitempty"` // ForceSendFields is a list of field names (e.g. "Count") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Count") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSConfusionMatrixRow: A row in the confusion matrix.
func (*XPSConfusionMatrixRow) MarshalJSON ¶ added in v0.167.0
func (s *XPSConfusionMatrixRow) MarshalJSON() ([]byte, error)
type XPSCoreMlFormat ¶ added in v0.167.0
type XPSCoreMlFormat struct { }
XPSCoreMlFormat: A model format used for iOS mobile devices.
type XPSCorrelationStats ¶ added in v0.167.0
type XPSCorrelationStats struct { // CramersV: The correlation value using the Cramer's V measure. CramersV float64 `json:"cramersV,omitempty"` // ForceSendFields is a list of field names (e.g. "CramersV") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CramersV") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSCorrelationStats: A correlation statistics between two series of DataType values. The series may have differing DataType-s, but within a single series the DataType must be the same.
func (*XPSCorrelationStats) MarshalJSON ¶ added in v0.167.0
func (s *XPSCorrelationStats) MarshalJSON() ([]byte, error)
func (*XPSCorrelationStats) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSCorrelationStats) UnmarshalJSON(data []byte) error
type XPSDataErrors ¶ added in v0.167.0
type XPSDataErrors struct { // Count: Number of records having errors associated with the enum. Count int64 `json:"count,omitempty"` // ErrorType: Type of the error. // // Possible values: // "ERROR_TYPE_UNSPECIFIED" - Not specified. // "UNSUPPORTED_AUDIO_FORMAT" - Audio format not in the formats by // cloud-speech AutoML. Currently only wav and flac file formats are // supported. // "FILE_EXTENSION_MISMATCH_WITH_AUDIO_FORMAT" - File format differnt // from what is specified in the file name extension. // "FILE_TOO_LARGE" - File too large. Maximum allowed size is 50 MB. // "MISSING_TRANSCRIPTION" - Transcript is missing. ErrorType string `json:"errorType,omitempty"` // ForceSendFields is a list of field names (e.g. "Count") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Count") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSDataErrors: Different types of errors and the stats associatesd with each error.
func (*XPSDataErrors) MarshalJSON ¶ added in v0.167.0
func (s *XPSDataErrors) MarshalJSON() ([]byte, error)
type XPSDataStats ¶ added in v0.167.0
type XPSDataStats struct { // ArrayStats: The statistics for ARRAY DataType. ArrayStats *XPSArrayStats `json:"arrayStats,omitempty"` // CategoryStats: The statistics for CATEGORY DataType. CategoryStats *XPSCategoryStats `json:"categoryStats,omitempty"` // DistinctValueCount: The number of distinct values. DistinctValueCount int64 `json:"distinctValueCount,omitempty,string"` // Float64Stats: The statistics for FLOAT64 DataType. Float64Stats *XPSFloat64Stats `json:"float64Stats,omitempty"` // NullValueCount: The number of values that are null. NullValueCount int64 `json:"nullValueCount,omitempty,string"` // StringStats: The statistics for STRING DataType. StringStats *XPSStringStats `json:"stringStats,omitempty"` // StructStats: The statistics for STRUCT DataType. StructStats *XPSStructStats `json:"structStats,omitempty"` // TimestampStats: The statistics for TIMESTAMP DataType. TimestampStats *XPSTimestampStats `json:"timestampStats,omitempty"` // ValidValueCount: The number of values that are valid. ValidValueCount int64 `json:"validValueCount,omitempty,string"` // ForceSendFields is a list of field names (e.g. "ArrayStats") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ArrayStats") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSDataStats: The data statistics of a series of values that share the same DataType.
func (*XPSDataStats) MarshalJSON ¶ added in v0.167.0
func (s *XPSDataStats) MarshalJSON() ([]byte, error)
type XPSDataType ¶ added in v0.167.0
type XPSDataType struct { // CompatibleDataTypes: The highly compatible data types to this data // type. CompatibleDataTypes []*XPSDataType `json:"compatibleDataTypes,omitempty"` // ListElementType: If type_code == ARRAY, then `list_element_type` is // the type of the elements. ListElementType *XPSDataType `json:"listElementType,omitempty"` // Nullable: If true, this DataType can also be `null`. Nullable bool `json:"nullable,omitempty"` // StructType: If type_code == STRUCT, then `struct_type` provides type // information for the struct's fields. StructType *XPSStructType `json:"structType,omitempty"` // TimeFormat: If type_code == TIMESTAMP then `time_format` provides the // format in which that time field is expressed. The time_format must be // written in `strftime` syntax. If time_format is not set, then the // default format as described on the field is used. TimeFormat string `json:"timeFormat,omitempty"` // TypeCode: Required. The TypeCode for this type. // // Possible values: // "TYPE_CODE_UNSPECIFIED" - Not specified. Should not be used. // "FLOAT64" - Encoded as `number`, or the strings "NaN", // "Infinity", or "-Infinity". // "TIMESTAMP" - Must be between 0AD and 9999AD. Encoded as `string` // according to time_format, or, if that format is not set, then in RFC // 3339 `date-time` format, where `time-offset` = "Z" (e.g. // 1985-04-12T23:20:50.52Z). // "STRING" - Encoded as `string`. // "ARRAY" - Encoded as `list`, where the list elements are // represented according to list_element_type. // "STRUCT" - Encoded as `struct`, where field values are represented // according to struct_type. // "CATEGORY" - Values of this type are not further understood by // AutoML, e.g. AutoML is unable to tell the order of values (as it // could with FLOAT64), or is unable to say if one value contains // another (as it could with STRING). Encoded as `string` (bytes should // be base64-encoded, as described in RFC 4648, section 4). TypeCode string `json:"typeCode,omitempty"` // ForceSendFields is a list of field names (e.g. "CompatibleDataTypes") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CompatibleDataTypes") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSDataType: Indicated the type of data that can be stored in a structured data entity (e.g. a table).
func (*XPSDataType) MarshalJSON ¶ added in v0.167.0
func (s *XPSDataType) MarshalJSON() ([]byte, error)
type XPSDockerFormat ¶ added in v0.167.0
type XPSDockerFormat struct { // CpuArchitecture: Optional. Additional cpu information describing the // requirements for the to be exported model files. // // Possible values: // "CPU_ARCHITECTURE_UNSPECIFIED" // "CPU_ARCHITECTURE_X86_64" CpuArchitecture string `json:"cpuArchitecture,omitempty"` // GpuArchitecture: Optional. Additional gpu information describing the // requirements for the to be exported model files. // // Possible values: // "GPU_ARCHITECTURE_UNSPECIFIED" // "GPU_ARCHITECTURE_NVIDIA" GpuArchitecture string `json:"gpuArchitecture,omitempty"` // ForceSendFields is a list of field names (e.g. "CpuArchitecture") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CpuArchitecture") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSDockerFormat: A model format used for Docker containers. Use the params field to customize the container. The container is verified to work correctly on ubuntu 16.04 operating system.
func (*XPSDockerFormat) MarshalJSON ¶ added in v0.167.0
func (s *XPSDockerFormat) MarshalJSON() ([]byte, error)
type XPSEdgeTpuTfLiteFormat ¶ added in v0.167.0
type XPSEdgeTpuTfLiteFormat struct { }
XPSEdgeTpuTfLiteFormat: A model format used for Edge TPU (https://cloud.google.com/edge-tpu/) devices.
type XPSEvaluationMetrics ¶ added in v0.167.0
type XPSEvaluationMetrics struct { // AnnotationSpecIdToken: The annotation_spec for which this evaluation // metrics instance had been created. Empty iff this is an overall model // evaluation (like Tables evaluation metrics), i.e. aggregated across // all labels. The value comes from the input annotations in // AnnotatedExample. For MVP product or for text sentiment models where // annotation_spec_id_token is not available, set label instead. AnnotationSpecIdToken string `json:"annotationSpecIdToken,omitempty"` // Category: The integer category label for which this evaluation metric // instance had been created. Valid categories are 0 or higher. Overall // model evaluation should set this to negative values (rather than // implicit zero). Only used for Image Segmentation (prefer to set // annotation_spec_id_token instead). Note: uCAIP Image Segmentation // should use annotation_spec_id_token. Category int64 `json:"category,omitempty"` // EvaluatedExampleCount: The number of examples used to create this // evaluation metrics instance. EvaluatedExampleCount int64 `json:"evaluatedExampleCount,omitempty"` ImageClassificationEvalMetrics *XPSClassificationEvaluationMetrics `json:"imageClassificationEvalMetrics,omitempty"` ImageObjectDetectionEvalMetrics *XPSImageObjectDetectionEvaluationMetrics `json:"imageObjectDetectionEvalMetrics,omitempty"` ImageSegmentationEvalMetrics *XPSImageSegmentationEvaluationMetrics `json:"imageSegmentationEvalMetrics,omitempty"` // Label: The label for which this evaluation metrics instance had been // created. Empty iff this is an overall model evaluation (like Tables // evaluation metrics), i.e. aggregated across all labels. The label // maps to AnnotationSpec.display_name in Public API protos. Only used // by MVP implementation and text sentiment FULL implementation. Label string `json:"label,omitempty"` RegressionEvalMetrics *XPSRegressionEvaluationMetrics `json:"regressionEvalMetrics,omitempty"` TablesClassificationEvalMetrics *XPSClassificationEvaluationMetrics `json:"tablesClassificationEvalMetrics,omitempty"` TablesEvalMetrics *XPSTablesEvaluationMetrics `json:"tablesEvalMetrics,omitempty"` TextClassificationEvalMetrics *XPSClassificationEvaluationMetrics `json:"textClassificationEvalMetrics,omitempty"` TextExtractionEvalMetrics *XPSTextExtractionEvaluationMetrics `json:"textExtractionEvalMetrics,omitempty"` TextSentimentEvalMetrics *XPSTextSentimentEvaluationMetrics `json:"textSentimentEvalMetrics,omitempty"` TranslationEvalMetrics *XPSTranslationEvaluationMetrics `json:"translationEvalMetrics,omitempty"` VideoActionRecognitionEvalMetrics *XPSVideoActionRecognitionEvaluationMetrics `json:"videoActionRecognitionEvalMetrics,omitempty"` VideoClassificationEvalMetrics *XPSClassificationEvaluationMetrics `json:"videoClassificationEvalMetrics,omitempty"` VideoObjectTrackingEvalMetrics *XPSVideoObjectTrackingEvaluationMetrics `json:"videoObjectTrackingEvalMetrics,omitempty"` // ForceSendFields is a list of field names (e.g. // "AnnotationSpecIdToken") to unconditionally include in API requests. // By default, fields with empty or default values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AnnotationSpecIdToken") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSEvaluationMetrics: Contains xPS-specific model evaluation metrics either for a single annotation spec (label), or for the model overall. Next tag: 18.
func (*XPSEvaluationMetrics) MarshalJSON ¶ added in v0.167.0
func (s *XPSEvaluationMetrics) MarshalJSON() ([]byte, error)
type XPSEvaluationMetricsSet ¶ added in v0.167.0
type XPSEvaluationMetricsSet struct { // EvaluationMetrics: Inline EvaluationMetrics - should be relatively // small. For passing large quantities of exhaustive metrics, use // file_spec. EvaluationMetrics []*XPSEvaluationMetrics `json:"evaluationMetrics,omitempty"` // FileSpec: File spec containing evaluation metrics of a model, must // point to RecordIO file(s) of // intelligence.cloud.automl.xps.EvaluationMetrics messages. FileSpec *XPSFileSpec `json:"fileSpec,omitempty"` // NumEvaluationMetrics: Number of the evaluation metrics (usually one // per label plus overall). NumEvaluationMetrics int64 `json:"numEvaluationMetrics,omitempty,string"` // ForceSendFields is a list of field names (e.g. "EvaluationMetrics") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "EvaluationMetrics") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSEvaluationMetricsSet: Specifies location of model evaluation metrics.
func (*XPSEvaluationMetricsSet) MarshalJSON ¶ added in v0.167.0
func (s *XPSEvaluationMetricsSet) MarshalJSON() ([]byte, error)
type XPSExampleSet ¶ added in v0.167.0
type XPSExampleSet struct { // FileSpec: File spec of the examples or input sources. FileSpec *XPSFileSpec `json:"fileSpec,omitempty"` // Fingerprint: Fingerprint of the example set. Fingerprint int64 `json:"fingerprint,omitempty,string"` // NumExamples: Number of examples. NumExamples int64 `json:"numExamples,omitempty,string"` // NumInputSources: Number of input sources. NumInputSources int64 `json:"numInputSources,omitempty,string"` // ForceSendFields is a list of field names (e.g. "FileSpec") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FileSpec") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSExampleSet: Set of examples or input sources.
func (*XPSExampleSet) MarshalJSON ¶ added in v0.167.0
func (s *XPSExampleSet) MarshalJSON() ([]byte, error)
type XPSExportModelOutputConfig ¶ added in v0.167.0
type XPSExportModelOutputConfig struct { CoreMlFormat *XPSCoreMlFormat `json:"coreMlFormat,omitempty"` DockerFormat *XPSDockerFormat `json:"dockerFormat,omitempty"` EdgeTpuTfLiteFormat *XPSEdgeTpuTfLiteFormat `json:"edgeTpuTfLiteFormat,omitempty"` // ExportFirebaseAuxiliaryInfo: For any model and format: If true, will // additionally export FirebaseExportedModelInfo in a firebase.txt file. ExportFirebaseAuxiliaryInfo bool `json:"exportFirebaseAuxiliaryInfo,omitempty"` // OutputGcrUri: The Google Contained Registry (GCR) path the exported // files to be pushed to. This location is set if the exported format is // DOCKDER. OutputGcrUri string `json:"outputGcrUri,omitempty"` // OutputGcsUri: The Google Cloud Storage (GCS) directory where XPS will // output the exported models and related files. Format: // gs://bucket/directory OutputGcsUri string `json:"outputGcsUri,omitempty"` TfJsFormat *XPSTfJsFormat `json:"tfJsFormat,omitempty"` TfLiteFormat *XPSTfLiteFormat `json:"tfLiteFormat,omitempty"` TfSavedModelFormat *XPSTfSavedModelFormat `json:"tfSavedModelFormat,omitempty"` // ForceSendFields is a list of field names (e.g. "CoreMlFormat") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CoreMlFormat") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*XPSExportModelOutputConfig) MarshalJSON ¶ added in v0.167.0
func (s *XPSExportModelOutputConfig) MarshalJSON() ([]byte, error)
type XPSFileSpec ¶ added in v0.167.0
type XPSFileSpec struct { // DirectoryPath: Deprecated. Use file_spec. DirectoryPath string `json:"directoryPath,omitempty"` // Possible values: // "FILE_FORMAT_UNKNOWN" // "FILE_FORMAT_SSTABLE" // "FILE_FORMAT_TRANSLATION_RKV" - Internal format for parallel text // data used by Google Translate. go/rkvtools // "FILE_FORMAT_RECORDIO" // "FILE_FORMAT_RAW_CSV" - Only the lexicographically first file // described by the file_spec contains the header line. // "FILE_FORMAT_RAW_CAPACITOR" FileFormat string `json:"fileFormat,omitempty"` // FileSpec: Single file path, or file pattern of format // "/path/to/file@shard_count". E.g. /cns/cell-d/somewhere/file@2 is // expanded to two files: /cns/cell-d/somewhere/file-00000-of-00002 and // /cns/cell-d/somewhere/file-00001-of-00002. FileSpec string `json:"fileSpec,omitempty"` // SingleFilePath: Deprecated. Use file_spec. SingleFilePath string `json:"singleFilePath,omitempty"` // ForceSendFields is a list of field names (e.g. "DirectoryPath") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DirectoryPath") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSFileSpec: Spec of input and output files, on external file systems (CNS, GCS, etc).
func (*XPSFileSpec) MarshalJSON ¶ added in v0.167.0
func (s *XPSFileSpec) MarshalJSON() ([]byte, error)
type XPSFloat64Stats ¶ added in v0.167.0
type XPSFloat64Stats struct { CommonStats *XPSCommonStats `json:"commonStats,omitempty"` // HistogramBuckets: Histogram buckets of the data series. Sorted by the // min value of the bucket, ascendingly, and the number of the buckets // is dynamically generated. The buckets are non-overlapping and // completely cover whole FLOAT64 range with min of first bucket being // "-Infinity", and max of the last one being "Infinity". HistogramBuckets []*XPSFloat64StatsHistogramBucket `json:"histogramBuckets,omitempty"` // Mean: The mean of the series. Mean float64 `json:"mean,omitempty"` // Quantiles: Ordered from 0 to k k-quantile values of the data series // of n values. The value at index i is, approximately, the i*n/k-th // smallest value in the series; for i = 0 and i = k these are, // respectively, the min and max values. Quantiles []float64 `json:"quantiles,omitempty"` // StandardDeviation: The standard deviation of the series. StandardDeviation float64 `json:"standardDeviation,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonStats") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CommonStats") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSFloat64Stats: The data statistics of a series of FLOAT64 values.
func (*XPSFloat64Stats) MarshalJSON ¶ added in v0.167.0
func (s *XPSFloat64Stats) MarshalJSON() ([]byte, error)
func (*XPSFloat64Stats) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSFloat64Stats) UnmarshalJSON(data []byte) error
type XPSFloat64StatsHistogramBucket ¶ added in v0.167.0
type XPSFloat64StatsHistogramBucket struct { // Count: The number of data values that are in the bucket, i.e. are // between min and max values. Count int64 `json:"count,omitempty,string"` // Max: The maximum value of the bucket, exclusive unless max = // "Infinity", in which case it's inclusive. Max float64 `json:"max,omitempty"` // Min: The minimum value of the bucket, inclusive. Min float64 `json:"min,omitempty"` // ForceSendFields is a list of field names (e.g. "Count") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Count") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSFloat64StatsHistogramBucket: A bucket of a histogram.
func (*XPSFloat64StatsHistogramBucket) MarshalJSON ¶ added in v0.167.0
func (s *XPSFloat64StatsHistogramBucket) MarshalJSON() ([]byte, error)
func (*XPSFloat64StatsHistogramBucket) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSFloat64StatsHistogramBucket) UnmarshalJSON(data []byte) error
type XPSImageClassificationTrainResponse ¶ added in v0.167.0
type XPSImageClassificationTrainResponse struct { // ClassCount: Total number of classes. ClassCount int64 `json:"classCount,omitempty,string"` // ExportModelSpec: Information of downloadable models that are // pre-generated as part of training flow and will be persisted in // AutoMl backend. Populated for AutoMl requests. ExportModelSpec *XPSImageExportModelSpec `json:"exportModelSpec,omitempty"` // ModelArtifactSpec: ## The fields below are only populated under uCAIP // request scope. ModelArtifactSpec *XPSImageModelArtifactSpec `json:"modelArtifactSpec,omitempty"` ModelServingSpec *XPSImageModelServingSpec `json:"modelServingSpec,omitempty"` // StopReason: Stop reason for training job, e.g. // 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED', 'MODEL_EARLY_STOPPED'. // // Possible values: // "TRAIN_STOP_REASON_UNSPECIFIED" // "TRAIN_STOP_REASON_BUDGET_REACHED" // "TRAIN_STOP_REASON_MODEL_CONVERGED" - Model fully converged, can // not be resumbed training. // "TRAIN_STOP_REASON_MODEL_EARLY_STOPPED" - Model early converged, // can be further trained till full convergency. StopReason string `json:"stopReason,omitempty"` // TrainCostInNodeTime: The actual cost to create this model. - For edge // type model, the cost is expressed in node hour. - For cloud type // model,the cost is expressed in compute hour. - Populated for models // created before GA. To be deprecated after GA. TrainCostInNodeTime string `json:"trainCostInNodeTime,omitempty"` // TrainCostNodeSeconds: The actual training cost, expressed in node // seconds. Populated for models trained in node time. TrainCostNodeSeconds int64 `json:"trainCostNodeSeconds,omitempty,string"` // ForceSendFields is a list of field names (e.g. "ClassCount") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ClassCount") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*XPSImageClassificationTrainResponse) MarshalJSON ¶ added in v0.167.0
func (s *XPSImageClassificationTrainResponse) MarshalJSON() ([]byte, error)
type XPSImageExportModelSpec ¶ added in v0.167.0
type XPSImageExportModelSpec struct { // ExportModelOutputConfig: Contains the model format and internal // location of the model files to be exported/downloaded. Use the GCS // bucket name which is provided via TrainRequest.gcs_bucket_name to // store the model files. ExportModelOutputConfig []*XPSExportModelOutputConfig `json:"exportModelOutputConfig,omitempty"` // ForceSendFields is a list of field names (e.g. // "ExportModelOutputConfig") to unconditionally include in API // requests. By default, fields with empty or default values are omitted // from API requests. However, any non-pointer, non-interface field // appearing in ForceSendFields will be sent to the server regardless of // whether the field is empty or not. This may be used to include empty // fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ExportModelOutputConfig") // to include in API requests with the JSON null value. By default, // fields with empty values are omitted from API requests. However, any // field with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSImageExportModelSpec: Information of downloadable models that are pre-generated as part of training flow and will be persisted in AutoMl backend. Upon receiving ExportModel request from user, AutoMl backend can serve the pre-generated models to user if exists (by copying the files from internal path to user provided location), otherwise, AutoMl backend will call xPS ExportModel API to generate the model on the fly with the requesting format.
func (*XPSImageExportModelSpec) MarshalJSON ¶ added in v0.167.0
func (s *XPSImageExportModelSpec) MarshalJSON() ([]byte, error)
type XPSImageModelArtifactSpec ¶ added in v0.167.0
type XPSImageModelArtifactSpec struct { // CheckpointArtifact: The Tensorflow checkpoint files. e.g. Used for // resumable training. CheckpointArtifact *XPSModelArtifactItem `json:"checkpointArtifact,omitempty"` // ExportArtifact: The model binary files in different formats for model // export. ExportArtifact []*XPSModelArtifactItem `json:"exportArtifact,omitempty"` // LabelGcsUri: GCS uri of decoded labels file for model export // 'dict.txt'. LabelGcsUri string `json:"labelGcsUri,omitempty"` // ServingArtifact: The default model binary file used for serving (e.g. // online predict, batch predict) via public Cloud AI Platform API. ServingArtifact *XPSModelArtifactItem `json:"servingArtifact,omitempty"` // TfJsBinaryGcsPrefix: GCS uri prefix of Tensorflow JavaScript binary // files 'groupX-shardXofX.bin' Deprecated. TfJsBinaryGcsPrefix string `json:"tfJsBinaryGcsPrefix,omitempty"` // TfLiteMetadataGcsUri: GCS uri of Tensorflow Lite metadata // 'tflite_metadata.json'. TfLiteMetadataGcsUri string `json:"tfLiteMetadataGcsUri,omitempty"` // ForceSendFields is a list of field names (e.g. "CheckpointArtifact") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CheckpointArtifact") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSImageModelArtifactSpec: Stores the locations and related metadata of the model artifacts. Populated for uCAIP requests only.
func (*XPSImageModelArtifactSpec) MarshalJSON ¶ added in v0.167.0
func (s *XPSImageModelArtifactSpec) MarshalJSON() ([]byte, error)
type XPSImageModelServingSpec ¶ added in v0.167.0
type XPSImageModelServingSpec struct { // ModelThroughputEstimation: Populate under uCAIP request scope. ModelThroughputEstimation []*XPSImageModelServingSpecModelThroughputEstimation `json:"modelThroughputEstimation,omitempty"` // NodeQps: An estimated value of how much traffic a node can serve. // Populated for AutoMl request only. NodeQps float64 `json:"nodeQps,omitempty"` // TfRuntimeVersion: ## The fields below are only populated under uCAIP // request scope. // https://cloud.google.com/ml-engine/docs/runtime-version-list TfRuntimeVersion string `json:"tfRuntimeVersion,omitempty"` // ForceSendFields is a list of field names (e.g. // "ModelThroughputEstimation") to unconditionally include in API // requests. By default, fields with empty or default values are omitted // from API requests. However, any non-pointer, non-interface field // appearing in ForceSendFields will be sent to the server regardless of // whether the field is empty or not. This may be used to include empty // fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. // "ModelThroughputEstimation") to include in API requests with the JSON // null value. By default, fields with empty values are omitted from API // requests. However, any field with an empty value appearing in // NullFields will be sent to the server as null. It is an error if a // field in this list has a non-empty value. This may be used to include // null fields in Patch requests. NullFields []string `json:"-"` }
XPSImageModelServingSpec: Serving specification for image models.
func (*XPSImageModelServingSpec) MarshalJSON ¶ added in v0.167.0
func (s *XPSImageModelServingSpec) MarshalJSON() ([]byte, error)
func (*XPSImageModelServingSpec) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSImageModelServingSpec) UnmarshalJSON(data []byte) error
type XPSImageModelServingSpecModelThroughputEstimation ¶ added in v0.167.0
type XPSImageModelServingSpecModelThroughputEstimation struct { // Possible values: // "UNSPECIFIED" // "NVIDIA_TESLA_K80" - Nvidia Tesla K80 GPU. // "NVIDIA_TESLA_P100" - Nvidia Tesla P100 GPU. // "NVIDIA_TESLA_V100" - Nvidia Tesla V100 GPU. // "NVIDIA_TESLA_P4" - Nvidia Tesla P4 GPU. // "NVIDIA_TESLA_T4" - Nvidia Tesla T4 GPU. // "NVIDIA_TESLA_A100" - Nvidia Tesla A100 GPU. // "NVIDIA_A100_80GB" - Nvidia A100 80GB GPU. // "NVIDIA_L4" - Nvidia L4 GPU. // "NVIDIA_H100_80GB" - Nvidia H100 80Gb GPU. // "TPU_V2" - TPU v2 (JellyFish). // "TPU_V3" - TPU v3 (DragonFish). // "TPU_V4_POD" - TPU_v4 (PufferFish). // "TPU_V5_LITEPOD" - TPU v5 Lite Pods. ComputeEngineAcceleratorType string `json:"computeEngineAcceleratorType,omitempty"` // LatencyInMilliseconds: Estimated latency. LatencyInMilliseconds float64 `json:"latencyInMilliseconds,omitempty"` // NodeQps: The approximate qps a deployed node can serve. NodeQps float64 `json:"nodeQps,omitempty"` // Possible values: // "PARTITION_TYPE_UNSPECIFIED" // "PARTITION_ZERO" - The default partition. // "PARTITION_REDUCED_HOMING" - It has significantly lower replication // than partition-0 and is located in the US only. It also has a larger // model size limit and higher default RAM quota than partition-0. // Customers with batch traffic, US-based traffic, or very large models // should use this partition. Capacity in this partition is // significantly cheaper than partition-0. // "PARTITION_JELLYFISH" - To be used by customers with // Jellyfish-accelerated ops. See go/servomatic-jellyfish for details. // "PARTITION_CPU" - The partition used by regionalized servomatic // cloud regions. // "PARTITION_CUSTOM_STORAGE_CPU" - The partition used for loading // models from custom storage. ServomaticPartitionType string `json:"servomaticPartitionType,omitempty"` // ForceSendFields is a list of field names (e.g. // "ComputeEngineAcceleratorType") to unconditionally include in API // requests. By default, fields with empty or default values are omitted // from API requests. However, any non-pointer, non-interface field // appearing in ForceSendFields will be sent to the server regardless of // whether the field is empty or not. This may be used to include empty // fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. // "ComputeEngineAcceleratorType") to include in API requests with the // JSON null value. By default, fields with empty values are omitted // from API requests. However, any field with an empty value appearing // in NullFields will be sent to the server as null. It is an error if a // field in this list has a non-empty value. This may be used to include // null fields in Patch requests. NullFields []string `json:"-"` }
func (*XPSImageModelServingSpecModelThroughputEstimation) MarshalJSON ¶ added in v0.167.0
func (s *XPSImageModelServingSpecModelThroughputEstimation) MarshalJSON() ([]byte, error)
func (*XPSImageModelServingSpecModelThroughputEstimation) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSImageModelServingSpecModelThroughputEstimation) UnmarshalJSON(data []byte) error
type XPSImageObjectDetectionEvaluationMetrics ¶ added in v0.167.0
type XPSImageObjectDetectionEvaluationMetrics struct { // BoundingBoxMeanAveragePrecision: The single metric for bounding boxes // evaluation: the mean_average_precision averaged over all // bounding_box_metrics_entries. BoundingBoxMeanAveragePrecision float64 `json:"boundingBoxMeanAveragePrecision,omitempty"` // BoundingBoxMetricsEntries: The bounding boxes match metrics for each // Intersection-over-union threshold // 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label confidence // threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. BoundingBoxMetricsEntries []*XPSBoundingBoxMetricsEntry `json:"boundingBoxMetricsEntries,omitempty"` // EvaluatedBoundingBoxCount: The total number of bounding boxes (i.e. // summed over all images) the ground truth used to create this // evaluation had. EvaluatedBoundingBoxCount int64 `json:"evaluatedBoundingBoxCount,omitempty"` // ForceSendFields is a list of field names (e.g. // "BoundingBoxMeanAveragePrecision") to unconditionally include in API // requests. By default, fields with empty or default values are omitted // from API requests. However, any non-pointer, non-interface field // appearing in ForceSendFields will be sent to the server regardless of // whether the field is empty or not. This may be used to include empty // fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. // "BoundingBoxMeanAveragePrecision") to include in API requests with // the JSON null value. By default, fields with empty values are omitted // from API requests. However, any field with an empty value appearing // in NullFields will be sent to the server as null. It is an error if a // field in this list has a non-empty value. This may be used to include // null fields in Patch requests. NullFields []string `json:"-"` }
XPSImageObjectDetectionEvaluationMetrics: Model evaluation metrics for image object detection problems. Evaluates prediction quality of labeled bounding boxes.
func (*XPSImageObjectDetectionEvaluationMetrics) MarshalJSON ¶ added in v0.167.0
func (s *XPSImageObjectDetectionEvaluationMetrics) MarshalJSON() ([]byte, error)
func (*XPSImageObjectDetectionEvaluationMetrics) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSImageObjectDetectionEvaluationMetrics) UnmarshalJSON(data []byte) error
type XPSImageObjectDetectionModelSpec ¶ added in v0.167.0
type XPSImageObjectDetectionModelSpec struct { // ClassCount: Total number of classes. ClassCount int64 `json:"classCount,omitempty,string"` ExportModelSpec *XPSImageExportModelSpec `json:"exportModelSpec,omitempty"` // MaxBoundingBoxCount: Max number of bounding box. MaxBoundingBoxCount int64 `json:"maxBoundingBoxCount,omitempty,string"` // ModelArtifactSpec: ## The fields below are only populated under uCAIP // request scope. ModelArtifactSpec *XPSImageModelArtifactSpec `json:"modelArtifactSpec,omitempty"` ModelServingSpec *XPSImageModelServingSpec `json:"modelServingSpec,omitempty"` // StopReason: Stop reason for training job, e.g. // 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED'. // // Possible values: // "TRAIN_STOP_REASON_UNSPECIFIED" // "TRAIN_STOP_REASON_BUDGET_REACHED" // "TRAIN_STOP_REASON_MODEL_CONVERGED" - Model fully converged, can // not be resumbed training. // "TRAIN_STOP_REASON_MODEL_EARLY_STOPPED" - Model early converged, // can be further trained till full convergency. StopReason string `json:"stopReason,omitempty"` // TrainCostNodeSeconds: The actual train cost of creating this model, // expressed in node seconds, i.e. 3,600 value in this field means 1 // node hour. TrainCostNodeSeconds int64 `json:"trainCostNodeSeconds,omitempty,string"` // ForceSendFields is a list of field names (e.g. "ClassCount") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ClassCount") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*XPSImageObjectDetectionModelSpec) MarshalJSON ¶ added in v0.167.0
func (s *XPSImageObjectDetectionModelSpec) MarshalJSON() ([]byte, error)
type XPSImageSegmentationEvaluationMetrics ¶ added in v0.167.0
type XPSImageSegmentationEvaluationMetrics struct { // ConfidenceMetricsEntries: Metrics that have confidence thresholds. // Precision-recall curve can be derived from it. ConfidenceMetricsEntries []*XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry `json:"confidenceMetricsEntries,omitempty"` // ForceSendFields is a list of field names (e.g. // "ConfidenceMetricsEntries") to unconditionally include in API // requests. By default, fields with empty or default values are omitted // from API requests. However, any non-pointer, non-interface field // appearing in ForceSendFields will be sent to the server regardless of // whether the field is empty or not. This may be used to include empty // fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ConfidenceMetricsEntries") // to include in API requests with the JSON null value. By default, // fields with empty values are omitted from API requests. However, any // field with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSImageSegmentationEvaluationMetrics: Model evaluation metrics for image segmentation problems. Next tag: 4.
func (*XPSImageSegmentationEvaluationMetrics) MarshalJSON ¶ added in v0.167.0
func (s *XPSImageSegmentationEvaluationMetrics) MarshalJSON() ([]byte, error)
type XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry ¶ added in v0.167.0
type XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry struct { // ConfidenceThreshold: The confidence threshold value used to compute // the metrics. ConfidenceThreshold float64 `json:"confidenceThreshold,omitempty"` // ConfusionMatrix: Confusion matrix of the per confidence_threshold // evaluation. Pixel counts are set here. Only set for model level // evaluation, not for evaluation per label. ConfusionMatrix *XPSConfusionMatrix `json:"confusionMatrix,omitempty"` // DiceScoreCoefficient: DSC or the F1 score: The harmonic mean of // recall and precision. DiceScoreCoefficient float64 `json:"diceScoreCoefficient,omitempty"` // IouScore: IOU score. IouScore float64 `json:"iouScore,omitempty"` // Precision: Precision for the given confidence threshold. Precision float64 `json:"precision,omitempty"` // Recall: Recall for the given confidence threshold. Recall float64 `json:"recall,omitempty"` // ForceSendFields is a list of field names (e.g. "ConfidenceThreshold") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ConfidenceThreshold") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry: Metrics for a single confidence threshold.
func (*XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry) MarshalJSON ¶ added in v0.167.0
func (s *XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry) MarshalJSON() ([]byte, error)
func (*XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry) UnmarshalJSON(data []byte) error
type XPSImageSegmentationTrainResponse ¶ added in v0.167.0
type XPSImageSegmentationTrainResponse struct { // ColorMaps: Color map of the model. ColorMaps []*XPSColorMap `json:"colorMaps,omitempty"` // ExportModelSpec: NOTE: These fields are not used/needed in EAP but // will be set later. ExportModelSpec *XPSImageExportModelSpec `json:"exportModelSpec,omitempty"` // ModelArtifactSpec: ## The fields below are only populated under uCAIP // request scope. Model artifact spec stores and model gcs pathes and // related metadata ModelArtifactSpec *XPSImageModelArtifactSpec `json:"modelArtifactSpec,omitempty"` ModelServingSpec *XPSImageModelServingSpec `json:"modelServingSpec,omitempty"` // StopReason: Stop reason for training job, e.g. // 'TRAIN_BUDGET_REACHED', 'MODEL_CONVERGED'. // // Possible values: // "TRAIN_STOP_REASON_UNSPECIFIED" // "TRAIN_STOP_REASON_BUDGET_REACHED" // "TRAIN_STOP_REASON_MODEL_CONVERGED" - Model fully converged, can // not be resumbed training. // "TRAIN_STOP_REASON_MODEL_EARLY_STOPPED" - Model early converged, // can be further trained till full convergency. StopReason string `json:"stopReason,omitempty"` // TrainCostNodeSeconds: The actual train cost of creating this model, // expressed in node seconds, i.e. 3,600 value in this field means 1 // node hour. TrainCostNodeSeconds int64 `json:"trainCostNodeSeconds,omitempty,string"` // ForceSendFields is a list of field names (e.g. "ColorMaps") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ColorMaps") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*XPSImageSegmentationTrainResponse) MarshalJSON ¶ added in v0.167.0
func (s *XPSImageSegmentationTrainResponse) MarshalJSON() ([]byte, error)
type XPSIntegratedGradientsAttribution ¶ added in v0.167.0
type XPSIntegratedGradientsAttribution struct { // StepCount: The number of steps for approximating the path integral. A // good value to start is 50 and gradually increase until the sum to // diff property is within the desired error range. Valid range of its // value is [1, 100], inclusively. StepCount int64 `json:"stepCount,omitempty"` // ForceSendFields is a list of field names (e.g. "StepCount") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "StepCount") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSIntegratedGradientsAttribution: An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
func (*XPSIntegratedGradientsAttribution) MarshalJSON ¶ added in v0.167.0
func (s *XPSIntegratedGradientsAttribution) MarshalJSON() ([]byte, error)
type XPSMetricEntry ¶ added in v0.167.0
type XPSMetricEntry struct { // ArgentumMetricId: For billing metrics that are using legacy sku's, // set the legacy billing metric id here. This will be sent to Chemist // as the "cloudbilling.googleapis.com/argentum_metric_id" label. // Otherwise leave empty. ArgentumMetricId string `json:"argentumMetricId,omitempty"` // DoubleValue: A double value. DoubleValue float64 `json:"doubleValue,omitempty"` // Int64Value: A signed 64-bit integer value. Int64Value int64 `json:"int64Value,omitempty,string"` // MetricName: The metric name defined in the service configuration. MetricName string `json:"metricName,omitempty"` // SystemLabels: Billing system labels for this (metric, value) pair. SystemLabels []*XPSMetricEntryLabel `json:"systemLabels,omitempty"` // ForceSendFields is a list of field names (e.g. "ArgentumMetricId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ArgentumMetricId") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*XPSMetricEntry) MarshalJSON ¶ added in v0.167.0
func (s *XPSMetricEntry) MarshalJSON() ([]byte, error)
func (*XPSMetricEntry) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSMetricEntry) UnmarshalJSON(data []byte) error
type XPSMetricEntryLabel ¶ added in v0.167.0
type XPSMetricEntryLabel struct { // LabelName: The name of the label. LabelName string `json:"labelName,omitempty"` // LabelValue: The value of the label. LabelValue string `json:"labelValue,omitempty"` // ForceSendFields is a list of field names (e.g. "LabelName") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "LabelName") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*XPSMetricEntryLabel) MarshalJSON ¶ added in v0.167.0
func (s *XPSMetricEntryLabel) MarshalJSON() ([]byte, error)
type XPSModelArtifactItem ¶ added in v0.167.0
type XPSModelArtifactItem struct { // ArtifactFormat: The model artifact format. // // Possible values: // "ARTIFACT_FORMAT_UNSPECIFIED" - Should not be used. // "TF_CHECKPOINT" - The Tensorflow checkpoints. See // https://www.tensorflow.org/guide/checkpoint. // "TF_SAVED_MODEL" - The Tensorflow SavedModel binary. // "TF_LITE" - Model artifact in generic TensorFlow Lite (.tflite) // format. See https://www.tensorflow.org/lite. // "EDGE_TPU_TF_LITE" - Used for [Edge // TPU](https://cloud.google.com/edge-tpu/) devices. // "TF_JS" - A [TensorFlow.js](https://www.tensorflow.org/js) model // that can be used in the browser and in Node.js using JavaScript. // "CORE_ML" - Used for iOS mobile devices in (.mlmodel) format. See // https://developer.apple.com/documentation/coreml ArtifactFormat string `json:"artifactFormat,omitempty"` // GcsUri: The Google Cloud Storage (GCS) uri that stores the model // binary files. GcsUri string `json:"gcsUri,omitempty"` // ForceSendFields is a list of field names (e.g. "ArtifactFormat") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ArtifactFormat") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSModelArtifactItem: A single model artifact item.
func (*XPSModelArtifactItem) MarshalJSON ¶ added in v0.167.0
func (s *XPSModelArtifactItem) MarshalJSON() ([]byte, error)
type XPSPreprocessResponse ¶ added in v0.167.0
type XPSPreprocessResponse struct { // OutputExampleSet: Preprocessed examples, that are to be imported into // AutoML storage. This should point to RecordIO file(s) of // PreprocessedExample messages. The // PreprocessedExample.mvp_training_data-s returned here are later // verbatim passed to Train() call in TrainExample.mvp_training_data. OutputExampleSet *XPSExampleSet `json:"outputExampleSet,omitempty"` SpeechPreprocessResp *XPSSpeechPreprocessResponse `json:"speechPreprocessResp,omitempty"` TablesPreprocessResponse *XPSTablesPreprocessResponse `json:"tablesPreprocessResponse,omitempty"` TranslationPreprocessResp *XPSTranslationPreprocessResponse `json:"translationPreprocessResp,omitempty"` // ForceSendFields is a list of field names (e.g. "OutputExampleSet") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "OutputExampleSet") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSPreprocessResponse: Next ID: 8
func (*XPSPreprocessResponse) MarshalJSON ¶ added in v0.167.0
func (s *XPSPreprocessResponse) MarshalJSON() ([]byte, error)
type XPSRegressionEvaluationMetrics ¶ added in v0.167.0
type XPSRegressionEvaluationMetrics struct { // MeanAbsoluteError: Mean Absolute Error (MAE). MeanAbsoluteError float64 `json:"meanAbsoluteError,omitempty"` // MeanAbsolutePercentageError: Mean absolute percentage error. Only set // if all ground truth values are positive. MeanAbsolutePercentageError float64 `json:"meanAbsolutePercentageError,omitempty"` // RSquared: R squared. RSquared float64 `json:"rSquared,omitempty"` // RegressionMetricsEntries: A list of actual versus predicted points // for the model being evaluated. RegressionMetricsEntries []*XPSRegressionMetricsEntry `json:"regressionMetricsEntries,omitempty"` // RootMeanSquaredError: Root Mean Squared Error (RMSE). RootMeanSquaredError float64 `json:"rootMeanSquaredError,omitempty"` // RootMeanSquaredLogError: Root mean squared log error. RootMeanSquaredLogError float64 `json:"rootMeanSquaredLogError,omitempty"` // ForceSendFields is a list of field names (e.g. "MeanAbsoluteError") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "MeanAbsoluteError") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSRegressionEvaluationMetrics: Model evaluation metrics for regression problems. It can be used for Tables.
func (*XPSRegressionEvaluationMetrics) MarshalJSON ¶ added in v0.167.0
func (s *XPSRegressionEvaluationMetrics) MarshalJSON() ([]byte, error)
func (*XPSRegressionEvaluationMetrics) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSRegressionEvaluationMetrics) UnmarshalJSON(data []byte) error
type XPSRegressionMetricsEntry ¶ added in v0.167.0
type XPSRegressionMetricsEntry struct { // PredictedValue: The observed value for a row in the dataset. PredictedValue float64 `json:"predictedValue,omitempty"` // TrueValue: The actual target value for a row in the dataset. TrueValue float64 `json:"trueValue,omitempty"` // ForceSendFields is a list of field names (e.g. "PredictedValue") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "PredictedValue") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSRegressionMetricsEntry: A pair of actual & observed values for the model being evaluated.
func (*XPSRegressionMetricsEntry) MarshalJSON ¶ added in v0.167.0
func (s *XPSRegressionMetricsEntry) MarshalJSON() ([]byte, error)
func (*XPSRegressionMetricsEntry) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSRegressionMetricsEntry) UnmarshalJSON(data []byte) error
type XPSReportingMetrics ¶ added in v0.167.0
type XPSReportingMetrics struct { // EffectiveTrainingDuration: The effective time training used. If set, // this is used for quota management and billing. Deprecated. AutoML BE // doesn't use this. Don't set. EffectiveTrainingDuration string `json:"effectiveTrainingDuration,omitempty"` // MetricEntries: One entry per metric name. The values must be // aggregated per metric name. MetricEntries []*XPSMetricEntry `json:"metricEntries,omitempty"` // ForceSendFields is a list of field names (e.g. // "EffectiveTrainingDuration") to unconditionally include in API // requests. By default, fields with empty or default values are omitted // from API requests. However, any non-pointer, non-interface field // appearing in ForceSendFields will be sent to the server regardless of // whether the field is empty or not. This may be used to include empty // fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. // "EffectiveTrainingDuration") to include in API requests with the JSON // null value. By default, fields with empty values are omitted from API // requests. However, any field with an empty value appearing in // NullFields will be sent to the server as null. It is an error if a // field in this list has a non-empty value. This may be used to include // null fields in Patch requests. NullFields []string `json:"-"` }
func (*XPSReportingMetrics) MarshalJSON ¶ added in v0.167.0
func (s *XPSReportingMetrics) MarshalJSON() ([]byte, error)
type XPSResponseExplanationMetadata ¶ added in v0.167.0
type XPSResponseExplanationMetadata struct { // Inputs: Metadata of the input. Inputs map[string]XPSResponseExplanationMetadataInputMetadata `json:"inputs,omitempty"` // Outputs: Metadata of the output. Outputs map[string]XPSResponseExplanationMetadataOutputMetadata `json:"outputs,omitempty"` // ForceSendFields is a list of field names (e.g. "Inputs") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Inputs") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*XPSResponseExplanationMetadata) MarshalJSON ¶ added in v0.167.0
func (s *XPSResponseExplanationMetadata) MarshalJSON() ([]byte, error)
type XPSResponseExplanationMetadataInputMetadata ¶ added in v0.167.0
type XPSResponseExplanationMetadataInputMetadata struct { // InputTensorName: Name of the input tensor for this model. Only needed // in train response. InputTensorName string `json:"inputTensorName,omitempty"` // Modality: Modality of the feature. Valid values are: numeric, image. // Defaults to numeric. // // Possible values: // "MODALITY_UNSPECIFIED" // "NUMERIC" // "IMAGE" // "CATEGORICAL" Modality string `json:"modality,omitempty"` // VisualizationConfig: Visualization configurations for image // explanation. VisualizationConfig *XPSVisualization `json:"visualizationConfig,omitempty"` // ForceSendFields is a list of field names (e.g. "InputTensorName") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "InputTensorName") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSResponseExplanationMetadataInputMetadata: Metadata of the input of a feature.
func (*XPSResponseExplanationMetadataInputMetadata) MarshalJSON ¶ added in v0.167.0
func (s *XPSResponseExplanationMetadataInputMetadata) MarshalJSON() ([]byte, error)
type XPSResponseExplanationMetadataOutputMetadata ¶ added in v0.167.0
type XPSResponseExplanationMetadataOutputMetadata struct { // OutputTensorName: Name of the output tensor. Only needed in train // response. OutputTensorName string `json:"outputTensorName,omitempty"` // ForceSendFields is a list of field names (e.g. "OutputTensorName") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "OutputTensorName") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSResponseExplanationMetadataOutputMetadata: Metadata of the prediction output to be explained.
func (*XPSResponseExplanationMetadataOutputMetadata) MarshalJSON ¶ added in v0.167.0
func (s *XPSResponseExplanationMetadataOutputMetadata) MarshalJSON() ([]byte, error)
type XPSResponseExplanationParameters ¶ added in v0.167.0
type XPSResponseExplanationParameters struct { // IntegratedGradientsAttribution: An attribution method that computes // Aumann-Shapley values taking advantage of the model's fully // differentiable structure. Refer to this paper for more details: // https://arxiv.org/abs/1703.01365 IntegratedGradientsAttribution *XPSIntegratedGradientsAttribution `json:"integratedGradientsAttribution,omitempty"` // XraiAttribution: An attribution method that redistributes Integrated // Gradients attribution to segmented regions, taking advantage of the // model's fully differentiable structure. Refer to this paper for more // details: https://arxiv.org/abs/1906.02825 XRAI currently performs // better on natural images, like a picture of a house or an animal. If // the images are taken in artificial environments, like a lab or // manufacturing line, or from diagnostic equipment, like x-rays or // quality-control cameras, use Integrated Gradients instead. XraiAttribution *XPSXraiAttribution `json:"xraiAttribution,omitempty"` // ForceSendFields is a list of field names (e.g. // "IntegratedGradientsAttribution") to unconditionally include in API // requests. By default, fields with empty or default values are omitted // from API requests. However, any non-pointer, non-interface field // appearing in ForceSendFields will be sent to the server regardless of // whether the field is empty or not. This may be used to include empty // fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. // "IntegratedGradientsAttribution") to include in API requests with the // JSON null value. By default, fields with empty values are omitted // from API requests. However, any field with an empty value appearing // in NullFields will be sent to the server as null. It is an error if a // field in this list has a non-empty value. This may be used to include // null fields in Patch requests. NullFields []string `json:"-"` }
func (*XPSResponseExplanationParameters) MarshalJSON ¶ added in v0.167.0
func (s *XPSResponseExplanationParameters) MarshalJSON() ([]byte, error)
type XPSResponseExplanationSpec ¶ added in v0.167.0
type XPSResponseExplanationSpec struct { // ExplanationType: Explanation type. For AutoML Image Classification // models, possible values are: * `image-integrated-gradients` * // `image-xrai` ExplanationType string `json:"explanationType,omitempty"` // Metadata: Metadata describing the Model's input and output for // explanation. Metadata *XPSResponseExplanationMetadata `json:"metadata,omitempty"` // Parameters: Parameters that configure explaining of the Model's // predictions. Parameters *XPSResponseExplanationParameters `json:"parameters,omitempty"` // ForceSendFields is a list of field names (e.g. "ExplanationType") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ExplanationType") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSResponseExplanationSpec: Specification of Model explanation. Feature-based XAI in AutoML Vision ICN is deprecated, see b/288407203 for context.
func (*XPSResponseExplanationSpec) MarshalJSON ¶ added in v0.167.0
func (s *XPSResponseExplanationSpec) MarshalJSON() ([]byte, error)
type XPSRow ¶ added in v0.167.0
type XPSRow struct { // ColumnIds: The ids of the columns. Note: The below `values` field // must match order of this field, if this field is set. ColumnIds []int64 `json:"columnIds,omitempty"` // Values: The values of the row cells, given in the same order as the // column_ids. If column_ids is not set, then in the same order as the // input_feature_column_ids in TablesModelMetadata. Values []interface{} `json:"values,omitempty"` // ForceSendFields is a list of field names (e.g. "ColumnIds") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ColumnIds") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*XPSRow) MarshalJSON ¶ added in v0.167.0
type XPSSpeechEvaluationMetrics ¶ added in v0.167.0
type XPSSpeechEvaluationMetrics struct { // SubModelEvaluationMetrics: Evaluation metrics for all submodels // contained in this model. SubModelEvaluationMetrics []*XPSSpeechEvaluationMetricsSubModelEvaluationMetric `json:"subModelEvaluationMetrics,omitempty"` // ForceSendFields is a list of field names (e.g. // "SubModelEvaluationMetrics") to unconditionally include in API // requests. By default, fields with empty or default values are omitted // from API requests. However, any non-pointer, non-interface field // appearing in ForceSendFields will be sent to the server regardless of // whether the field is empty or not. This may be used to include empty // fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. // "SubModelEvaluationMetrics") to include in API requests with the JSON // null value. By default, fields with empty values are omitted from API // requests. However, any field with an empty value appearing in // NullFields will be sent to the server as null. It is an error if a // field in this list has a non-empty value. This may be used to include // null fields in Patch requests. NullFields []string `json:"-"` }
func (*XPSSpeechEvaluationMetrics) MarshalJSON ¶ added in v0.167.0
func (s *XPSSpeechEvaluationMetrics) MarshalJSON() ([]byte, error)
type XPSSpeechEvaluationMetricsSubModelEvaluationMetric ¶ added in v0.167.0
type XPSSpeechEvaluationMetricsSubModelEvaluationMetric struct { // BiasingModelType: Type of the biasing model. // // Possible values: // "BIASING_MODEL_TYPE_UNSPECIFIED" // "COMMAND_AND_SEARCH" - Build biasing model on top of // COMMAND_AND_SEARCH model // "PHONE_CALL" - Build biasing model on top of PHONE_CALL model // "VIDEO" - Build biasing model on top of VIDEO model // "DEFAULT" - Build biasing model on top of DEFAULT model BiasingModelType string `json:"biasingModelType,omitempty"` // IsEnhancedModel: If true then it means we have an enhanced version of // the biasing models. IsEnhancedModel bool `json:"isEnhancedModel,omitempty"` NumDeletions int64 `json:"numDeletions,omitempty"` NumInsertions int64 `json:"numInsertions,omitempty"` NumSubstitutions int64 `json:"numSubstitutions,omitempty"` // NumUtterances: Number of utterances used in the wer computation. NumUtterances int64 `json:"numUtterances,omitempty"` // NumWords: Number of words over which the word error rate was // computed. NumWords int64 `json:"numWords,omitempty"` // SentenceAccuracy: Below fields are used for debugging purposes SentenceAccuracy float64 `json:"sentenceAccuracy,omitempty"` // Wer: Word error rate (standard error metric used for speech // recognition). Wer float64 `json:"wer,omitempty"` // ForceSendFields is a list of field names (e.g. "BiasingModelType") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BiasingModelType") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*XPSSpeechEvaluationMetricsSubModelEvaluationMetric) MarshalJSON ¶ added in v0.167.0
func (s *XPSSpeechEvaluationMetricsSubModelEvaluationMetric) MarshalJSON() ([]byte, error)
func (*XPSSpeechEvaluationMetricsSubModelEvaluationMetric) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSSpeechEvaluationMetricsSubModelEvaluationMetric) UnmarshalJSON(data []byte) error
type XPSSpeechModelSpec ¶ added in v0.167.0
type XPSSpeechModelSpec struct { // DatasetId: Required for speech xps backend. Speech xps has to use // dataset_id and model_id as the primary key in db so that speech API // can query the db directly. DatasetId int64 `json:"datasetId,omitempty,string"` Language string `json:"language,omitempty"` // SubModelSpecs: Model specs for all submodels contained in this model. SubModelSpecs []*XPSSpeechModelSpecSubModelSpec `json:"subModelSpecs,omitempty"` // ForceSendFields is a list of field names (e.g. "DatasetId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DatasetId") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*XPSSpeechModelSpec) MarshalJSON ¶ added in v0.167.0
func (s *XPSSpeechModelSpec) MarshalJSON() ([]byte, error)
type XPSSpeechModelSpecSubModelSpec ¶ added in v0.167.0
type XPSSpeechModelSpecSubModelSpec struct { // BiasingModelType: Type of the biasing model. // // Possible values: // "BIASING_MODEL_TYPE_UNSPECIFIED" // "COMMAND_AND_SEARCH" - Build biasing model on top of // COMMAND_AND_SEARCH model // "PHONE_CALL" - Build biasing model on top of PHONE_CALL model // "VIDEO" - Build biasing model on top of VIDEO model // "DEFAULT" - Build biasing model on top of DEFAULT model BiasingModelType string `json:"biasingModelType,omitempty"` // ClientId: In S3, Recognition ClientContextId.client_id ClientId string `json:"clientId,omitempty"` // ContextId: In S3, Recognition ClientContextId.context_id ContextId string `json:"contextId,omitempty"` // IsEnhancedModel: If true then it means we have an enhanced version of // the biasing models. IsEnhancedModel bool `json:"isEnhancedModel,omitempty"` // ForceSendFields is a list of field names (e.g. "BiasingModelType") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BiasingModelType") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*XPSSpeechModelSpecSubModelSpec) MarshalJSON ¶ added in v0.167.0
func (s *XPSSpeechModelSpecSubModelSpec) MarshalJSON() ([]byte, error)
type XPSSpeechPreprocessResponse ¶ added in v0.167.0
type XPSSpeechPreprocessResponse struct { // CnsTestDataPath: Location od shards of sstables (test data) of // DataUtterance protos. CnsTestDataPath string `json:"cnsTestDataPath,omitempty"` // CnsTrainDataPath: Location of shards of sstables (training data) of // DataUtterance protos. CnsTrainDataPath string `json:"cnsTrainDataPath,omitempty"` // PrebuiltModelEvaluationMetrics: The metrics for prebuilt speech // models. They are included here because there is no prebuilt speech // models stored in the AutoML. PrebuiltModelEvaluationMetrics *XPSSpeechEvaluationMetrics `json:"prebuiltModelEvaluationMetrics,omitempty"` // SpeechPreprocessStats: Stats associated with the data. SpeechPreprocessStats *XPSSpeechPreprocessStats `json:"speechPreprocessStats,omitempty"` // ForceSendFields is a list of field names (e.g. "CnsTestDataPath") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CnsTestDataPath") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*XPSSpeechPreprocessResponse) MarshalJSON ¶ added in v0.167.0
func (s *XPSSpeechPreprocessResponse) MarshalJSON() ([]byte, error)
type XPSSpeechPreprocessStats ¶ added in v0.167.0
type XPSSpeechPreprocessStats struct { // DataErrors: Different types of data errors and the counts associated // with them. DataErrors []*XPSDataErrors `json:"dataErrors,omitempty"` // NumHumanLabeledExamples: The number of rows marked HUMAN_LABELLED NumHumanLabeledExamples int64 `json:"numHumanLabeledExamples,omitempty"` // NumLogsExamples: The number of samples found in the previously // recorded logs data. NumLogsExamples int64 `json:"numLogsExamples,omitempty"` // NumMachineTranscribedExamples: The number of rows marked as // MACHINE_TRANSCRIBED NumMachineTranscribedExamples int64 `json:"numMachineTranscribedExamples,omitempty"` // TestExamplesCount: The number of examples labelled as TEST by Speech // xps server. TestExamplesCount int64 `json:"testExamplesCount,omitempty"` // TestSentencesCount: The number of sentences in the test data set. TestSentencesCount int64 `json:"testSentencesCount,omitempty"` // TestWordsCount: The number of words in the test data set. TestWordsCount int64 `json:"testWordsCount,omitempty"` // TrainExamplesCount: The number of examples labeled as TRAIN by Speech // xps server. TrainExamplesCount int64 `json:"trainExamplesCount,omitempty"` // TrainSentencesCount: The number of sentences in the training data // set. TrainSentencesCount int64 `json:"trainSentencesCount,omitempty"` // TrainWordsCount: The number of words in the training data set. TrainWordsCount int64 `json:"trainWordsCount,omitempty"` // ForceSendFields is a list of field names (e.g. "DataErrors") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DataErrors") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*XPSSpeechPreprocessStats) MarshalJSON ¶ added in v0.167.0
func (s *XPSSpeechPreprocessStats) MarshalJSON() ([]byte, error)
type XPSStringStats ¶ added in v0.167.0
type XPSStringStats struct { CommonStats *XPSCommonStats `json:"commonStats,omitempty"` // TopUnigramStats: The statistics of the top 20 unigrams, ordered by // StringStats.UnigramStats.count. TopUnigramStats []*XPSStringStatsUnigramStats `json:"topUnigramStats,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonStats") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CommonStats") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSStringStats: The data statistics of a series of STRING values.
func (*XPSStringStats) MarshalJSON ¶ added in v0.167.0
func (s *XPSStringStats) MarshalJSON() ([]byte, error)
type XPSStringStatsUnigramStats ¶ added in v0.167.0
type XPSStringStatsUnigramStats struct { // Count: The number of occurrences of this unigram in the series. Count int64 `json:"count,omitempty,string"` // Value: The unigram. Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "Count") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Count") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSStringStatsUnigramStats: The statistics of a unigram.
func (*XPSStringStatsUnigramStats) MarshalJSON ¶ added in v0.167.0
func (s *XPSStringStatsUnigramStats) MarshalJSON() ([]byte, error)
type XPSStructStats ¶ added in v0.167.0
type XPSStructStats struct { CommonStats *XPSCommonStats `json:"commonStats,omitempty"` // FieldStats: Map from a field name of the struct to data stats // aggregated over series of all data in that field across all the // structs. FieldStats map[string]XPSDataStats `json:"fieldStats,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonStats") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CommonStats") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSStructStats: The data statistics of a series of STRUCT values.
func (*XPSStructStats) MarshalJSON ¶ added in v0.167.0
func (s *XPSStructStats) MarshalJSON() ([]byte, error)
type XPSStructType ¶ added in v0.167.0
type XPSStructType struct { // Fields: Unordered map of struct field names to their data types. Fields map[string]XPSDataType `json:"fields,omitempty"` // ForceSendFields is a list of field names (e.g. "Fields") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Fields") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSStructType: `StructType` defines the DataType-s of a STRUCT type.
func (*XPSStructType) MarshalJSON ¶ added in v0.167.0
func (s *XPSStructType) MarshalJSON() ([]byte, error)
type XPSTableSpec ¶ added in v0.167.0
type XPSTableSpec struct { // ColumnSpecs: Mapping from column id to column spec. ColumnSpecs map[string]XPSColumnSpec `json:"columnSpecs,omitempty"` // ImportedDataSizeInBytes: The total size of imported data of the // table. ImportedDataSizeInBytes int64 `json:"importedDataSizeInBytes,omitempty,string"` // RowCount: The number of rows in the table. RowCount int64 `json:"rowCount,omitempty,string"` // TimeColumnId: The id of the time column. TimeColumnId int64 `json:"timeColumnId,omitempty"` // ValidRowCount: The number of valid rows. ValidRowCount int64 `json:"validRowCount,omitempty,string"` // ForceSendFields is a list of field names (e.g. "ColumnSpecs") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ColumnSpecs") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*XPSTableSpec) MarshalJSON ¶ added in v0.167.0
func (s *XPSTableSpec) MarshalJSON() ([]byte, error)
type XPSTablesClassificationMetrics ¶ added in v0.167.0
type XPSTablesClassificationMetrics struct { // CurveMetrics: Metrics building a curve. CurveMetrics []*XPSTablesClassificationMetricsCurveMetrics `json:"curveMetrics,omitempty"` // ForceSendFields is a list of field names (e.g. "CurveMetrics") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CurveMetrics") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSTablesClassificationMetrics: Metrics for Tables classification problems.
func (*XPSTablesClassificationMetrics) MarshalJSON ¶ added in v0.167.0
func (s *XPSTablesClassificationMetrics) MarshalJSON() ([]byte, error)
type XPSTablesClassificationMetricsCurveMetrics ¶ added in v0.167.0
type XPSTablesClassificationMetricsCurveMetrics struct { // AucPr: The area under the precision-recall curve. AucPr float64 `json:"aucPr,omitempty"` // AucRoc: The area under receiver operating characteristic curve. AucRoc float64 `json:"aucRoc,omitempty"` // ConfidenceMetricsEntries: Metrics that have confidence thresholds. // Precision-recall curve and ROC curve can be derived from them. ConfidenceMetricsEntries []*XPSTablesConfidenceMetricsEntry `json:"confidenceMetricsEntries,omitempty"` // LogLoss: The Log loss metric. LogLoss float64 `json:"logLoss,omitempty"` // PositionThreshold: The position threshold value used to compute the // metrics. PositionThreshold int64 `json:"positionThreshold,omitempty"` // Value: The CATEGORY row value (for ARRAY unnested) the curve metrics // are for. Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "AucPr") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AucPr") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSTablesClassificationMetricsCurveMetrics: Metrics curve data point for a single value.
func (*XPSTablesClassificationMetricsCurveMetrics) MarshalJSON ¶ added in v0.167.0
func (s *XPSTablesClassificationMetricsCurveMetrics) MarshalJSON() ([]byte, error)
func (*XPSTablesClassificationMetricsCurveMetrics) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSTablesClassificationMetricsCurveMetrics) UnmarshalJSON(data []byte) error
type XPSTablesConfidenceMetricsEntry ¶ added in v0.167.0
type XPSTablesConfidenceMetricsEntry struct { // ConfidenceThreshold: The confidence threshold value used to compute // the metrics. ConfidenceThreshold float64 `json:"confidenceThreshold,omitempty"` // F1Score: The harmonic mean of recall and precision. (2 * precision * // recall) / (precision + recall) F1Score float64 `json:"f1Score,omitempty"` // FalseNegativeCount: False negative count. FalseNegativeCount int64 `json:"falseNegativeCount,omitempty,string"` // FalsePositiveCount: False positive count. FalsePositiveCount int64 `json:"falsePositiveCount,omitempty,string"` // FalsePositiveRate: FPR = #false positives / (#false positives + #true // negatives) FalsePositiveRate float64 `json:"falsePositiveRate,omitempty"` // Precision: Precision = #true positives / (#true positives + #false // positives). Precision float64 `json:"precision,omitempty"` // Recall: Recall = #true positives / (#true positives + #false // negatives). Recall float64 `json:"recall,omitempty"` // TrueNegativeCount: True negative count. TrueNegativeCount int64 `json:"trueNegativeCount,omitempty,string"` // TruePositiveCount: True positive count. TruePositiveCount int64 `json:"truePositiveCount,omitempty,string"` // TruePositiveRate: TPR = #true positives / (#true positives + #false // negatvies) TruePositiveRate float64 `json:"truePositiveRate,omitempty"` // ForceSendFields is a list of field names (e.g. "ConfidenceThreshold") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ConfidenceThreshold") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSTablesConfidenceMetricsEntry: Metrics for a single confidence threshold.
func (*XPSTablesConfidenceMetricsEntry) MarshalJSON ¶ added in v0.167.0
func (s *XPSTablesConfidenceMetricsEntry) MarshalJSON() ([]byte, error)
func (*XPSTablesConfidenceMetricsEntry) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSTablesConfidenceMetricsEntry) UnmarshalJSON(data []byte) error
type XPSTablesDatasetMetadata ¶ added in v0.167.0
type XPSTablesDatasetMetadata struct { // MlUseColumnId: Id the column to split the table. MlUseColumnId int64 `json:"mlUseColumnId,omitempty"` // PrimaryTableSpec: Primary table. PrimaryTableSpec *XPSTableSpec `json:"primaryTableSpec,omitempty"` // TargetColumnCorrelations: (the column id : its CorrelationStats with // target column). TargetColumnCorrelations map[string]XPSCorrelationStats `json:"targetColumnCorrelations,omitempty"` // TargetColumnId: Id of the primary table column that should be used as // the training label. TargetColumnId int64 `json:"targetColumnId,omitempty"` // WeightColumnId: Id of the primary table column that should be used as // the weight column. WeightColumnId int64 `json:"weightColumnId,omitempty"` // ForceSendFields is a list of field names (e.g. "MlUseColumnId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "MlUseColumnId") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSTablesDatasetMetadata: Metadata for a dataset used for AutoML Tables. Next ID: 6
func (*XPSTablesDatasetMetadata) MarshalJSON ¶ added in v0.167.0
func (s *XPSTablesDatasetMetadata) MarshalJSON() ([]byte, error)
type XPSTablesEvaluationMetrics ¶ added in v0.167.0
type XPSTablesEvaluationMetrics struct { // ClassificationMetrics: Classification metrics. ClassificationMetrics *XPSTablesClassificationMetrics `json:"classificationMetrics,omitempty"` // RegressionMetrics: Regression metrics. RegressionMetrics *XPSTablesRegressionMetrics `json:"regressionMetrics,omitempty"` // ForceSendFields is a list of field names (e.g. // "ClassificationMetrics") to unconditionally include in API requests. // By default, fields with empty or default values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ClassificationMetrics") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*XPSTablesEvaluationMetrics) MarshalJSON ¶ added in v0.167.0
func (s *XPSTablesEvaluationMetrics) MarshalJSON() ([]byte, error)
type XPSTablesModelColumnInfo ¶ added in v0.167.0
type XPSTablesModelColumnInfo struct { // ColumnId: The ID of the column. ColumnId int64 `json:"columnId,omitempty"` // FeatureImportance: When given as part of a Model: Measurement of how // much model predictions correctness on the TEST data depend on values // in this column. A value between 0 and 1, higher means higher // influence. These values are normalized - for all input feature // columns of a given model they add to 1. When given back by Predict or // Batch Predict: Measurement of how impactful for the prediction // returned for the given row the value in this column was. // Specifically, the feature importance specifies the marginal // contribution that the feature made to the prediction score compared // to the baseline score. These values are computed using the Sampled // Shapley method. FeatureImportance float64 `json:"featureImportance,omitempty"` // ForceSendFields is a list of field names (e.g. "ColumnId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ColumnId") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSTablesModelColumnInfo: An information specific to given column and Tables Model, in context of the Model and the predictions created by it.
func (*XPSTablesModelColumnInfo) MarshalJSON ¶ added in v0.167.0
func (s *XPSTablesModelColumnInfo) MarshalJSON() ([]byte, error)
func (*XPSTablesModelColumnInfo) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSTablesModelColumnInfo) UnmarshalJSON(data []byte) error
type XPSTablesModelStructure ¶ added in v0.167.0
type XPSTablesModelStructure struct { // ModelParameters: A list of models. ModelParameters []*XPSTablesModelStructureModelParameters `json:"modelParameters,omitempty"` // ForceSendFields is a list of field names (e.g. "ModelParameters") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ModelParameters") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSTablesModelStructure: A description of Tables model structure.
func (*XPSTablesModelStructure) MarshalJSON ¶ added in v0.167.0
func (s *XPSTablesModelStructure) MarshalJSON() ([]byte, error)
type XPSTablesModelStructureModelParameters ¶ added in v0.167.0
type XPSTablesModelStructureModelParameters struct { Hyperparameters []*XPSTablesModelStructureModelParametersParameter `json:"hyperparameters,omitempty"` // ForceSendFields is a list of field names (e.g. "Hyperparameters") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Hyperparameters") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSTablesModelStructureModelParameters: Model hyper-parameters for a model.
func (*XPSTablesModelStructureModelParameters) MarshalJSON ¶ added in v0.167.0
func (s *XPSTablesModelStructureModelParameters) MarshalJSON() ([]byte, error)
type XPSTablesModelStructureModelParametersParameter ¶ added in v0.167.0
type XPSTablesModelStructureModelParametersParameter struct { // FloatValue: Float type parameter value. FloatValue float64 `json:"floatValue,omitempty"` // IntValue: Integer type parameter value. IntValue int64 `json:"intValue,omitempty,string"` // Name: Parameter name. Name string `json:"name,omitempty"` // StringValue: String type parameter value. StringValue string `json:"stringValue,omitempty"` // ForceSendFields is a list of field names (e.g. "FloatValue") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FloatValue") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*XPSTablesModelStructureModelParametersParameter) MarshalJSON ¶ added in v0.167.0
func (s *XPSTablesModelStructureModelParametersParameter) MarshalJSON() ([]byte, error)
func (*XPSTablesModelStructureModelParametersParameter) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSTablesModelStructureModelParametersParameter) UnmarshalJSON(data []byte) error
type XPSTablesPreprocessResponse ¶ added in v0.167.0
type XPSTablesPreprocessResponse struct { // TablesDatasetMetadata: The table/column id, column_name and the // DataTypes of the columns will be populated. TablesDatasetMetadata *XPSTablesDatasetMetadata `json:"tablesDatasetMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. // "TablesDatasetMetadata") to unconditionally include in API requests. // By default, fields with empty or default values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "TablesDatasetMetadata") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*XPSTablesPreprocessResponse) MarshalJSON ¶ added in v0.167.0
func (s *XPSTablesPreprocessResponse) MarshalJSON() ([]byte, error)
type XPSTablesRegressionMetrics ¶ added in v0.167.0
type XPSTablesRegressionMetrics struct { // MeanAbsoluteError: Mean absolute error. MeanAbsoluteError float64 `json:"meanAbsoluteError,omitempty"` // MeanAbsolutePercentageError: Mean absolute percentage error, only set // if all of the target column's values are positive. MeanAbsolutePercentageError float64 `json:"meanAbsolutePercentageError,omitempty"` // RSquared: R squared. RSquared float64 `json:"rSquared,omitempty"` // RegressionMetricsEntries: A list of actual versus predicted points // for the model being evaluated. RegressionMetricsEntries []*XPSRegressionMetricsEntry `json:"regressionMetricsEntries,omitempty"` // RootMeanSquaredError: Root mean squared error. RootMeanSquaredError float64 `json:"rootMeanSquaredError,omitempty"` // RootMeanSquaredLogError: Root mean squared log error. RootMeanSquaredLogError float64 `json:"rootMeanSquaredLogError,omitempty"` // ForceSendFields is a list of field names (e.g. "MeanAbsoluteError") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "MeanAbsoluteError") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSTablesRegressionMetrics: Metrics for Tables regression problems.
func (*XPSTablesRegressionMetrics) MarshalJSON ¶ added in v0.167.0
func (s *XPSTablesRegressionMetrics) MarshalJSON() ([]byte, error)
func (*XPSTablesRegressionMetrics) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSTablesRegressionMetrics) UnmarshalJSON(data []byte) error
type XPSTablesTrainResponse ¶ added in v0.167.0
type XPSTablesTrainResponse struct { ModelStructure *XPSTablesModelStructure `json:"modelStructure,omitempty"` // PredictionSampleRows: Sample rows from the dataset this model was // trained. PredictionSampleRows []*XPSRow `json:"predictionSampleRows,omitempty"` // TablesModelColumnInfo: Output only. Auxiliary information for each of // the input_feature_column_specs, with respect to this particular // model. TablesModelColumnInfo []*XPSTablesModelColumnInfo `json:"tablesModelColumnInfo,omitempty"` // TrainCostMilliNodeHours: The actual training cost of the model, // expressed in milli node hours, i.e. 1,000 value in this field means 1 // node hour. Guaranteed to not exceed the train budget. TrainCostMilliNodeHours int64 `json:"trainCostMilliNodeHours,omitempty,string"` // ForceSendFields is a list of field names (e.g. "ModelStructure") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ModelStructure") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*XPSTablesTrainResponse) MarshalJSON ¶ added in v0.167.0
func (s *XPSTablesTrainResponse) MarshalJSON() ([]byte, error)
type XPSTablesTrainingOperationMetadata ¶ added in v0.167.0
type XPSTablesTrainingOperationMetadata struct { // CreateModelStage: Current stage of creating model. // // Possible values: // "CREATE_MODEL_STAGE_UNSPECIFIED" - Unspecified stage. // "DATA_PREPROCESSING" - Prepare the model training pipeline and run // data processing. // "TRAINING" - Training model. // "EVALUATING" - Run evaluation. // "MODEL_POST_PROCESSING" - Finalizing model training pipeline. CreateModelStage string `json:"createModelStage,omitempty"` // OptimizationObjective: The optimization objective for model. OptimizationObjective string `json:"optimizationObjective,omitempty"` // TopTrials: This field is for training. When the operation is // terminated successfully, AutoML Backend post this field to operation // metadata in spanner. If the metadata has no trials returned, the // training operation is supposed to be a failure. TopTrials []*XPSTuningTrial `json:"topTrials,omitempty"` // TrainBudgetMilliNodeHours: Creating model budget. TrainBudgetMilliNodeHours int64 `json:"trainBudgetMilliNodeHours,omitempty,string"` // TrainingObjectivePoints: This field records the training objective // value with respect to time, giving insight into how the model // architecture search is performing as training time elapses. TrainingObjectivePoints []*XPSTrainingObjectivePoint `json:"trainingObjectivePoints,omitempty"` // TrainingStartTime: Timestamp when training process starts. TrainingStartTime string `json:"trainingStartTime,omitempty"` // ForceSendFields is a list of field names (e.g. "CreateModelStage") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CreateModelStage") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*XPSTablesTrainingOperationMetadata) MarshalJSON ¶ added in v0.167.0
func (s *XPSTablesTrainingOperationMetadata) MarshalJSON() ([]byte, error)
type XPSTextComponentModel ¶ added in v0.167.0
type XPSTextComponentModel struct { // BatchPredictionModelGcsUri: The Cloud Storage resource path to hold // batch prediction model. BatchPredictionModelGcsUri string `json:"batchPredictionModelGcsUri,omitempty"` // OnlinePredictionModelGcsUri: The Cloud Storage resource path to hold // online prediction model. OnlinePredictionModelGcsUri string `json:"onlinePredictionModelGcsUri,omitempty"` // Partition: The partition where the model is deployed. Populated by // uCAIP BE as part of online PredictRequest. // // Possible values: // "PARTITION_TYPE_UNSPECIFIED" // "PARTITION_ZERO" - The default partition. // "PARTITION_REDUCED_HOMING" - It has significantly lower replication // than partition-0 and is located in the US only. It also has a larger // model size limit and higher default RAM quota than partition-0. // Customers with batch traffic, US-based traffic, or very large models // should use this partition. Capacity in this partition is // significantly cheaper than partition-0. // "PARTITION_JELLYFISH" - To be used by customers with // Jellyfish-accelerated ops. See go/servomatic-jellyfish for details. // "PARTITION_CPU" - The partition used by regionalized servomatic // cloud regions. // "PARTITION_CUSTOM_STORAGE_CPU" - The partition used for loading // models from custom storage. Partition string `json:"partition,omitempty"` // ServingArtifact: The default model binary file used for serving (e.g. // online predict, batch predict) via public Cloud Ai Platform API. ServingArtifact *XPSModelArtifactItem `json:"servingArtifact,omitempty"` // ServoModelName: The name of servo model. Populated by uCAIP BE as // part of online PredictRequest. ServoModelName string `json:"servoModelName,omitempty"` // SubmodelName: The name of the trained NL submodel. SubmodelName string `json:"submodelName,omitempty"` // SubmodelType: The type of trained NL submodel // // Possible values: // "TEXT_MODEL_TYPE_UNSPECIFIED" // "TEXT_MODEL_TYPE_DEFAULT" // "TEXT_MODEL_TYPE_META_ARCHITECT" // "TEXT_MODEL_TYPE_ATC" // "TEXT_MODEL_TYPE_CLARA2" // "TEXT_MODEL_TYPE_CHATBASE" // "TEXT_MODEL_TYPE_SAFT_SPAN_LABELING" // "TEXT_MODEL_TYPE_TEXT_EXTRACTION" - Model type for entity // extraction. // "TEXT_MODEL_TYPE_RELATIONSHIP_EXTRACTION" - Model type for // relationship extraction. // "TEXT_MODEL_TYPE_COMPOSITE" - A composite model represents a set of // component models that have to be used together for prediction. A // composite model appears to be a single model to the model user. It // may contain only one component model. Please refer to // go/cnl-composite-models for more information. // "TEXT_MODEL_TYPE_ALL_MODELS" - Model type used to train default, // MA, and ATC models in a single batch worker pipeline. // "TEXT_MODEL_TYPE_BERT" - BERT pipeline needs a specific model type, // since it uses a different TFX configuration compared with DEFAULT // (despite sharing most of the code). // "TEXT_MODEL_TYPE_ENC_PALM" - Model type for EncPaLM. SubmodelType string `json:"submodelType,omitempty"` // TfRuntimeVersion: ## The fields below are only populated under uCAIP // request scope. // https://cloud.google.com/ml-engine/docs/runtime-version-list TfRuntimeVersion string `json:"tfRuntimeVersion,omitempty"` // VersionNumber: The servomatic model version number. Populated by // uCAIP BE as part of online PredictRequest. VersionNumber int64 `json:"versionNumber,omitempty,string"` // ForceSendFields is a list of field names (e.g. // "BatchPredictionModelGcsUri") to unconditionally include in API // requests. By default, fields with empty or default values are omitted // from API requests. However, any non-pointer, non-interface field // appearing in ForceSendFields will be sent to the server regardless of // whether the field is empty or not. This may be used to include empty // fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. // "BatchPredictionModelGcsUri") to include in API requests with the // JSON null value. By default, fields with empty values are omitted // from API requests. However, any field with an empty value appearing // in NullFields will be sent to the server as null. It is an error if a // field in this list has a non-empty value. This may be used to include // null fields in Patch requests. NullFields []string `json:"-"` }
XPSTextComponentModel: Component model. Next ID: 10
func (*XPSTextComponentModel) MarshalJSON ¶ added in v0.167.0
func (s *XPSTextComponentModel) MarshalJSON() ([]byte, error)
type XPSTextExtractionEvaluationMetrics ¶ added in v0.167.0
type XPSTextExtractionEvaluationMetrics struct { // BestF1ConfidenceMetrics: Values are at the highest F1 score on the // precision-recall curve. Only confidence_threshold, recall, precision, // and f1_score will be set. BestF1ConfidenceMetrics *XPSConfidenceMetricsEntry `json:"bestF1ConfidenceMetrics,omitempty"` // ConfidenceMetricsEntries: If the enclosing EvaluationMetrics.label is // empty, confidence_metrics_entries is an evaluation of the entire // model across all labels. If the enclosing EvaluationMetrics.label is // set, confidence_metrics_entries applies to that label. ConfidenceMetricsEntries []*XPSConfidenceMetricsEntry `json:"confidenceMetricsEntries,omitempty"` // ConfusionMatrix: Confusion matrix of the model, at the default // confidence threshold (0.0). Only set for whole-model evaluation, not // for evaluation per label. ConfusionMatrix *XPSConfusionMatrix `json:"confusionMatrix,omitempty"` // PerLabelConfidenceMetrics: Only recall, precision, and f1_score will // be set. PerLabelConfidenceMetrics map[string]XPSConfidenceMetricsEntry `json:"perLabelConfidenceMetrics,omitempty"` // ForceSendFields is a list of field names (e.g. // "BestF1ConfidenceMetrics") to unconditionally include in API // requests. By default, fields with empty or default values are omitted // from API requests. However, any non-pointer, non-interface field // appearing in ForceSendFields will be sent to the server regardless of // whether the field is empty or not. This may be used to include empty // fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BestF1ConfidenceMetrics") // to include in API requests with the JSON null value. By default, // fields with empty values are omitted from API requests. However, any // field with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*XPSTextExtractionEvaluationMetrics) MarshalJSON ¶ added in v0.167.0
func (s *XPSTextExtractionEvaluationMetrics) MarshalJSON() ([]byte, error)
type XPSTextSentimentEvaluationMetrics ¶ added in v0.167.0
type XPSTextSentimentEvaluationMetrics struct { // ConfusionMatrix: Output only. Confusion matrix of the evaluation. // Only set for the overall model evaluation, not for evaluation of a // single annotation spec. ConfusionMatrix *XPSConfusionMatrix `json:"confusionMatrix,omitempty"` // F1Score: Output only. The harmonic mean of recall and precision. F1Score float64 `json:"f1Score,omitempty"` // LinearKappa: Output only. Linear weighted kappa. Only set for the // overall model evaluation, not for evaluation of a single annotation // spec. LinearKappa float64 `json:"linearKappa,omitempty"` // MeanAbsoluteError: Output only. Mean absolute error. Only set for the // overall model evaluation, not for evaluation of a single annotation // spec. MeanAbsoluteError float64 `json:"meanAbsoluteError,omitempty"` // MeanSquaredError: Output only. Mean squared error. Only set for the // overall model evaluation, not for evaluation of a single annotation // spec. MeanSquaredError float64 `json:"meanSquaredError,omitempty"` // Precision: Output only. Precision. Precision float64 `json:"precision,omitempty"` // QuadraticKappa: Output only. Quadratic weighted kappa. Only set for // the overall model evaluation, not for evaluation of a single // annotation spec. QuadraticKappa float64 `json:"quadraticKappa,omitempty"` // Recall: Output only. Recall. Recall float64 `json:"recall,omitempty"` // ForceSendFields is a list of field names (e.g. "ConfusionMatrix") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ConfusionMatrix") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSTextSentimentEvaluationMetrics: Model evaluation metrics for text sentiment problems.
func (*XPSTextSentimentEvaluationMetrics) MarshalJSON ¶ added in v0.167.0
func (s *XPSTextSentimentEvaluationMetrics) MarshalJSON() ([]byte, error)
func (*XPSTextSentimentEvaluationMetrics) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSTextSentimentEvaluationMetrics) UnmarshalJSON(data []byte) error
type XPSTextToSpeechTrainResponse ¶ added in v0.167.0
type XPSTextToSpeechTrainResponse struct { }
XPSTextToSpeechTrainResponse: TextToSpeech train response
type XPSTextTrainResponse ¶ added in v0.167.0
type XPSTextTrainResponse struct { // ComponentModel: Component submodels. ComponentModel []*XPSTextComponentModel `json:"componentModel,omitempty"` // ForceSendFields is a list of field names (e.g. "ComponentModel") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ComponentModel") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*XPSTextTrainResponse) MarshalJSON ¶ added in v0.167.0
func (s *XPSTextTrainResponse) MarshalJSON() ([]byte, error)
type XPSTfJsFormat ¶ added in v0.167.0
type XPSTfJsFormat struct { }
XPSTfJsFormat: A TensorFlow.js (https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript.
type XPSTfLiteFormat ¶ added in v0.167.0
type XPSTfLiteFormat struct { }
XPSTfLiteFormat: LINT.IfChange A model format used for mobile and IoT devices. See https://www.tensorflow.org/lite.
type XPSTfSavedModelFormat ¶ added in v0.167.0
type XPSTfSavedModelFormat struct { }
XPSTfSavedModelFormat: A tensorflow model format in SavedModel format.
type XPSTimestampStats ¶ added in v0.167.0
type XPSTimestampStats struct { CommonStats *XPSCommonStats `json:"commonStats,omitempty"` // GranularStats: The string key is the pre-defined granularity. // Currently supported: hour_of_day, day_of_week, month_of_year. // Granularities finer that the granularity of timestamp data are not // populated (e.g. if timestamps are at day granularity, then // hour_of_day is not populated). GranularStats map[string]XPSTimestampStatsGranularStats `json:"granularStats,omitempty"` MedianTimestampNanos int64 `json:"medianTimestampNanos,omitempty,string"` // ForceSendFields is a list of field names (e.g. "CommonStats") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CommonStats") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSTimestampStats: The data statistics of a series of TIMESTAMP values.
func (*XPSTimestampStats) MarshalJSON ¶ added in v0.167.0
func (s *XPSTimestampStats) MarshalJSON() ([]byte, error)
type XPSTimestampStatsGranularStats ¶ added in v0.167.0
type XPSTimestampStatsGranularStats struct { // Buckets: A map from granularity key to example count for that key. // E.g. for hour_of_day `13` means 1pm, or for month_of_year `5` means // May). Buckets map[string]string `json:"buckets,omitempty"` // ForceSendFields is a list of field names (e.g. "Buckets") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Buckets") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSTimestampStatsGranularStats: Stats split by a defined in context granularity.
func (*XPSTimestampStatsGranularStats) MarshalJSON ¶ added in v0.167.0
func (s *XPSTimestampStatsGranularStats) MarshalJSON() ([]byte, error)
type XPSTrackMetricsEntry ¶ added in v0.167.0
type XPSTrackMetricsEntry struct { // ConfidenceMetricsEntries: Output only. Metrics for each label-match // confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. // Precision-recall curve is derived from them. ConfidenceMetricsEntries []*XPSTrackMetricsEntryConfidenceMetricsEntry `json:"confidenceMetricsEntries,omitempty"` // IouThreshold: Output only. The intersection-over-union threshold // value between bounding boxes across frames used to compute this // metric entry. IouThreshold float64 `json:"iouThreshold,omitempty"` // MeanBoundingBoxIou: Output only. The mean bounding box iou over all // confidence thresholds. MeanBoundingBoxIou float64 `json:"meanBoundingBoxIou,omitempty"` // MeanMismatchRate: Output only. The mean mismatch rate over all // confidence thresholds. MeanMismatchRate float64 `json:"meanMismatchRate,omitempty"` // MeanTrackingAveragePrecision: Output only. The mean average precision // over all confidence thresholds. MeanTrackingAveragePrecision float64 `json:"meanTrackingAveragePrecision,omitempty"` // ForceSendFields is a list of field names (e.g. // "ConfidenceMetricsEntries") to unconditionally include in API // requests. By default, fields with empty or default values are omitted // from API requests. However, any non-pointer, non-interface field // appearing in ForceSendFields will be sent to the server regardless of // whether the field is empty or not. This may be used to include empty // fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ConfidenceMetricsEntries") // to include in API requests with the JSON null value. By default, // fields with empty values are omitted from API requests. However, any // field with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSTrackMetricsEntry: Track matching model metrics for a single track match threshold and multiple label match confidence thresholds. Next tag: 6.
func (*XPSTrackMetricsEntry) MarshalJSON ¶ added in v0.167.0
func (s *XPSTrackMetricsEntry) MarshalJSON() ([]byte, error)
func (*XPSTrackMetricsEntry) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSTrackMetricsEntry) UnmarshalJSON(data []byte) error
type XPSTrackMetricsEntryConfidenceMetricsEntry ¶ added in v0.167.0
type XPSTrackMetricsEntryConfidenceMetricsEntry struct { // BoundingBoxIou: Output only. Bounding box intersection-over-union // precision. Measures how well the bounding boxes overlap between each // other (e.g. complete overlap or just barely above iou_threshold). BoundingBoxIou float64 `json:"boundingBoxIou,omitempty"` // ConfidenceThreshold: Output only. The confidence threshold value used // to compute the metrics. ConfidenceThreshold float64 `json:"confidenceThreshold,omitempty"` // MismatchRate: Output only. Mismatch rate, which measures the tracking // consistency, i.e. correctness of instance ID continuity. MismatchRate float64 `json:"mismatchRate,omitempty"` // TrackingPrecision: Output only. Tracking precision. TrackingPrecision float64 `json:"trackingPrecision,omitempty"` // TrackingRecall: Output only. Tracking recall. TrackingRecall float64 `json:"trackingRecall,omitempty"` // ForceSendFields is a list of field names (e.g. "BoundingBoxIou") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BoundingBoxIou") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSTrackMetricsEntryConfidenceMetricsEntry: Metrics for a single confidence threshold. Next tag: 6.
func (*XPSTrackMetricsEntryConfidenceMetricsEntry) MarshalJSON ¶ added in v0.167.0
func (s *XPSTrackMetricsEntryConfidenceMetricsEntry) MarshalJSON() ([]byte, error)
func (*XPSTrackMetricsEntryConfidenceMetricsEntry) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSTrackMetricsEntryConfidenceMetricsEntry) UnmarshalJSON(data []byte) error
type XPSTrainResponse ¶ added in v0.167.0
type XPSTrainResponse struct { // DeployedModelSizeBytes: Estimated model size in bytes once deployed. DeployedModelSizeBytes int64 `json:"deployedModelSizeBytes,omitempty,string"` // ErrorAnalysisConfigs: Optional vision model error analysis // configuration. The field is set when model error analysis is enabled // in the training request. The results of error analysis will be binded // together with evaluation results (in the format of AnnotatedExample). ErrorAnalysisConfigs []*XPSVisionErrorAnalysisConfig `json:"errorAnalysisConfigs,omitempty"` // EvaluatedExampleSet: Examples used to evaluate the model (usually the // test set), with the predicted annotations. The file_spec should point // to recordio file(s) of AnnotatedExample. For each returned example, // the example_id_token and annotations predicted by the model must be // set. The example payload can and is recommended to be omitted. EvaluatedExampleSet *XPSExampleSet `json:"evaluatedExampleSet,omitempty"` // EvaluationMetricsSet: The trained model evaluation metrics. This can // be optionally returned. EvaluationMetricsSet *XPSEvaluationMetricsSet `json:"evaluationMetricsSet,omitempty"` // ExplanationConfigs: VisionExplanationConfig for XAI on test set. // Optional for when XAI is enable in training request. ExplanationConfigs []*XPSResponseExplanationSpec `json:"explanationConfigs,omitempty"` ImageClassificationTrainResp *XPSImageClassificationTrainResponse `json:"imageClassificationTrainResp,omitempty"` ImageObjectDetectionTrainResp *XPSImageObjectDetectionModelSpec `json:"imageObjectDetectionTrainResp,omitempty"` ImageSegmentationTrainResp *XPSImageSegmentationTrainResponse `json:"imageSegmentationTrainResp,omitempty"` // ModelToken: Token that represents the trained model. This is // considered immutable and is persisted in AutoML. xPS can put their // own proto in the byte string, to e.g. point to the model checkpoints. // The token is passed to other xPS APIs to refer to the model. ModelToken string `json:"modelToken,omitempty"` SpeechTrainResp *XPSSpeechModelSpec `json:"speechTrainResp,omitempty"` TablesTrainResp *XPSTablesTrainResponse `json:"tablesTrainResp,omitempty"` TextToSpeechTrainResp *XPSTextToSpeechTrainResponse `json:"textToSpeechTrainResp,omitempty"` // TextTrainResp: Will only be needed for uCAIP from Beta. TextTrainResp *XPSTextTrainResponse `json:"textTrainResp,omitempty"` TranslationTrainResp *XPSTranslationTrainResponse `json:"translationTrainResp,omitempty"` VideoActionRecognitionTrainResp *XPSVideoActionRecognitionTrainResponse `json:"videoActionRecognitionTrainResp,omitempty"` VideoClassificationTrainResp *XPSVideoClassificationTrainResponse `json:"videoClassificationTrainResp,omitempty"` VideoObjectTrackingTrainResp *XPSVideoObjectTrackingTrainResponse `json:"videoObjectTrackingTrainResp,omitempty"` // ForceSendFields is a list of field names (e.g. // "DeployedModelSizeBytes") to unconditionally include in API requests. // By default, fields with empty or default values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DeployedModelSizeBytes") // to include in API requests with the JSON null value. By default, // fields with empty values are omitted from API requests. However, any // field with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSTrainResponse: Next ID: 18
func (*XPSTrainResponse) MarshalJSON ¶ added in v0.167.0
func (s *XPSTrainResponse) MarshalJSON() ([]byte, error)
type XPSTrainingObjectivePoint ¶ added in v0.167.0
type XPSTrainingObjectivePoint struct { // CreateTime: The time at which this point was recorded. CreateTime string `json:"createTime,omitempty"` // Value: The objective value when this point was recorded. Value float64 `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "CreateTime") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CreateTime") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*XPSTrainingObjectivePoint) MarshalJSON ¶ added in v0.167.0
func (s *XPSTrainingObjectivePoint) MarshalJSON() ([]byte, error)
func (*XPSTrainingObjectivePoint) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSTrainingObjectivePoint) UnmarshalJSON(data []byte) error
type XPSTranslationEvaluationMetrics ¶ added in v0.167.0
type XPSTranslationEvaluationMetrics struct { // BaseBleuScore: BLEU score for base model. BaseBleuScore float64 `json:"baseBleuScore,omitempty"` // BleuScore: BLEU score. BleuScore float64 `json:"bleuScore,omitempty"` // ForceSendFields is a list of field names (e.g. "BaseBleuScore") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BaseBleuScore") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSTranslationEvaluationMetrics: Evaluation metrics for the dataset.
func (*XPSTranslationEvaluationMetrics) MarshalJSON ¶ added in v0.167.0
func (s *XPSTranslationEvaluationMetrics) MarshalJSON() ([]byte, error)
func (*XPSTranslationEvaluationMetrics) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSTranslationEvaluationMetrics) UnmarshalJSON(data []byte) error
type XPSTranslationPreprocessResponse ¶ added in v0.167.0
type XPSTranslationPreprocessResponse struct { // ParsedExampleCount: Total example count parsed. ParsedExampleCount int64 `json:"parsedExampleCount,omitempty,string"` // ValidExampleCount: Total valid example count. ValidExampleCount int64 `json:"validExampleCount,omitempty,string"` // ForceSendFields is a list of field names (e.g. "ParsedExampleCount") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ParsedExampleCount") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSTranslationPreprocessResponse: Translation preprocess response.
func (*XPSTranslationPreprocessResponse) MarshalJSON ¶ added in v0.167.0
func (s *XPSTranslationPreprocessResponse) MarshalJSON() ([]byte, error)
type XPSTranslationTrainResponse ¶ added in v0.167.0
type XPSTranslationTrainResponse struct { // ModelType: Type of the model. // // Possible values: // "MODEL_TYPE_UNSPECIFIED" - Default // "LEGACY" - Legacy model. Will be deprecated. // "CURRENT" - Current model. ModelType string `json:"modelType,omitempty"` // ForceSendFields is a list of field names (e.g. "ModelType") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ModelType") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSTranslationTrainResponse: Train response for translation.
func (*XPSTranslationTrainResponse) MarshalJSON ¶ added in v0.167.0
func (s *XPSTranslationTrainResponse) MarshalJSON() ([]byte, error)
type XPSTuningTrial ¶ added in v0.167.0
type XPSTuningTrial struct { // ModelStructure: Model parameters for the trial. ModelStructure *XPSTablesModelStructure `json:"modelStructure,omitempty"` // TrainingObjectivePoint: The optimization objective evaluation of the // eval split data. TrainingObjectivePoint *XPSTrainingObjectivePoint `json:"trainingObjectivePoint,omitempty"` // ForceSendFields is a list of field names (e.g. "ModelStructure") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ModelStructure") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSTuningTrial: Metrics for a tuning job generated, will get forwarded to Stackdriver as model tuning logs. Setting this as a standalone message out of CreateModelMetadata to avoid confusion as we expose this message only to users.
func (*XPSTuningTrial) MarshalJSON ¶ added in v0.167.0
func (s *XPSTuningTrial) MarshalJSON() ([]byte, error)
type XPSVideoActionMetricsEntry ¶ added in v0.167.0
type XPSVideoActionMetricsEntry struct { // ConfidenceMetricsEntries: Metrics for each label-match // confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. ConfidenceMetricsEntries []*XPSVideoActionMetricsEntryConfidenceMetricsEntry `json:"confidenceMetricsEntries,omitempty"` // MeanAveragePrecision: The mean average precision. MeanAveragePrecision float64 `json:"meanAveragePrecision,omitempty"` // PrecisionWindowLength: This VideoActionMetricsEntry is calculated // based on this prediction window length. If the predicted action's // timestamp is inside the time window whose center is the ground truth // action's timestamp with this specific length, the prediction result // is treated as a true positive. PrecisionWindowLength string `json:"precisionWindowLength,omitempty"` // ForceSendFields is a list of field names (e.g. // "ConfidenceMetricsEntries") to unconditionally include in API // requests. By default, fields with empty or default values are omitted // from API requests. However, any non-pointer, non-interface field // appearing in ForceSendFields will be sent to the server regardless of // whether the field is empty or not. This may be used to include empty // fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ConfidenceMetricsEntries") // to include in API requests with the JSON null value. By default, // fields with empty values are omitted from API requests. However, any // field with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSVideoActionMetricsEntry: The Evaluation metrics entry given a specific precision_window_length.
func (*XPSVideoActionMetricsEntry) MarshalJSON ¶ added in v0.167.0
func (s *XPSVideoActionMetricsEntry) MarshalJSON() ([]byte, error)
func (*XPSVideoActionMetricsEntry) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSVideoActionMetricsEntry) UnmarshalJSON(data []byte) error
type XPSVideoActionMetricsEntryConfidenceMetricsEntry ¶ added in v0.167.0
type XPSVideoActionMetricsEntryConfidenceMetricsEntry struct { // ConfidenceThreshold: Output only. The confidence threshold value used // to compute the metrics. ConfidenceThreshold float64 `json:"confidenceThreshold,omitempty"` // F1Score: Output only. The harmonic mean of recall and precision. F1Score float64 `json:"f1Score,omitempty"` // Precision: Output only. Precision for the given confidence threshold. Precision float64 `json:"precision,omitempty"` // Recall: Output only. Recall for the given confidence threshold. Recall float64 `json:"recall,omitempty"` // ForceSendFields is a list of field names (e.g. "ConfidenceThreshold") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ConfidenceThreshold") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSVideoActionMetricsEntryConfidenceMetricsEntry: Metrics for a single confidence threshold.
func (*XPSVideoActionMetricsEntryConfidenceMetricsEntry) MarshalJSON ¶ added in v0.167.0
func (s *XPSVideoActionMetricsEntryConfidenceMetricsEntry) MarshalJSON() ([]byte, error)
func (*XPSVideoActionMetricsEntryConfidenceMetricsEntry) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSVideoActionMetricsEntryConfidenceMetricsEntry) UnmarshalJSON(data []byte) error
type XPSVideoActionRecognitionEvaluationMetrics ¶ added in v0.167.0
type XPSVideoActionRecognitionEvaluationMetrics struct { // EvaluatedActionCount: Output only. The number of ground truth actions // used to create this evaluation. EvaluatedActionCount int64 `json:"evaluatedActionCount,omitempty"` // VideoActionMetricsEntries: Output only. The metric entries for // precision window lengths: 1s,2s,3s,4s, 5s. VideoActionMetricsEntries []*XPSVideoActionMetricsEntry `json:"videoActionMetricsEntries,omitempty"` // ForceSendFields is a list of field names (e.g. // "EvaluatedActionCount") to unconditionally include in API requests. // By default, fields with empty or default values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "EvaluatedActionCount") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSVideoActionRecognitionEvaluationMetrics: Model evaluation metrics for video action recognition.
func (*XPSVideoActionRecognitionEvaluationMetrics) MarshalJSON ¶ added in v0.167.0
func (s *XPSVideoActionRecognitionEvaluationMetrics) MarshalJSON() ([]byte, error)
type XPSVideoActionRecognitionTrainResponse ¶ added in v0.167.0
type XPSVideoActionRecognitionTrainResponse struct { // ModelArtifactSpec: ## The fields below are only populated under uCAIP // request scope. ModelArtifactSpec *XPSVideoModelArtifactSpec `json:"modelArtifactSpec,omitempty"` // TrainCostNodeSeconds: The actual train cost of creating this model, // expressed in node seconds, i.e. 3,600 value in this field means 1 // node hour. TrainCostNodeSeconds int64 `json:"trainCostNodeSeconds,omitempty,string"` // ForceSendFields is a list of field names (e.g. "ModelArtifactSpec") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ModelArtifactSpec") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*XPSVideoActionRecognitionTrainResponse) MarshalJSON ¶ added in v0.167.0
func (s *XPSVideoActionRecognitionTrainResponse) MarshalJSON() ([]byte, error)
type XPSVideoBatchPredictOperationMetadata ¶ added in v0.167.0
type XPSVideoBatchPredictOperationMetadata struct { // OutputExamples: All the partial batch prediction results that are // completed at the moment. Output examples are sorted by completion // time. The order will not be changed. Each output example should be // the path of a single RecordIO file of AnnotatedExamples. OutputExamples []string `json:"outputExamples,omitempty"` // ForceSendFields is a list of field names (e.g. "OutputExamples") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "OutputExamples") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*XPSVideoBatchPredictOperationMetadata) MarshalJSON ¶ added in v0.167.0
func (s *XPSVideoBatchPredictOperationMetadata) MarshalJSON() ([]byte, error)
type XPSVideoClassificationTrainResponse ¶ added in v0.167.0
type XPSVideoClassificationTrainResponse struct { // ModelArtifactSpec: ## The fields below are only populated under uCAIP // request scope. ModelArtifactSpec *XPSVideoModelArtifactSpec `json:"modelArtifactSpec,omitempty"` // TrainCostNodeSeconds: The actual train cost of creating this model, // expressed in node seconds, i.e. 3,600 value in this field means 1 // node hour. TrainCostNodeSeconds int64 `json:"trainCostNodeSeconds,omitempty,string"` // ForceSendFields is a list of field names (e.g. "ModelArtifactSpec") // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ModelArtifactSpec") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*XPSVideoClassificationTrainResponse) MarshalJSON ¶ added in v0.167.0
func (s *XPSVideoClassificationTrainResponse) MarshalJSON() ([]byte, error)
type XPSVideoExportModelSpec ¶ added in v0.167.0
type XPSVideoExportModelSpec struct { // ExportModelOutputConfig: Contains the model format and internal // location of the model files to be exported/downloaded. Use the GCS // bucket name which is provided via TrainRequest.gcs_bucket_name to // store the model files. ExportModelOutputConfig []*XPSExportModelOutputConfig `json:"exportModelOutputConfig,omitempty"` // ForceSendFields is a list of field names (e.g. // "ExportModelOutputConfig") to unconditionally include in API // requests. By default, fields with empty or default values are omitted // from API requests. However, any non-pointer, non-interface field // appearing in ForceSendFields will be sent to the server regardless of // whether the field is empty or not. This may be used to include empty // fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ExportModelOutputConfig") // to include in API requests with the JSON null value. By default, // fields with empty values are omitted from API requests. However, any // field with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSVideoExportModelSpec: Information of downloadable models that are pre-generated as part of training flow and will be persisted in AutoMl backend. Upon receiving ExportModel request from user, AutoMl backend can serve the pre-generated models to user if exists (by copying the files from internal path to user provided location), otherwise, AutoMl backend will call xPS ExportModel API to generate the model on the fly with the requesting format.
func (*XPSVideoExportModelSpec) MarshalJSON ¶ added in v0.167.0
func (s *XPSVideoExportModelSpec) MarshalJSON() ([]byte, error)
type XPSVideoModelArtifactSpec ¶ added in v0.167.0
type XPSVideoModelArtifactSpec struct { // ExportArtifact: The model binary files in different formats for model // export. ExportArtifact []*XPSModelArtifactItem `json:"exportArtifact,omitempty"` // ServingArtifact: The default model binary file used for serving (e.g. // batch predict) via public Cloud AI Platform API. ServingArtifact *XPSModelArtifactItem `json:"servingArtifact,omitempty"` // ForceSendFields is a list of field names (e.g. "ExportArtifact") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ExportArtifact") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*XPSVideoModelArtifactSpec) MarshalJSON ¶ added in v0.167.0
func (s *XPSVideoModelArtifactSpec) MarshalJSON() ([]byte, error)
type XPSVideoObjectTrackingEvaluationMetrics ¶ added in v0.167.0
type XPSVideoObjectTrackingEvaluationMetrics struct { // BoundingBoxMeanAveragePrecision: Output only. The single metric for // bounding boxes evaluation: the mean_average_precision averaged over // all bounding_box_metrics_entries. BoundingBoxMeanAveragePrecision float64 `json:"boundingBoxMeanAveragePrecision,omitempty"` // BoundingBoxMetricsEntries: Output only. The bounding boxes match // metrics for each Intersection-over-union threshold // 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. BoundingBoxMetricsEntries []*XPSBoundingBoxMetricsEntry `json:"boundingBoxMetricsEntries,omitempty"` // EvaluatedBoundingboxCount: The number of bounding boxes used for // model evaluation. EvaluatedBoundingboxCount int64 `json:"evaluatedBoundingboxCount,omitempty"` // EvaluatedFrameCount: The number of video frames used for model // evaluation. EvaluatedFrameCount int64 `json:"evaluatedFrameCount,omitempty"` // EvaluatedTrackCount: The number of tracks used for model evaluation. EvaluatedTrackCount int64 `json:"evaluatedTrackCount,omitempty"` // TrackMeanAveragePrecision: Output only. The single metric for tracks // accuracy evaluation: the mean_average_precision averaged over all // track_metrics_entries. TrackMeanAveragePrecision float64 `json:"trackMeanAveragePrecision,omitempty"` // TrackMeanBoundingBoxIou: Output only. The single metric for tracks // bounding box iou evaluation: the mean_bounding_box_iou averaged over // all track_metrics_entries. TrackMeanBoundingBoxIou float64 `json:"trackMeanBoundingBoxIou,omitempty"` // TrackMeanMismatchRate: Output only. The single metric for tracking // consistency evaluation: the mean_mismatch_rate averaged over all // track_metrics_entries. TrackMeanMismatchRate float64 `json:"trackMeanMismatchRate,omitempty"` // TrackMetricsEntries: Output only. The tracks match metrics for each // Intersection-over-union threshold // 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. TrackMetricsEntries []*XPSTrackMetricsEntry `json:"trackMetricsEntries,omitempty"` // ForceSendFields is a list of field names (e.g. // "BoundingBoxMeanAveragePrecision") to unconditionally include in API // requests. By default, fields with empty or default values are omitted // from API requests. However, any non-pointer, non-interface field // appearing in ForceSendFields will be sent to the server regardless of // whether the field is empty or not. This may be used to include empty // fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. // "BoundingBoxMeanAveragePrecision") to include in API requests with // the JSON null value. By default, fields with empty values are omitted // from API requests. However, any field with an empty value appearing // in NullFields will be sent to the server as null. It is an error if a // field in this list has a non-empty value. This may be used to include // null fields in Patch requests. NullFields []string `json:"-"` }
XPSVideoObjectTrackingEvaluationMetrics: Model evaluation metrics for ObjectTracking problems. Next tag: 10.
func (*XPSVideoObjectTrackingEvaluationMetrics) MarshalJSON ¶ added in v0.167.0
func (s *XPSVideoObjectTrackingEvaluationMetrics) MarshalJSON() ([]byte, error)
func (*XPSVideoObjectTrackingEvaluationMetrics) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSVideoObjectTrackingEvaluationMetrics) UnmarshalJSON(data []byte) error
type XPSVideoObjectTrackingTrainResponse ¶ added in v0.167.0
type XPSVideoObjectTrackingTrainResponse struct { // ExportModelSpec: Populated for AutoML request only. ExportModelSpec *XPSVideoExportModelSpec `json:"exportModelSpec,omitempty"` // ModelArtifactSpec: ## The fields below are only populated under uCAIP // request scope. ModelArtifactSpec *XPSVideoModelArtifactSpec `json:"modelArtifactSpec,omitempty"` // TrainCostNodeSeconds: The actual train cost of creating this model, // expressed in node seconds, i.e. 3,600 value in this field means 1 // node hour. TrainCostNodeSeconds int64 `json:"trainCostNodeSeconds,omitempty,string"` // ForceSendFields is a list of field names (e.g. "ExportModelSpec") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ExportModelSpec") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*XPSVideoObjectTrackingTrainResponse) MarshalJSON ¶ added in v0.167.0
func (s *XPSVideoObjectTrackingTrainResponse) MarshalJSON() ([]byte, error)
type XPSVideoTrainingOperationMetadata ¶ added in v0.167.0
type XPSVideoTrainingOperationMetadata struct { // TrainCostMilliNodeHour: This is an estimation of the node hours // necessary for training a model, expressed in milli node hours (i.e. // 1,000 value in this field means 1 node hour). A node hour represents // the time a virtual machine spends running your training job. The cost // of one node running for one hour is a node hour. TrainCostMilliNodeHour int64 `json:"trainCostMilliNodeHour,omitempty,string"` // ForceSendFields is a list of field names (e.g. // "TrainCostMilliNodeHour") to unconditionally include in API requests. // By default, fields with empty or default values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "TrainCostMilliNodeHour") // to include in API requests with the JSON null value. By default, // fields with empty values are omitted from API requests. However, any // field with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*XPSVideoTrainingOperationMetadata) MarshalJSON ¶ added in v0.167.0
func (s *XPSVideoTrainingOperationMetadata) MarshalJSON() ([]byte, error)
type XPSVisionErrorAnalysisConfig ¶ added in v0.167.0
type XPSVisionErrorAnalysisConfig struct { // ExampleCount: The number of query examples in error analysis. ExampleCount int64 `json:"exampleCount,omitempty"` // QueryType: The query type used in retrieval. The enum values are // frozen in the foreseeable future. // // Possible values: // "QUERY_TYPE_UNSPECIFIED" - Unspecified query type for model error // analysis. // "QUERY_TYPE_ALL_SIMILAR" - Query similar samples across all classes // in the dataset. // "QUERY_TYPE_SAME_CLASS_SIMILAR" - Query similar samples from the // same class of the input sample. // "QUERY_TYPE_SAME_CLASS_DISSIMILAR" - Query dissimilar samples from // the same class of the input sample. QueryType string `json:"queryType,omitempty"` // ForceSendFields is a list of field names (e.g. "ExampleCount") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ExampleCount") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSVisionErrorAnalysisConfig: The vision model error analysis configuration. Next tag: 3
func (*XPSVisionErrorAnalysisConfig) MarshalJSON ¶ added in v0.167.0
func (s *XPSVisionErrorAnalysisConfig) MarshalJSON() ([]byte, error)
type XPSVisionTrainingOperationMetadata ¶ added in v0.167.0
type XPSVisionTrainingOperationMetadata struct { // ExplanationUsage: Aggregated infra usage within certain time period, // for billing report purpose if XAI is enable in training request. ExplanationUsage *InfraUsage `json:"explanationUsage,omitempty"` // ForceSendFields is a list of field names (e.g. "ExplanationUsage") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ExplanationUsage") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*XPSVisionTrainingOperationMetadata) MarshalJSON ¶ added in v0.167.0
func (s *XPSVisionTrainingOperationMetadata) MarshalJSON() ([]byte, error)
type XPSVisualization ¶ added in v0.167.0
type XPSVisualization struct { // ClipPercentLowerbound: Excludes attributions below the specified // percentile, from the highlighted areas. Defaults to 62. ClipPercentLowerbound float64 `json:"clipPercentLowerbound,omitempty"` // ClipPercentUpperbound: Excludes attributions above the specified // percentile from the highlighted areas. Using the // clip_percent_upperbound and clip_percent_lowerbound together can be // useful for filtering out noise and making it easier to see areas of // strong attribution. Defaults to 99.9. ClipPercentUpperbound float64 `json:"clipPercentUpperbound,omitempty"` // ColorMap: The color scheme used for the highlighted areas. Defaults // to PINK_GREEN for Integrated Gradients attribution, which shows // positive attributions in green and negative in pink. Defaults to // VIRIDIS for XRAI attribution, which highlights the most influential // regions in yellow and the least influential in blue. // // Possible values: // "COLOR_MAP_UNSPECIFIED" - Should not be used. // "PINK_GREEN" - Positive: green. Negative: pink. // "VIRIDIS" - Viridis color map: A perceptually uniform color mapping // which is easier to see by those with colorblindness and progresses // from yellow to green to blue. Positive: yellow. Negative: blue. // "RED" - Positive: red. Negative: red. // "GREEN" - Positive: green. Negative: green. // "RED_GREEN" - Positive: green. Negative: red. // "PINK_WHITE_GREEN" - PiYG palette. ColorMap string `json:"colorMap,omitempty"` // OverlayType: How the original image is displayed in the // visualization. Adjusting the overlay can help increase visual clarity // if the original image makes it difficult to view the visualization. // Defaults to NONE. // // Possible values: // "OVERLAY_TYPE_UNSPECIFIED" - Default value. This is the same as // NONE. // "NONE" - No overlay. // "ORIGINAL" - The attributions are shown on top of the original // image. // "GRAYSCALE" - The attributions are shown on top of grayscaled // version of the original image. // "MASK_BLACK" - The attributions are used as a mask to reveal // predictive parts of the image and hide the un-predictive parts. OverlayType string `json:"overlayType,omitempty"` // Polarity: Whether to only highlight pixels with positive // contributions, negative or both. Defaults to POSITIVE. // // Possible values: // "POLARITY_UNSPECIFIED" - Default value. This is the same as // POSITIVE. // "POSITIVE" - Highlights the pixels/outlines that were most // influential to the model's prediction. // "NEGATIVE" - Setting polarity to negative highlights areas that // does not lead to the models's current prediction. // "BOTH" - Shows both positive and negative attributions. Polarity string `json:"polarity,omitempty"` // Type: Type of the image visualization. Only applicable to Integrated // Gradients attribution. OUTLINES shows regions of attribution, while // PIXELS shows per-pixel attribution. Defaults to OUTLINES. // // Possible values: // "TYPE_UNSPECIFIED" - Should not be used. // "PIXELS" - Shows which pixel contributed to the image prediction. // "OUTLINES" - Shows which region contributed to the image prediction // by outlining the region. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. // "ClipPercentLowerbound") to unconditionally include in API requests. // By default, fields with empty or default values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ClipPercentLowerbound") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
XPSVisualization: Visualization configurations for image explanation.
func (*XPSVisualization) MarshalJSON ¶ added in v0.167.0
func (s *XPSVisualization) MarshalJSON() ([]byte, error)
func (*XPSVisualization) UnmarshalJSON ¶ added in v0.167.0
func (s *XPSVisualization) UnmarshalJSON(data []byte) error
type XPSXpsOperationMetadata ¶ added in v0.167.0
type XPSXpsOperationMetadata struct { // ExampleCount: Optional. XPS server can opt to provide example count // of the long running operation (e.g. training, data importing, batch // prediction). ExampleCount int64 `json:"exampleCount,omitempty,string"` // ReportingMetrics: Metrics for the operation. By the time the // operation is terminated (whether succeeded or failed) as returned // from XPS, AutoML BE assumes the metrics are finalized. AutoML BE // transparently posts the metrics to Chemist if it's not empty, // regardless of the response content or error type. If user is supposed // to be charged in case of cancellation/error, this field should be // set. In the case where the type of LRO doesn't require any billing, // this field should be left unset. ReportingMetrics *XPSReportingMetrics `json:"reportingMetrics,omitempty"` TablesTrainingOperationMetadata *XPSTablesTrainingOperationMetadata `json:"tablesTrainingOperationMetadata,omitempty"` VideoBatchPredictOperationMetadata *XPSVideoBatchPredictOperationMetadata `json:"videoBatchPredictOperationMetadata,omitempty"` VideoTrainingOperationMetadata *XPSVideoTrainingOperationMetadata `json:"videoTrainingOperationMetadata,omitempty"` VisionTrainingOperationMetadata *XPSVisionTrainingOperationMetadata `json:"visionTrainingOperationMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "ExampleCount") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ExampleCount") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*XPSXpsOperationMetadata) MarshalJSON ¶ added in v0.167.0
func (s *XPSXpsOperationMetadata) MarshalJSON() ([]byte, error)
type XPSXraiAttribution ¶ added in v0.167.0
type XPSXraiAttribution struct { // StepCount: The number of steps for approximating the path integral. A // good value to start is 50 and gradually increase until the sum to // diff property is met within the desired error range. Valid range of // its value is [1, 100], inclusively. StepCount int64 `json:"stepCount,omitempty"` // ForceSendFields is a list of field names (e.g. "StepCount") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "StepCount") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
XPSXraiAttribution: An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Only supports image Models (modality is IMAGE).
func (*XPSXraiAttribution) MarshalJSON ¶ added in v0.167.0
func (s *XPSXraiAttribution) MarshalJSON() ([]byte, error)