api: google.golang.org/api/prediction/v1.3 Index | Files

package prediction

import "google.golang.org/api/prediction/v1.3"

Package prediction provides access to the Prediction API.

For product documentation, see: https://developers.google.com/prediction/docs/developer-guide

Creating a client

Usage example:

import "google.golang.org/api/prediction/v1.3"
...
ctx := context.Background()
predictionService, err := prediction.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 option.WithScopes:

predictionService, err := prediction.NewService(ctx, option.WithScopes(prediction.PredictionScope))

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:

predictionService, err := prediction.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
predictionService, err := prediction.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Package Files

prediction-gen.go

Constants

const (
    // Manage your data and permissions in Google Cloud Storage
    DevstorageFullControlScope = "https://www.googleapis.com/auth/devstorage.full_control"

    // View your data in Google Cloud Storage
    DevstorageReadOnlyScope = "https://www.googleapis.com/auth/devstorage.read_only"

    // Manage your data in Google Cloud Storage
    DevstorageReadWriteScope = "https://www.googleapis.com/auth/devstorage.read_write"

    // Manage your data in the Google Prediction API
    PredictionScope = "https://www.googleapis.com/auth/prediction"
)

OAuth2 scopes used by this API.

type HostedmodelsPredictCall Uses

type HostedmodelsPredictCall struct {
    // contains filtered or unexported fields
}

func (*HostedmodelsPredictCall) Context Uses

func (c *HostedmodelsPredictCall) Context(ctx context.Context) *HostedmodelsPredictCall

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 (*HostedmodelsPredictCall) Do Uses

func (c *HostedmodelsPredictCall) Do(opts ...googleapi.CallOption) (*Output, error)

Do executes the "prediction.hostedmodels.predict" call. Exactly one of *Output or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Output.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 (*HostedmodelsPredictCall) Fields Uses

func (c *HostedmodelsPredictCall) Fields(s ...googleapi.Field) *HostedmodelsPredictCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*HostedmodelsPredictCall) Header Uses

