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

package prediction

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

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.2"
...
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 *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 []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:"-"`
}

func (*InputInput) MarshalJSON Uses

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

type Output Uses

type Output struct {
    Id  string `json:"id,omitempty"`

    Kind string `json:"kind,omitempty"`

    OutputLabel string `json:"outputLabel,omitempty"`

    OutputMulti []*OutputOutputMulti `json:"outputMulti,omitempty"`

    OutputValue float64 `json:"outputValue,omitempty"`

    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 string `json:"label,omitempty"`

    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 PredictCall Uses

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

func (*PredictCall) Context Uses

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

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

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

Do executes the "prediction.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 (*PredictCall) Fields Uses

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

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

func (*PredictCall) Header Uses

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

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

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.

func (*Service) Predict Uses

func (s *Service) Predict(data string, input *Input) *PredictCall

Predict: Submit data and request a prediction

type Training Uses

type Training struct {
    Id  string `json:"id,omitempty"`

    Kind string `json:"kind,omitempty"`

    ModelInfo *TrainingModelInfo `json:"modelInfo,omitempty"`

    SelfLink string `json:"selfLink,omitempty"`

    TrainingStatus string `json:"trainingStatus,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) Data Uses

func (c *TrainingInsertCall) Data(data string) *TrainingInsertCall

Data sets the optional parameter "data": mybucket/mydata resource in Google Storage

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 {
    ClassificationAccuracy float64 `json:"classificationAccuracy,omitempty"`

    MeanSquaredError float64 `json:"meanSquaredError,omitempty"`

    ModelType string `json:"modelType,omitempty"`

    // ForceSendFields is a list of field names (e.g.
    // "ClassificationAccuracy") 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. "ClassificationAccuracy")
    // 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 (*TrainingModelInfo) MarshalJSON Uses

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

func (*TrainingModelInfo) UnmarshalJSON Uses

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

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) 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-15. Refresh now. Tools for package owners.