func (c *HostedmodelsPredictCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type HostedmodelsService Uses

type HostedmodelsService struct {
    // contains filtered or unexported fields
}

func NewHostedmodelsService Uses

func NewHostedmodelsService(s *Service) *HostedmodelsService

func (*HostedmodelsService) Predict Uses

func (r *HostedmodelsService) Predict(hostedModelName string, input *Input) *HostedmodelsPredictCall

Predict: Submit input and request an output against a hosted model

type Input Uses

type Input struct {
    // Input: Input to the model for a prediction
    Input *InputInput `json:"input,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Input") to
    // unconditionally include in API requests. By default, fields with
    // empty 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. "Input") 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 (*Input) MarshalJSON Uses

func (s *Input) MarshalJSON() ([]byte, error)

type InputInput Uses

type InputInput struct {
    // CsvInstance: A list of input features, these can be strings or
    // doubles.
    CsvInstance []interface{} `json:"csvInstance,omitempty"`

    // ForceSendFields is a list of field names (e.g. "CsvInstance") to
    // unconditionally include in API requests. By default, fields with
    // empty 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. "CsvInstance") 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:"-"`
}

InputInput: Input to the model for a prediction

func (*InputInput) MarshalJSON Uses

func (s *InputInput) MarshalJSON() ([]byte, error)

type Output Uses

type Output struct {
    // Id: The unique name for the predictive model.
    Id  string `json:"id,omitempty"`

    // Kind: What kind of resource this is.
    Kind string `json:"kind,omitempty"`

    // OutputLabel: The most likely class [Categorical models only].
    OutputLabel string `json:"outputLabel,omitempty"`

    // OutputMulti: A list of classes with their estimated probabilities
    // [Categorical models only].
    OutputMulti []*OutputOutputMulti `json:"outputMulti,omitempty"`

    // OutputValue: The estimated regression value [Regression models only].
    OutputValue float64 `json:"outputValue,omitempty"`

    // SelfLink: A URL to re-request this resource.
    SelfLink string `json:"selfLink,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Id") to
    // unconditionally include in API requests. By default, fields with
    // empty 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. "Id") 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 (*Output) MarshalJSON Uses

func (s *Output) MarshalJSON() ([]byte, error)

func (*Output) UnmarshalJSON Uses

func (s *Output) UnmarshalJSON(data []byte) error

type OutputOutputMulti Uses

type OutputOutputMulti struct {
    // Label: The class label.
    Label string `json:"label,omitempty"`

    // Score: The probability of the class.
    Score float64 `json:"score,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Label") to
    // unconditionally include in API requests. By default, fields with
    // empty 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. "Label") 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 (*OutputOutputMulti) MarshalJSON Uses

func (s *OutputOutputMulti) MarshalJSON() ([]byte, error)

func (*OutputOutputMulti) UnmarshalJSON Uses

func (s *OutputOutputMulti) UnmarshalJSON(data []byte) error

type Service Uses

type Service struct {
    BasePath  string // API endpoint base URL
    UserAgent string // optional additional User-Agent fragment

    Hostedmodels *HostedmodelsService

    Training *TrainingService
    // contains filtered or unexported fields
}

func New Uses

func New(client *http.Client) (*Service, error)

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 Uses

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type Training Uses

type Training struct {
    // Id: The unique name for the predictive model.
    Id  string `json:"id,omitempty"`

    // Kind: What kind of resource this is.
    Kind string `json:"kind,omitempty"`

    // ModelInfo: Model metadata.
    ModelInfo *TrainingModelInfo `json:"modelInfo,omitempty"`

    // SelfLink: A URL to re-request this resource.
    SelfLink string `json:"selfLink,omitempty"`

    // TrainingStatus: The current status of the training job. This can be
    // one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
    TrainingStatus string `json:"trainingStatus,omitempty"`

    // Utility: A class weighting function, which allows the importance
    // weights for classes to be specified [Categorical models only].
    Utility []map[string]float64 `json:"utility,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Id") to
    // unconditionally include in API requests. By default, fields with
    // empty 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. "Id") 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 (*Training) MarshalJSON Uses

func (s *Training) MarshalJSON() ([]byte, error)

type TrainingDeleteCall Uses

type TrainingDeleteCall struct {
    // contains filtered or unexported fields
}

func (*TrainingDeleteCall) Context Uses

func (c *TrainingDeleteCall) Context(ctx context.Context) *TrainingDeleteCall

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 (*TrainingDeleteCall) Do Uses

func (c *TrainingDeleteCall) Do(opts ...googleapi.CallOption) error

Do executes the "prediction.training.delete" call.

func (*TrainingDeleteCall) Fields Uses

func (c *TrainingDeleteCall) Fields(s ...googleapi.Field) *TrainingDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*TrainingDeleteCall) Header Uses

func (c *TrainingDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type TrainingGetCall Uses

type TrainingGetCall struct {
    // contains filtered or unexported fields
}

func (*TrainingGetCall) Context Uses

func (c *TrainingGetCall) Context(ctx context.Context) *TrainingGetCall

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 (*TrainingGetCall) Do Uses

func (c *TrainingGetCall) Do(opts ...googleapi.CallOption) (*Training, error)

Do executes the "prediction.training.get" call. Exactly one of *Training or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Training.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 (*TrainingGetCall) Fields Uses

func (c *TrainingGetCall) Fields(s ...googleapi.Field) *TrainingGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*TrainingGetCall) Header Uses

func (c *TrainingGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*TrainingGetCall) IfNoneMatch Uses

func (c *TrainingGetCall) IfNoneMatch(entityTag string) *TrainingGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type TrainingInsertCall Uses

type TrainingInsertCall struct {
    // contains filtered or unexported fields
}

func (*TrainingInsertCall) Context Uses

func (c *TrainingInsertCall) Context(ctx context.Context) *TrainingInsertCall

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 (*TrainingInsertCall) Do Uses

func (c *TrainingInsertCall) Do(opts ...googleapi.CallOption) (*Training, error)

Do executes the "prediction.training.insert" call. Exactly one of *Training or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Training.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 (*TrainingInsertCall) Fields Uses

func (c *TrainingInsertCall) Fields(s ...googleapi.Field) *TrainingInsertCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*TrainingInsertCall) Header Uses

func (c *TrainingInsertCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type TrainingModelInfo Uses

type TrainingModelInfo struct {
    // ClassWeightedAccuracy: Estimated accuracy of model taking utility
    // weights into account [Categorical models only].
    ClassWeightedAccuracy float64 `json:"classWeightedAccuracy,omitempty"`

    // ClassificationAccuracy: A number between 0.0 and 1.0, where 1.0 is
    // 100% accurate. This is an estimate, based on the amount and quality
    // of the training data, of the estimated prediction accuracy. You can
    // use this is a guide to decide whether the results are accurate enough
    // for your needs. This estimate will be more reliable if your real
    // input data is similar to your training data [Categorical models
    // only].
    ClassificationAccuracy float64 `json:"classificationAccuracy,omitempty"`

    // ConfusionMatrix: An output confusion matrix. This shows an estimate
    // for how this model will do in predictions. This is first indexed by
    // the true class label. For each true class label, this provides a pair
    // {predicted_label, count}, where count is the estimated number of
    // times the model will predict the predicted label given the true
    // label. Will not output if more then 100 classes [Categorical models
    // only].
    ConfusionMatrix map[string]map[string]float64 `json:"confusionMatrix,omitempty"`

    // ConfusionMatrixRowTotals: A list of the confusion matrix row totals
    ConfusionMatrixRowTotals map[string]float64 `json:"confusionMatrixRowTotals,omitempty"`

    // MeanSquaredError: An estimated mean squared error. The can be used to
    // measure the quality of the predicted model [Regression models only].
    MeanSquaredError float64 `json:"meanSquaredError,omitempty"`

    // ModelType: Type of predictive model (CLASSIFICATION or REGRESSION)
    ModelType string `json:"modelType,omitempty"`

    // NumberClasses: Number of classes in the trained model [Categorical
    // models only].
    NumberClasses int64 `json:"numberClasses,omitempty,string"`

    // NumberInstances: Number of valid data instances used in the trained
    // model.
    NumberInstances int64 `json:"numberInstances,omitempty,string"`

    // ForceSendFields is a list of field names (e.g.
    // "ClassWeightedAccuracy") to unconditionally include in API requests.
    // By default, fields with empty 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. "ClassWeightedAccuracy") 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:"-"`
}

TrainingModelInfo: Model metadata.

func (*TrainingModelInfo) MarshalJSON Uses

func (s *TrainingModelInfo) MarshalJSON() ([]byte, error)

func (*TrainingModelInfo) UnmarshalJSON Uses

func (s *TrainingModelInfo) UnmarshalJSON(data []byte) error

type TrainingPredictCall Uses

type TrainingPredictCall struct {
    // contains filtered or unexported fields
}

func (*TrainingPredictCall) Context Uses

func (c *TrainingPredictCall) Context(ctx context.Context) *TrainingPredictCall

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 (*TrainingPredictCall) Do Uses

func (c *TrainingPredictCall) Do(opts ...googleapi.CallOption) (*Output, error)

Do executes the "prediction.training.predict" call. Exactly one of *Output or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Output.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 (*TrainingPredictCall) Fields Uses

func (c *TrainingPredictCall) Fields(s ...googleapi.Field) *TrainingPredictCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*TrainingPredictCall) Header Uses

func (c *TrainingPredictCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type TrainingService Uses

type TrainingService struct {
    // contains filtered or unexported fields
}

func NewTrainingService Uses

func NewTrainingService(s *Service) *TrainingService

func (*TrainingService) Delete Uses

func (r *TrainingService) Delete(data string) *TrainingDeleteCall

Delete: Delete a trained model

func (*TrainingService) Get Uses

func (r *TrainingService) Get(data string) *TrainingGetCall

Get: Check training status of your model

func (*TrainingService) Insert Uses

func (r *TrainingService) Insert(training *Training) *TrainingInsertCall

Insert: Begin training your model

func (*TrainingService) Predict Uses

func (r *TrainingService) Predict(data string, input *Input) *TrainingPredictCall

Predict: Submit data and request a prediction

func (*TrainingService) Update Uses

func (r *TrainingService) Update(data string, update *Update) *TrainingUpdateCall

Update: Add new data to a trained model

type TrainingUpdateCall Uses

type TrainingUpdateCall struct {
    // contains filtered or unexported fields
}

func (*TrainingUpdateCall) Context Uses

func (c *TrainingUpdateCall) Context(ctx context.Context) *TrainingUpdateCall

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 (*TrainingUpdateCall) Do Uses

func (c *TrainingUpdateCall) Do(opts ...googleapi.CallOption) (*Training, error)

Do executes the "prediction.training.update" call. Exactly one of *Training or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Training.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 (*TrainingUpdateCall) Fields Uses

func (c *TrainingUpdateCall) Fields(s ...googleapi.Field) *TrainingUpdateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*TrainingUpdateCall) Header Uses

func (c *TrainingUpdateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type Update Uses

type Update struct {
    // ClassLabel: The true class label of this instance
    ClassLabel string `json:"classLabel,omitempty"`

    // CsvInstance: The input features for this instance
    CsvInstance []interface{} `json:"csvInstance,omitempty"`

    // ForceSendFields is a list of field names (e.g. "ClassLabel") to
    // unconditionally include in API requests. By default, fields with
    // empty 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. "ClassLabel") 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 (*Update) MarshalJSON Uses

func (s *Update) MarshalJSON() ([]byte, error)

Package prediction imports 14 packages (graph). Updated 2019-07-13. Refresh now. Tools for package owners.