func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
BaseClient is the base client for Training.
type BaseClient struct {
autorest.Client
APIKey string
Endpoint string
}
func New(aPIKey string, endpoint string) BaseClient
New creates an instance of the BaseClient client.
func NewWithoutDefaults(aPIKey string, endpoint string) BaseClient
NewWithoutDefaults creates an instance of the BaseClient client.
func (client BaseClient) CreateImageRegions(ctx context.Context, projectID uuid.UUID, batch ImageRegionCreateBatch) (result ImageRegionCreateSummary, err error)
CreateImageRegions this API accepts a batch of image regions, and optionally tags, to update existing images with region information. There is a limit of 64 entries in the batch. Parameters: projectID - the project id. batch - batch of image regions which include a tag and bounding box. Limited to 64.
func (client BaseClient) CreateImageRegionsPreparer(ctx context.Context, projectID uuid.UUID, batch ImageRegionCreateBatch) (*http.Request, error)
CreateImageRegionsPreparer prepares the CreateImageRegions request.
func (client BaseClient) CreateImageRegionsResponder(resp *http.Response) (result ImageRegionCreateSummary, err error)
CreateImageRegionsResponder handles the response to the CreateImageRegions request. The method always closes the http.Response Body.
func (client BaseClient) CreateImageRegionsSender(req *http.Request) (*http.Response, error)
CreateImageRegionsSender sends the CreateImageRegions request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) CreateImageTags(ctx context.Context, projectID uuid.UUID, batch ImageTagCreateBatch) (result ImageTagCreateSummary, err error)
CreateImageTags sends the create image tags request. Parameters: projectID - the project id. batch - batch of image tags. Limited to 128 tags per batch.
func (client BaseClient) CreateImageTagsPreparer(ctx context.Context, projectID uuid.UUID, batch ImageTagCreateBatch) (*http.Request, error)
CreateImageTagsPreparer prepares the CreateImageTags request.
func (client BaseClient) CreateImageTagsResponder(resp *http.Response) (result ImageTagCreateSummary, err error)
CreateImageTagsResponder handles the response to the CreateImageTags request. The method always closes the http.Response Body.
func (client BaseClient) CreateImageTagsSender(req *http.Request) (*http.Response, error)
CreateImageTagsSender sends the CreateImageTags request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) CreateImagesFromData(ctx context.Context, projectID uuid.UUID, imageData io.ReadCloser, tagIds []string) (result ImageCreateSummary, err error)
CreateImagesFromData this API accepts body content as multipart/form-data and application/octet-stream. When using multipart multiple image files can be sent at once, with a maximum of 64 files Parameters: projectID - the project id. imageData - binary image data. tagIds - the tags ids with which to tag each image. Limited to 20.
func (client BaseClient) CreateImagesFromDataPreparer(ctx context.Context, projectID uuid.UUID, imageData io.ReadCloser, tagIds []string) (*http.Request, error)
CreateImagesFromDataPreparer prepares the CreateImagesFromData request.
func (client BaseClient) CreateImagesFromDataResponder(resp *http.Response) (result ImageCreateSummary, err error)
CreateImagesFromDataResponder handles the response to the CreateImagesFromData request. The method always closes the http.Response Body.
func (client BaseClient) CreateImagesFromDataSender(req *http.Request) (*http.Response, error)
CreateImagesFromDataSender sends the CreateImagesFromData request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) CreateImagesFromFiles(ctx context.Context, projectID uuid.UUID, batch ImageFileCreateBatch) (result ImageCreateSummary, err error)
CreateImagesFromFiles this API accepts a batch of files, and optionally tags, to create images. There is a limit of 64 images and 20 tags. Parameters: projectID - the project id. batch - the batch of image files to add. Limited to 64 images and 20 tags per batch.
func (client BaseClient) CreateImagesFromFilesPreparer(ctx context.Context, projectID uuid.UUID, batch ImageFileCreateBatch) (*http.Request, error)
CreateImagesFromFilesPreparer prepares the CreateImagesFromFiles request.
func (client BaseClient) CreateImagesFromFilesResponder(resp *http.Response) (result ImageCreateSummary, err error)
CreateImagesFromFilesResponder handles the response to the CreateImagesFromFiles request. The method always closes the http.Response Body.
func (client BaseClient) CreateImagesFromFilesSender(req *http.Request) (*http.Response, error)
CreateImagesFromFilesSender sends the CreateImagesFromFiles request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) CreateImagesFromPredictions(ctx context.Context, projectID uuid.UUID, batch ImageIDCreateBatch) (result ImageCreateSummary, err error)
CreateImagesFromPredictions this API creates a batch of images from predicted images specified. There is a limit of 64 images and 20 tags. Parameters: projectID - the project id. batch - image and tag ids. Limited to 64 images and 20 tags per batch.
func (client BaseClient) CreateImagesFromPredictionsPreparer(ctx context.Context, projectID uuid.UUID, batch ImageIDCreateBatch) (*http.Request, error)
CreateImagesFromPredictionsPreparer prepares the CreateImagesFromPredictions request.
func (client BaseClient) CreateImagesFromPredictionsResponder(resp *http.Response) (result ImageCreateSummary, err error)
CreateImagesFromPredictionsResponder handles the response to the CreateImagesFromPredictions request. The method always closes the http.Response Body.
func (client BaseClient) CreateImagesFromPredictionsSender(req *http.Request) (*http.Response, error)
CreateImagesFromPredictionsSender sends the CreateImagesFromPredictions request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) CreateImagesFromUrls(ctx context.Context, projectID uuid.UUID, batch ImageURLCreateBatch) (result ImageCreateSummary, err error)
CreateImagesFromUrls this API accepts a batch of urls, and optionally tags, to create images. There is a limit of 64 images and 20 tags. Parameters: projectID - the project id. batch - image urls and tag ids. Limited to 64 images and 20 tags per batch.
func (client BaseClient) CreateImagesFromUrlsPreparer(ctx context.Context, projectID uuid.UUID, batch ImageURLCreateBatch) (*http.Request, error)
CreateImagesFromUrlsPreparer prepares the CreateImagesFromUrls request.
func (client BaseClient) CreateImagesFromUrlsResponder(resp *http.Response) (result ImageCreateSummary, err error)
CreateImagesFromUrlsResponder handles the response to the CreateImagesFromUrls request. The method always closes the http.Response Body.
func (client BaseClient) CreateImagesFromUrlsSender(req *http.Request) (*http.Response, error)
CreateImagesFromUrlsSender sends the CreateImagesFromUrls request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) CreateProject(ctx context.Context, name string, description string, domainID *uuid.UUID, classificationType string) (result Project, err error)
CreateProject sends the create project request. Parameters: name - name of the project. description - the description of the project. domainID - the id of the domain to use for this project. Defaults to General. classificationType - the type of classifier to create for this project.
func (client BaseClient) CreateProjectPreparer(ctx context.Context, name string, description string, domainID *uuid.UUID, classificationType string) (*http.Request, error)
CreateProjectPreparer prepares the CreateProject request.
func (client BaseClient) CreateProjectResponder(resp *http.Response) (result Project, err error)
CreateProjectResponder handles the response to the CreateProject request. The method always closes the http.Response Body.
func (client BaseClient) CreateProjectSender(req *http.Request) (*http.Response, error)
CreateProjectSender sends the CreateProject request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) CreateTag(ctx context.Context, projectID uuid.UUID, name string, description string, typeParameter string) (result Tag, err error)
CreateTag sends the create tag request. Parameters: projectID - the project id. name - the tag name. description - optional description for the tag. typeParameter - optional type for the tag.
func (client BaseClient) CreateTagPreparer(ctx context.Context, projectID uuid.UUID, name string, description string, typeParameter string) (*http.Request, error)
CreateTagPreparer prepares the CreateTag request.
func (client BaseClient) CreateTagResponder(resp *http.Response) (result Tag, err error)
CreateTagResponder handles the response to the CreateTag request. The method always closes the http.Response Body.
func (client BaseClient) CreateTagSender(req *http.Request) (*http.Response, error)
CreateTagSender sends the CreateTag request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) DeleteImageRegions(ctx context.Context, projectID uuid.UUID, regionIds []string) (result autorest.Response, err error)
DeleteImageRegions sends the delete image regions request. Parameters: projectID - the project id. regionIds - regions to delete. Limited to 64.
func (client BaseClient) DeleteImageRegionsPreparer(ctx context.Context, projectID uuid.UUID, regionIds []string) (*http.Request, error)
DeleteImageRegionsPreparer prepares the DeleteImageRegions request.
func (client BaseClient) DeleteImageRegionsResponder(resp *http.Response) (result autorest.Response, err error)
DeleteImageRegionsResponder handles the response to the DeleteImageRegions request. The method always closes the http.Response Body.
func (client BaseClient) DeleteImageRegionsSender(req *http.Request) (*http.Response, error)
DeleteImageRegionsSender sends the DeleteImageRegions request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) DeleteImageTags(ctx context.Context, projectID uuid.UUID, imageIds []string, tagIds []string) (result autorest.Response, err error)
DeleteImageTags sends the delete image tags request. Parameters: projectID - the project id. imageIds - image ids. Limited to 64 images. tagIds - tags to be deleted from the specified images. Limited to 20 tags.
func (client BaseClient) DeleteImageTagsPreparer(ctx context.Context, projectID uuid.UUID, imageIds []string, tagIds []string) (*http.Request, error)
DeleteImageTagsPreparer prepares the DeleteImageTags request.
func (client BaseClient) DeleteImageTagsResponder(resp *http.Response) (result autorest.Response, err error)
DeleteImageTagsResponder handles the response to the DeleteImageTags request. The method always closes the http.Response Body.
func (client BaseClient) DeleteImageTagsSender(req *http.Request) (*http.Response, error)
DeleteImageTagsSender sends the DeleteImageTags request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) DeleteImages(ctx context.Context, projectID uuid.UUID, imageIds []string) (result autorest.Response, err error)
DeleteImages sends the delete images request. Parameters: projectID - the project id. imageIds - ids of the images to be deleted. Limited to 256 images per batch.
func (client BaseClient) DeleteImagesPreparer(ctx context.Context, projectID uuid.UUID, imageIds []string) (*http.Request, error)
DeleteImagesPreparer prepares the DeleteImages request.
func (client BaseClient) DeleteImagesResponder(resp *http.Response) (result autorest.Response, err error)
DeleteImagesResponder handles the response to the DeleteImages request. The method always closes the http.Response Body.
func (client BaseClient) DeleteImagesSender(req *http.Request) (*http.Response, error)
DeleteImagesSender sends the DeleteImages request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) DeleteIteration(ctx context.Context, projectID uuid.UUID, iterationID uuid.UUID) (result autorest.Response, err error)
DeleteIteration sends the delete iteration request. Parameters: projectID - the project id. iterationID - the iteration id.
func (client BaseClient) DeleteIterationPreparer(ctx context.Context, projectID uuid.UUID, iterationID uuid.UUID) (*http.Request, error)
DeleteIterationPreparer prepares the DeleteIteration request.
func (client BaseClient) DeleteIterationResponder(resp *http.Response) (result autorest.Response, err error)
DeleteIterationResponder handles the response to the DeleteIteration request. The method always closes the http.Response Body.
func (client BaseClient) DeleteIterationSender(req *http.Request) (*http.Response, error)
DeleteIterationSender sends the DeleteIteration request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) DeletePrediction(ctx context.Context, projectID uuid.UUID, ids []string) (result autorest.Response, err error)
DeletePrediction sends the delete prediction request. Parameters: projectID - the project id. ids - the prediction ids. Limited to 64.
func (client BaseClient) DeletePredictionPreparer(ctx context.Context, projectID uuid.UUID, ids []string) (*http.Request, error)
DeletePredictionPreparer prepares the DeletePrediction request.
func (client BaseClient) DeletePredictionResponder(resp *http.Response) (result autorest.Response, err error)
DeletePredictionResponder handles the response to the DeletePrediction request. The method always closes the http.Response Body.
func (client BaseClient) DeletePredictionSender(req *http.Request) (*http.Response, error)
DeletePredictionSender sends the DeletePrediction request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) DeleteProject(ctx context.Context, projectID uuid.UUID) (result autorest.Response, err error)
DeleteProject sends the delete project request. Parameters: projectID - the project id.
func (client BaseClient) DeleteProjectPreparer(ctx context.Context, projectID uuid.UUID) (*http.Request, error)
DeleteProjectPreparer prepares the DeleteProject request.
func (client BaseClient) DeleteProjectResponder(resp *http.Response) (result autorest.Response, err error)
DeleteProjectResponder handles the response to the DeleteProject request. The method always closes the http.Response Body.
func (client BaseClient) DeleteProjectSender(req *http.Request) (*http.Response, error)
DeleteProjectSender sends the DeleteProject request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) DeleteTag(ctx context.Context, projectID uuid.UUID, tagID uuid.UUID) (result autorest.Response, err error)
DeleteTag sends the delete tag request. Parameters: projectID - the project id. tagID - id of the tag to be deleted.
func (client BaseClient) DeleteTagPreparer(ctx context.Context, projectID uuid.UUID, tagID uuid.UUID) (*http.Request, error)
DeleteTagPreparer prepares the DeleteTag request.
func (client BaseClient) DeleteTagResponder(resp *http.Response) (result autorest.Response, err error)
DeleteTagResponder handles the response to the DeleteTag request. The method always closes the http.Response Body.
func (client BaseClient) DeleteTagSender(req *http.Request) (*http.Response, error)
DeleteTagSender sends the DeleteTag request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) ExportIteration(ctx context.Context, projectID uuid.UUID, iterationID uuid.UUID, platform string, flavor string) (result Export, err error)
ExportIteration sends the export iteration request. Parameters: projectID - the project id. iterationID - the iteration id. platform - the target platform. flavor - the flavor of the target platform.
func (client BaseClient) ExportIterationPreparer(ctx context.Context, projectID uuid.UUID, iterationID uuid.UUID, platform string, flavor string) (*http.Request, error)
ExportIterationPreparer prepares the ExportIteration request.
func (client BaseClient) ExportIterationResponder(resp *http.Response) (result Export, err error)
ExportIterationResponder handles the response to the ExportIteration request. The method always closes the http.Response Body.
func (client BaseClient) ExportIterationSender(req *http.Request) (*http.Response, error)
ExportIterationSender sends the ExportIteration request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) GetDomain(ctx context.Context, domainID uuid.UUID) (result Domain, err error)
GetDomain sends the get domain request. Parameters: domainID - the id of the domain to get information about.
func (client BaseClient) GetDomainPreparer(ctx context.Context, domainID uuid.UUID) (*http.Request, error)
GetDomainPreparer prepares the GetDomain request.
func (client BaseClient) GetDomainResponder(resp *http.Response) (result Domain, err error)
GetDomainResponder handles the response to the GetDomain request. The method always closes the http.Response Body.
func (client BaseClient) GetDomainSender(req *http.Request) (*http.Response, error)
GetDomainSender sends the GetDomain request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) GetDomains(ctx context.Context) (result ListDomain, err error)
GetDomains sends the get domains request.
func (client BaseClient) GetDomainsPreparer(ctx context.Context) (*http.Request, error)
GetDomainsPreparer prepares the GetDomains request.
func (client BaseClient) GetDomainsResponder(resp *http.Response) (result ListDomain, err error)
GetDomainsResponder handles the response to the GetDomains request. The method always closes the http.Response Body.
func (client BaseClient) GetDomainsSender(req *http.Request) (*http.Response, error)
GetDomainsSender sends the GetDomains request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) GetExports(ctx context.Context, projectID uuid.UUID, iterationID uuid.UUID) (result ListExport, err error)
GetExports sends the get exports request. Parameters: projectID - the project id. iterationID - the iteration id.
func (client BaseClient) GetExportsPreparer(ctx context.Context, projectID uuid.UUID, iterationID uuid.UUID) (*http.Request, error)
GetExportsPreparer prepares the GetExports request.
func (client BaseClient) GetExportsResponder(resp *http.Response) (result ListExport, err error)
GetExportsResponder handles the response to the GetExports request. The method always closes the http.Response Body.
func (client BaseClient) GetExportsSender(req *http.Request) (*http.Response, error)
GetExportsSender sends the GetExports request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) GetImagePerformanceCount(ctx context.Context, projectID uuid.UUID, iterationID uuid.UUID, tagIds []string) (result Int32, err error)
GetImagePerformanceCount the filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and "Cat" tags, then only images tagged with Dog and/or Cat will be returned Parameters: projectID - the project id. iterationID - the iteration id. Defaults to workspace. tagIds - a list of tags ids to filter the images to count. Defaults to all tags when null.
func (client BaseClient) GetImagePerformanceCountPreparer(ctx context.Context, projectID uuid.UUID, iterationID uuid.UUID, tagIds []string) (*http.Request, error)
GetImagePerformanceCountPreparer prepares the GetImagePerformanceCount request.
func (client BaseClient) GetImagePerformanceCountResponder(resp *http.Response) (result Int32, err error)
GetImagePerformanceCountResponder handles the response to the GetImagePerformanceCount request. The method always closes the http.Response Body.
func (client BaseClient) GetImagePerformanceCountSender(req *http.Request) (*http.Response, error)
GetImagePerformanceCountSender sends the GetImagePerformanceCount request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) GetImagePerformances(ctx context.Context, projectID uuid.UUID, iterationID uuid.UUID, tagIds []string, orderBy string, take *int32, skip *int32) (result ListImagePerformance, err error)
GetImagePerformances this API supports batching and range selection. By default it will only return first 50 images matching images. Use the {take} and {skip} parameters to control how many images to return in a given batch. The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and "Cat" tags, then only images tagged with Dog and/or Cat will be returned Parameters: projectID - the project id. iterationID - the iteration id. Defaults to workspace. tagIds - a list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20. orderBy - the ordering. Defaults to newest. take - maximum number of images to return. Defaults to 50, limited to 256. skip - number of images to skip before beginning the image batch. Defaults to 0.
func (client BaseClient) GetImagePerformancesPreparer(ctx context.Context, projectID uuid.UUID, iterationID uuid.UUID, tagIds []string, orderBy string, take *int32, skip *int32) (*http.Request, error)
GetImagePerformancesPreparer prepares the GetImagePerformances request.
func (client BaseClient) GetImagePerformancesResponder(resp *http.Response) (result ListImagePerformance, err error)
GetImagePerformancesResponder handles the response to the GetImagePerformances request. The method always closes the http.Response Body.
func (client BaseClient) GetImagePerformancesSender(req *http.Request) (*http.Response, error)
GetImagePerformancesSender sends the GetImagePerformances request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) GetImageRegionProposals(ctx context.Context, projectID uuid.UUID, imageID uuid.UUID) (result ImageRegionProposal, err error)
GetImageRegionProposals this API will get region proposals for an image along with confidences for the region. It returns an empty array if no proposals are found. Parameters: projectID - the project id. imageID - the image id.
func (client BaseClient) GetImageRegionProposalsPreparer(ctx context.Context, projectID uuid.UUID, imageID uuid.UUID) (*http.Request, error)
GetImageRegionProposalsPreparer prepares the GetImageRegionProposals request.
func (client BaseClient) GetImageRegionProposalsResponder(resp *http.Response) (result ImageRegionProposal, err error)
GetImageRegionProposalsResponder handles the response to the GetImageRegionProposals request. The method always closes the http.Response Body.
func (client BaseClient) GetImageRegionProposalsSender(req *http.Request) (*http.Response, error)
GetImageRegionProposalsSender sends the GetImageRegionProposals request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) GetImagesByIds(ctx context.Context, projectID uuid.UUID, imageIds []string, iterationID *uuid.UUID) (result ListImage, err error)
GetImagesByIds this API will return a set of Images for the specified tags and optionally iteration. If no iteration is specified the current workspace is used. Parameters: projectID - the project id. imageIds - the list of image ids to retrieve. Limited to 256. iterationID - the iteration id. Defaults to workspace.
func (client BaseClient) GetImagesByIdsPreparer(ctx context.Context, projectID uuid.UUID, imageIds []string, iterationID *uuid.UUID) (*http.Request, error)
GetImagesByIdsPreparer prepares the GetImagesByIds request.
func (client BaseClient) GetImagesByIdsResponder(resp *http.Response) (result ListImage, err error)
GetImagesByIdsResponder handles the response to the GetImagesByIds request. The method always closes the http.Response Body.
func (client BaseClient) GetImagesByIdsSender(req *http.Request) (*http.Response, error)
GetImagesByIdsSender sends the GetImagesByIds request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) GetIteration(ctx context.Context, projectID uuid.UUID, iterationID uuid.UUID) (result Iteration, err error)
GetIteration sends the get iteration request. Parameters: projectID - the id of the project the iteration belongs to. iterationID - the id of the iteration to get.
func (client BaseClient) GetIterationPerformance(ctx context.Context, projectID uuid.UUID, iterationID uuid.UUID, threshold *float64, overlapThreshold *float64) (result IterationPerformance, err error)
GetIterationPerformance sends the get iteration performance request. Parameters: projectID - the id of the project the iteration belongs to. iterationID - the id of the iteration to get. threshold - the threshold used to determine true predictions. overlapThreshold - if applicable, the bounding box overlap threshold used to determine true predictions.
func (client BaseClient) GetIterationPerformancePreparer(ctx context.Context, projectID uuid.UUID, iterationID uuid.UUID, threshold *float64, overlapThreshold *float64) (*http.Request, error)
GetIterationPerformancePreparer prepares the GetIterationPerformance request.
func (client BaseClient) GetIterationPerformanceResponder(resp *http.Response) (result IterationPerformance, err error)
GetIterationPerformanceResponder handles the response to the GetIterationPerformance request. The method always closes the http.Response Body.
func (client BaseClient) GetIterationPerformanceSender(req *http.Request) (*http.Response, error)
GetIterationPerformanceSender sends the GetIterationPerformance request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) GetIterationPreparer(ctx context.Context, projectID uuid.UUID, iterationID uuid.UUID) (*http.Request, error)
GetIterationPreparer prepares the GetIteration request.
func (client BaseClient) GetIterationResponder(resp *http.Response) (result Iteration, err error)
GetIterationResponder handles the response to the GetIteration request. The method always closes the http.Response Body.
func (client BaseClient) GetIterationSender(req *http.Request) (*http.Response, error)
GetIterationSender sends the GetIteration request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) GetIterations(ctx context.Context, projectID uuid.UUID) (result ListIteration, err error)
GetIterations sends the get iterations request. Parameters: projectID - the project id.
func (client BaseClient) GetIterationsPreparer(ctx context.Context, projectID uuid.UUID) (*http.Request, error)
GetIterationsPreparer prepares the GetIterations request.
func (client BaseClient) GetIterationsResponder(resp *http.Response) (result ListIteration, err error)
GetIterationsResponder handles the response to the GetIterations request. The method always closes the http.Response Body.
func (client BaseClient) GetIterationsSender(req *http.Request) (*http.Response, error)
GetIterationsSender sends the GetIterations request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) GetProject(ctx context.Context, projectID uuid.UUID) (result Project, err error)
GetProject sends the get project request. Parameters: projectID - the id of the project to get.
func (client BaseClient) GetProjectPreparer(ctx context.Context, projectID uuid.UUID) (*http.Request, error)
GetProjectPreparer prepares the GetProject request.
func (client BaseClient) GetProjectResponder(resp *http.Response) (result Project, err error)
GetProjectResponder handles the response to the GetProject request. The method always closes the http.Response Body.
func (client BaseClient) GetProjectSender(req *http.Request) (*http.Response, error)
GetProjectSender sends the GetProject request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) GetProjects(ctx context.Context) (result ListProject, err error)
GetProjects sends the get projects request.
func (client BaseClient) GetProjectsPreparer(ctx context.Context) (*http.Request, error)
GetProjectsPreparer prepares the GetProjects request.
func (client BaseClient) GetProjectsResponder(resp *http.Response) (result ListProject, err error)
GetProjectsResponder handles the response to the GetProjects request. The method always closes the http.Response Body.
func (client BaseClient) GetProjectsSender(req *http.Request) (*http.Response, error)
GetProjectsSender sends the GetProjects request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) GetTag(ctx context.Context, projectID uuid.UUID, tagID uuid.UUID, iterationID *uuid.UUID) (result Tag, err error)
GetTag sends the get tag request. Parameters: projectID - the project this tag belongs to. tagID - the tag id. iterationID - the iteration to retrieve this tag from. Optional, defaults to current training set.
func (client BaseClient) GetTagPreparer(ctx context.Context, projectID uuid.UUID, tagID uuid.UUID, iterationID *uuid.UUID) (*http.Request, error)
GetTagPreparer prepares the GetTag request.
func (client BaseClient) GetTagResponder(resp *http.Response) (result Tag, err error)
GetTagResponder handles the response to the GetTag request. The method always closes the http.Response Body.
func (client BaseClient) GetTagSender(req *http.Request) (*http.Response, error)
GetTagSender sends the GetTag request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) GetTaggedImageCount(ctx context.Context, projectID uuid.UUID, iterationID *uuid.UUID, tagIds []string) (result Int32, err error)
GetTaggedImageCount the filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and "Cat" tags, then only images tagged with Dog and/or Cat will be returned Parameters: projectID - the project id. iterationID - the iteration id. Defaults to workspace. tagIds - a list of tags ids to filter the images to count. Defaults to all tags when null.
func (client BaseClient) GetTaggedImageCountPreparer(ctx context.Context, projectID uuid.UUID, iterationID *uuid.UUID, tagIds []string) (*http.Request, error)
GetTaggedImageCountPreparer prepares the GetTaggedImageCount request.
func (client BaseClient) GetTaggedImageCountResponder(resp *http.Response) (result Int32, err error)
GetTaggedImageCountResponder handles the response to the GetTaggedImageCount request. The method always closes the http.Response Body.
func (client BaseClient) GetTaggedImageCountSender(req *http.Request) (*http.Response, error)
GetTaggedImageCountSender sends the GetTaggedImageCount request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) GetTaggedImages(ctx context.Context, projectID uuid.UUID, iterationID *uuid.UUID, tagIds []string, orderBy string, take *int32, skip *int32) (result ListImage, err error)
GetTaggedImages this API supports batching and range selection. By default it will only return first 50 images matching images. Use the {take} and {skip} parameters to control how many images to return in a given batch. The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and "Cat" tags, then only images tagged with Dog and/or Cat will be returned Parameters: projectID - the project id. iterationID - the iteration id. Defaults to workspace. tagIds - a list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20. orderBy - the ordering. Defaults to newest. take - maximum number of images to return. Defaults to 50, limited to 256. skip - number of images to skip before beginning the image batch. Defaults to 0.
func (client BaseClient) GetTaggedImagesPreparer(ctx context.Context, projectID uuid.UUID, iterationID *uuid.UUID, tagIds []string, orderBy string, take *int32, skip *int32) (*http.Request, error)
GetTaggedImagesPreparer prepares the GetTaggedImages request.
func (client BaseClient) GetTaggedImagesResponder(resp *http.Response) (result ListImage, err error)
GetTaggedImagesResponder handles the response to the GetTaggedImages request. The method always closes the http.Response Body.
func (client BaseClient) GetTaggedImagesSender(req *http.Request) (*http.Response, error)
GetTaggedImagesSender sends the GetTaggedImages request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) GetTags(ctx context.Context, projectID uuid.UUID, iterationID *uuid.UUID) (result ListTag, err error)
GetTags sends the get tags request. Parameters: projectID - the project id. iterationID - the iteration id. Defaults to workspace.
func (client BaseClient) GetTagsPreparer(ctx context.Context, projectID uuid.UUID, iterationID *uuid.UUID) (*http.Request, error)
GetTagsPreparer prepares the GetTags request.
func (client BaseClient) GetTagsResponder(resp *http.Response) (result ListTag, err error)
GetTagsResponder handles the response to the GetTags request. The method always closes the http.Response Body.
func (client BaseClient) GetTagsSender(req *http.Request) (*http.Response, error)
GetTagsSender sends the GetTags request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) GetUntaggedImageCount(ctx context.Context, projectID uuid.UUID, iterationID *uuid.UUID) (result Int32, err error)
GetUntaggedImageCount this API returns the images which have no tags for a given project and optionally an iteration. If no iteration is specified the current workspace is used. Parameters: projectID - the project id. iterationID - the iteration id. Defaults to workspace.
func (client BaseClient) GetUntaggedImageCountPreparer(ctx context.Context, projectID uuid.UUID, iterationID *uuid.UUID) (*http.Request, error)
GetUntaggedImageCountPreparer prepares the GetUntaggedImageCount request.
func (client BaseClient) GetUntaggedImageCountResponder(resp *http.Response) (result Int32, err error)
GetUntaggedImageCountResponder handles the response to the GetUntaggedImageCount request. The method always closes the http.Response Body.
func (client BaseClient) GetUntaggedImageCountSender(req *http.Request) (*http.Response, error)
GetUntaggedImageCountSender sends the GetUntaggedImageCount request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) GetUntaggedImages(ctx context.Context, projectID uuid.UUID, iterationID *uuid.UUID, orderBy string, take *int32, skip *int32) (result ListImage, err error)
GetUntaggedImages this API supports batching and range selection. By default it will only return first 50 images matching images. Use the {take} and {skip} parameters to control how many images to return in a given batch. Parameters: projectID - the project id. iterationID - the iteration id. Defaults to workspace. orderBy - the ordering. Defaults to newest. take - maximum number of images to return. Defaults to 50, limited to 256. skip - number of images to skip before beginning the image batch. Defaults to 0.
func (client BaseClient) GetUntaggedImagesPreparer(ctx context.Context, projectID uuid.UUID, iterationID *uuid.UUID, orderBy string, take *int32, skip *int32) (*http.Request, error)
GetUntaggedImagesPreparer prepares the GetUntaggedImages request.
func (client BaseClient) GetUntaggedImagesResponder(resp *http.Response) (result ListImage, err error)
GetUntaggedImagesResponder handles the response to the GetUntaggedImages request. The method always closes the http.Response Body.
func (client BaseClient) GetUntaggedImagesSender(req *http.Request) (*http.Response, error)
GetUntaggedImagesSender sends the GetUntaggedImages request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) QueryPredictions(ctx context.Context, projectID uuid.UUID, query PredictionQueryToken) (result PredictionQueryResult, err error)
QueryPredictions sends the query predictions request. Parameters: projectID - the project id. query - parameters used to query the predictions. Limited to combining 2 tags.
func (client BaseClient) QueryPredictionsPreparer(ctx context.Context, projectID uuid.UUID, query PredictionQueryToken) (*http.Request, error)
QueryPredictionsPreparer prepares the QueryPredictions request.
func (client BaseClient) QueryPredictionsResponder(resp *http.Response) (result PredictionQueryResult, err error)
QueryPredictionsResponder handles the response to the QueryPredictions request. The method always closes the http.Response Body.
func (client BaseClient) QueryPredictionsSender(req *http.Request) (*http.Response, error)
QueryPredictionsSender sends the QueryPredictions request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) QuickTestImage(ctx context.Context, projectID uuid.UUID, imageData io.ReadCloser, iterationID *uuid.UUID) (result ImagePrediction, err error)
QuickTestImage sends the quick test image request. Parameters: projectID - the project id. imageData - binary image data. iterationID - optional. Specifies the id of a particular iteration to evaluate against. The default iteration for the project will be used when not specified.
func (client BaseClient) QuickTestImagePreparer(ctx context.Context, projectID uuid.UUID, imageData io.ReadCloser, iterationID *uuid.UUID) (*http.Request, error)
QuickTestImagePreparer prepares the QuickTestImage request.
func (client BaseClient) QuickTestImageResponder(resp *http.Response) (result ImagePrediction, err error)
QuickTestImageResponder handles the response to the QuickTestImage request. The method always closes the http.Response Body.
func (client BaseClient) QuickTestImageSender(req *http.Request) (*http.Response, error)
QuickTestImageSender sends the QuickTestImage request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) QuickTestImageURL(ctx context.Context, projectID uuid.UUID, imageURL ImageURL, iterationID *uuid.UUID) (result ImagePrediction, err error)
QuickTestImageURL sends the quick test image url request. Parameters: projectID - the project to evaluate against. imageURL - an {Iris.Web.Api.Models.ImageUrl} that contains the url of the image to be evaluated. iterationID - optional. Specifies the id of a particular iteration to evaluate against. The default iteration for the project will be used when not specified.
func (client BaseClient) QuickTestImageURLPreparer(ctx context.Context, projectID uuid.UUID, imageURL ImageURL, iterationID *uuid.UUID) (*http.Request, error)
QuickTestImageURLPreparer prepares the QuickTestImageURL request.
func (client BaseClient) QuickTestImageURLResponder(resp *http.Response) (result ImagePrediction, err error)
QuickTestImageURLResponder handles the response to the QuickTestImageURL request. The method always closes the http.Response Body.
func (client BaseClient) QuickTestImageURLSender(req *http.Request) (*http.Response, error)
QuickTestImageURLSender sends the QuickTestImageURL request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) TrainProject(ctx context.Context, projectID uuid.UUID) (result Iteration, err error)
TrainProject sends the train project request. Parameters: projectID - the project id.
func (client BaseClient) TrainProjectPreparer(ctx context.Context, projectID uuid.UUID) (*http.Request, error)
TrainProjectPreparer prepares the TrainProject request.
func (client BaseClient) TrainProjectResponder(resp *http.Response) (result Iteration, err error)
TrainProjectResponder handles the response to the TrainProject request. The method always closes the http.Response Body.
func (client BaseClient) TrainProjectSender(req *http.Request) (*http.Response, error)
TrainProjectSender sends the TrainProject request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) UpdateIteration(ctx context.Context, projectID uuid.UUID, iterationID uuid.UUID, updatedIteration Iteration) (result Iteration, err error)
UpdateIteration sends the update iteration request. Parameters: projectID - project id. iterationID - iteration id. updatedIteration - the updated iteration model.
func (client BaseClient) UpdateIterationPreparer(ctx context.Context, projectID uuid.UUID, iterationID uuid.UUID, updatedIteration Iteration) (*http.Request, error)
UpdateIterationPreparer prepares the UpdateIteration request.
func (client BaseClient) UpdateIterationResponder(resp *http.Response) (result Iteration, err error)
UpdateIterationResponder handles the response to the UpdateIteration request. The method always closes the http.Response Body.
func (client BaseClient) UpdateIterationSender(req *http.Request) (*http.Response, error)
UpdateIterationSender sends the UpdateIteration request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) UpdateProject(ctx context.Context, projectID uuid.UUID, updatedProject Project) (result Project, err error)
UpdateProject sends the update project request. Parameters: projectID - the id of the project to update. updatedProject - the updated project model.
func (client BaseClient) UpdateProjectPreparer(ctx context.Context, projectID uuid.UUID, updatedProject Project) (*http.Request, error)
UpdateProjectPreparer prepares the UpdateProject request.
func (client BaseClient) UpdateProjectResponder(resp *http.Response) (result Project, err error)
UpdateProjectResponder handles the response to the UpdateProject request. The method always closes the http.Response Body.
func (client BaseClient) UpdateProjectSender(req *http.Request) (*http.Response, error)
UpdateProjectSender sends the UpdateProject request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) UpdateTag(ctx context.Context, projectID uuid.UUID, tagID uuid.UUID, updatedTag Tag) (result Tag, err error)
UpdateTag sends the update tag request. Parameters: projectID - the project id. tagID - the id of the target tag. updatedTag - the updated tag model.
func (client BaseClient) UpdateTagPreparer(ctx context.Context, projectID uuid.UUID, tagID uuid.UUID, updatedTag Tag) (*http.Request, error)
UpdateTagPreparer prepares the UpdateTag request.
func (client BaseClient) UpdateTagResponder(resp *http.Response) (result Tag, err error)
UpdateTagResponder handles the response to the UpdateTag request. The method always closes the http.Response Body.
func (client BaseClient) UpdateTagSender(req *http.Request) (*http.Response, error)
UpdateTagSender sends the UpdateTag request. The method will close the http.Response Body if it receives an error.
BoundingBox ...
type BoundingBox struct {
Left *float64 `json:"left,omitempty"`
Top *float64 `json:"top,omitempty"`
Width *float64 `json:"width,omitempty"`
Height *float64 `json:"height,omitempty"`
}
Classifier enumerates the values for classifier.
type Classifier string
const (
// Multiclass ...
Multiclass Classifier = "Multiclass"
// Multilabel ...
Multilabel Classifier = "Multilabel"
)
func PossibleClassifierValues() []Classifier
PossibleClassifierValues returns an array of possible values for the Classifier const type.
Domain ...
type Domain struct {
autorest.Response `json:"-"`
// ID - READ-ONLY
ID *uuid.UUID `json:"id,omitempty"`
// Name - READ-ONLY
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Possible values include: 'Classification', 'ObjectDetection'
Type DomainType `json:"type,omitempty"`
// Exportable - READ-ONLY
Exportable *bool `json:"exportable,omitempty"`
// Enabled - READ-ONLY
Enabled *bool `json:"enabled,omitempty"`
}
func (d Domain) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Domain.
DomainType enumerates the values for domain type.
type DomainType string
const (
// Classification ...
Classification DomainType = "Classification"
// ObjectDetection ...
ObjectDetection DomainType = "ObjectDetection"
)
func PossibleDomainTypeValues() []DomainType
PossibleDomainTypeValues returns an array of possible values for the DomainType const type.
Export ...
type Export struct {
autorest.Response `json:"-"`
// Platform - READ-ONLY; Platform of the export. Possible values include: 'CoreML', 'TensorFlow', 'DockerFile', 'ONNX'
Platform ExportPlatformModel `json:"platform,omitempty"`
// Status - READ-ONLY; Status of the export. Possible values include: 'Exporting', 'Failed', 'Done'
Status ExportStatusModel `json:"status,omitempty"`
// DownloadURI - READ-ONLY; URI used to download the model.
DownloadURI *string `json:"downloadUri,omitempty"`
// Flavor - READ-ONLY; Flavor of the export. Possible values include: 'Linux', 'Windows', 'ONNX10', 'ONNX12'
Flavor ExportFlavorModel `json:"flavor,omitempty"`
// NewerVersionAvailable - READ-ONLY; Indicates an updated version of the export package is available and should be re-exported for the latest changes.
NewerVersionAvailable *bool `json:"newerVersionAvailable,omitempty"`
}
func (e Export) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Export.
ExportFlavorModel enumerates the values for export flavor model.
type ExportFlavorModel string
const (
// Linux ...
Linux ExportFlavorModel = "Linux"
// ONNX10 ...
ONNX10 ExportFlavorModel = "ONNX10"
// ONNX12 ...
ONNX12 ExportFlavorModel = "ONNX12"
// Windows ...
Windows ExportFlavorModel = "Windows"
)
func PossibleExportFlavorModelValues() []ExportFlavorModel
PossibleExportFlavorModelValues returns an array of possible values for the ExportFlavorModel const type.
ExportPlatformModel enumerates the values for export platform model.
type ExportPlatformModel string
const (
// CoreML ...
CoreML ExportPlatformModel = "CoreML"
// DockerFile ...
DockerFile ExportPlatformModel = "DockerFile"
// ONNX ...
ONNX ExportPlatformModel = "ONNX"
// TensorFlow ...
TensorFlow ExportPlatformModel = "TensorFlow"
)
func PossibleExportPlatformModelValues() []ExportPlatformModel
PossibleExportPlatformModelValues returns an array of possible values for the ExportPlatformModel const type.
ExportStatusModel enumerates the values for export status model.
type ExportStatusModel string
const (
// Done ...
Done ExportStatusModel = "Done"
// Exporting ...
Exporting ExportStatusModel = "Exporting"
// Failed ...
Failed ExportStatusModel = "Failed"
)
func PossibleExportStatusModelValues() []ExportStatusModel
PossibleExportStatusModelValues returns an array of possible values for the ExportStatusModel const type.
Image image model to be sent as JSON.
type Image struct {
// ID - READ-ONLY; Id of the image.
ID *uuid.UUID `json:"id,omitempty"`
// Created - READ-ONLY; Date the image was created.
Created *date.Time `json:"created,omitempty"`
// Width - READ-ONLY; Width of the image.
Width *int32 `json:"width,omitempty"`
// Height - READ-ONLY; Height of the image.
Height *int32 `json:"height,omitempty"`
// ResizedImageURI - READ-ONLY; The URI to the (resized) image used for training.
ResizedImageURI *string `json:"resizedImageUri,omitempty"`
// ThumbnailURI - READ-ONLY; The URI to the thumbnail of the original image.
ThumbnailURI *string `json:"thumbnailUri,omitempty"`
// OriginalImageURI - READ-ONLY; The URI to the original uploaded image.
OriginalImageURI *string `json:"originalImageUri,omitempty"`
// Tags - READ-ONLY; Tags associated with this image.
Tags *[]ImageTag `json:"tags,omitempty"`
// Regions - READ-ONLY; Regions associated with this image.
Regions *[]ImageRegion `json:"regions,omitempty"`
}
func (i Image) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Image.
ImageCreateResult ...
type ImageCreateResult struct {
// SourceURL - READ-ONLY; Source URL of the image.
SourceURL *string `json:"sourceUrl,omitempty"`
// Status - READ-ONLY; Status of the image creation. Possible values include: 'OK', 'OKDuplicate', 'ErrorSource', 'ErrorImageFormat', 'ErrorImageSize', 'ErrorStorage', 'ErrorLimitExceed', 'ErrorTagLimitExceed', 'ErrorRegionLimitExceed', 'ErrorUnknown', 'ErrorNegativeAndRegularTagOnSameImage'
Status ImageCreateStatus `json:"status,omitempty"`
// Image - READ-ONLY; The image.
Image *Image `json:"image,omitempty"`
}
func (icr ImageCreateResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ImageCreateResult.
ImageCreateStatus enumerates the values for image create status.
type ImageCreateStatus string
const (
// ErrorImageFormat ...
ErrorImageFormat ImageCreateStatus = "ErrorImageFormat"
// ErrorImageSize ...
ErrorImageSize ImageCreateStatus = "ErrorImageSize"
// ErrorLimitExceed ...
ErrorLimitExceed ImageCreateStatus = "ErrorLimitExceed"
// ErrorNegativeAndRegularTagOnSameImage ...
ErrorNegativeAndRegularTagOnSameImage ImageCreateStatus = "ErrorNegativeAndRegularTagOnSameImage"
// ErrorRegionLimitExceed ...
ErrorRegionLimitExceed ImageCreateStatus = "ErrorRegionLimitExceed"
// ErrorSource ...
ErrorSource ImageCreateStatus = "ErrorSource"
// ErrorStorage ...
ErrorStorage ImageCreateStatus = "ErrorStorage"
// ErrorTagLimitExceed ...
ErrorTagLimitExceed ImageCreateStatus = "ErrorTagLimitExceed"
// ErrorUnknown ...
ErrorUnknown ImageCreateStatus = "ErrorUnknown"
// OK ...
OK ImageCreateStatus = "OK"
// OKDuplicate ...
OKDuplicate ImageCreateStatus = "OKDuplicate"
)
func PossibleImageCreateStatusValues() []ImageCreateStatus
PossibleImageCreateStatusValues returns an array of possible values for the ImageCreateStatus const type.
ImageCreateSummary ...
type ImageCreateSummary struct {
autorest.Response `json:"-"`
// IsBatchSuccessful - READ-ONLY; True if all of the images in the batch were created successfully, otherwise false.
IsBatchSuccessful *bool `json:"isBatchSuccessful,omitempty"`
// Images - READ-ONLY; List of the image creation results.
Images *[]ImageCreateResult `json:"images,omitempty"`
}
func (ics ImageCreateSummary) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ImageCreateSummary.
ImageFileCreateBatch ...
type ImageFileCreateBatch struct {
Images *[]ImageFileCreateEntry `json:"images,omitempty"`
TagIds *[]uuid.UUID `json:"tagIds,omitempty"`
}
ImageFileCreateEntry ...
type ImageFileCreateEntry struct {
Name *string `json:"name,omitempty"`
Contents *[]byte `json:"contents,omitempty"`
TagIds *[]uuid.UUID `json:"tagIds,omitempty"`
Regions *[]Region `json:"regions,omitempty"`
}
ImageIDCreateBatch ...
type ImageIDCreateBatch struct {
Images *[]ImageIDCreateEntry `json:"images,omitempty"`
TagIds *[]uuid.UUID `json:"tagIds,omitempty"`
}
ImageIDCreateEntry ...
type ImageIDCreateEntry struct {
ID *uuid.UUID `json:"id,omitempty"`
TagIds *[]uuid.UUID `json:"tagIds,omitempty"`
Regions *[]Region `json:"regions,omitempty"`
}
ImagePerformance image performance model.
type ImagePerformance struct {
// Predictions - READ-ONLY
Predictions *[]Prediction `json:"predictions,omitempty"`
// ID - READ-ONLY
ID *uuid.UUID `json:"id,omitempty"`
// Created - READ-ONLY
Created *date.Time `json:"created,omitempty"`
// Width - READ-ONLY
Width *int32 `json:"width,omitempty"`
// Height - READ-ONLY
Height *int32 `json:"height,omitempty"`
// ImageURI - READ-ONLY
ImageURI *string `json:"imageUri,omitempty"`
// ThumbnailURI - READ-ONLY
ThumbnailURI *string `json:"thumbnailUri,omitempty"`
// Tags - READ-ONLY
Tags *[]ImageTag `json:"tags,omitempty"`
// Regions - READ-ONLY
Regions *[]ImageRegion `json:"regions,omitempty"`
}
func (IP ImagePerformance) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ImagePerformance.
ImagePrediction ...
type ImagePrediction struct {
autorest.Response `json:"-"`
// ID - READ-ONLY
ID *uuid.UUID `json:"id,omitempty"`
// Project - READ-ONLY
Project *uuid.UUID `json:"project,omitempty"`
// Iteration - READ-ONLY
Iteration *uuid.UUID `json:"iteration,omitempty"`
// Created - READ-ONLY
Created *date.Time `json:"created,omitempty"`
// Predictions - READ-ONLY
Predictions *[]Prediction `json:"predictions,omitempty"`
}
func (IP ImagePrediction) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ImagePrediction.
ImageRegion ...
type ImageRegion struct {
// RegionID - READ-ONLY
RegionID *uuid.UUID `json:"regionId,omitempty"`
// TagName - READ-ONLY
TagName *string `json:"tagName,omitempty"`
// Created - READ-ONLY
Created *date.Time `json:"created,omitempty"`
// TagID - Id of the tag associated with this region.
TagID *uuid.UUID `json:"tagId,omitempty"`
Left *float64 `json:"left,omitempty"`
Top *float64 `json:"top,omitempty"`
Width *float64 `json:"width,omitempty"`
Height *float64 `json:"height,omitempty"`
}
func (ir ImageRegion) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ImageRegion.
ImageRegionCreateBatch batch of image region information to create.
type ImageRegionCreateBatch struct {
Regions *[]ImageRegionCreateEntry `json:"regions,omitempty"`
}
ImageRegionCreateEntry entry associating a region to an image.
type ImageRegionCreateEntry struct {
// ImageID - Id of the image.
ImageID *uuid.UUID `json:"imageId,omitempty"`
// TagID - Id of the tag associated with this region.
TagID *uuid.UUID `json:"tagId,omitempty"`
Left *float64 `json:"left,omitempty"`
Top *float64 `json:"top,omitempty"`
Width *float64 `json:"width,omitempty"`
Height *float64 `json:"height,omitempty"`
}
ImageRegionCreateResult ...
type ImageRegionCreateResult struct {
// ImageID - READ-ONLY
ImageID *uuid.UUID `json:"imageId,omitempty"`
// RegionID - READ-ONLY
RegionID *uuid.UUID `json:"regionId,omitempty"`
// TagName - READ-ONLY
TagName *string `json:"tagName,omitempty"`
// Created - READ-ONLY
Created *date.Time `json:"created,omitempty"`
// TagID - Id of the tag associated with this region.
TagID *uuid.UUID `json:"tagId,omitempty"`
Left *float64 `json:"left,omitempty"`
Top *float64 `json:"top,omitempty"`
Width *float64 `json:"width,omitempty"`
Height *float64 `json:"height,omitempty"`
}
func (ircr ImageRegionCreateResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ImageRegionCreateResult.
ImageRegionCreateSummary ...
type ImageRegionCreateSummary struct {
autorest.Response `json:"-"`
Created *[]ImageRegionCreateResult `json:"created,omitempty"`
Duplicated *[]ImageRegionCreateEntry `json:"duplicated,omitempty"`
Exceeded *[]ImageRegionCreateEntry `json:"exceeded,omitempty"`
}
ImageRegionProposal ...
type ImageRegionProposal struct {
autorest.Response `json:"-"`
// ProjectID - READ-ONLY
ProjectID *uuid.UUID `json:"projectId,omitempty"`
// ImageID - READ-ONLY
ImageID *uuid.UUID `json:"imageId,omitempty"`
// Proposals - READ-ONLY
Proposals *[]RegionProposal `json:"proposals,omitempty"`
}
func (irp ImageRegionProposal) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ImageRegionProposal.
ImageTag ...
type ImageTag struct {
// TagID - READ-ONLY
TagID *uuid.UUID `json:"tagId,omitempty"`
// TagName - READ-ONLY
TagName *string `json:"tagName,omitempty"`
// Created - READ-ONLY
Created *date.Time `json:"created,omitempty"`
}
func (it ImageTag) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ImageTag.
ImageTagCreateBatch batch of image tags.
type ImageTagCreateBatch struct {
// Tags - Image Tag entries to include in this batch.
Tags *[]ImageTagCreateEntry `json:"tags,omitempty"`
}
ImageTagCreateEntry entry associating a tag to an image.
type ImageTagCreateEntry struct {
// ImageID - Id of the image.
ImageID *uuid.UUID `json:"imageId,omitempty"`
// TagID - Id of the tag.
TagID *uuid.UUID `json:"tagId,omitempty"`
}
ImageTagCreateSummary ...
type ImageTagCreateSummary struct {
autorest.Response `json:"-"`
Created *[]ImageTagCreateEntry `json:"created,omitempty"`
Duplicated *[]ImageTagCreateEntry `json:"duplicated,omitempty"`
Exceeded *[]ImageTagCreateEntry `json:"exceeded,omitempty"`
}
ImageURL ...
type ImageURL struct {
URL *string `json:"url,omitempty"`
}
ImageURLCreateBatch ...
type ImageURLCreateBatch struct {
Images *[]ImageURLCreateEntry `json:"images,omitempty"`
TagIds *[]uuid.UUID `json:"tagIds,omitempty"`
}
ImageURLCreateEntry ...
type ImageURLCreateEntry struct {
URL *string `json:"url,omitempty"`
TagIds *[]uuid.UUID `json:"tagIds,omitempty"`
Regions *[]Region `json:"regions,omitempty"`
}
Int32 ...
type Int32 struct {
autorest.Response `json:"-"`
Value *int32 `json:"value,omitempty"`
}
Iteration iteration model to be sent over JSON.
type Iteration struct {
autorest.Response `json:"-"`
// ID - READ-ONLY; Gets the id of the iteration.
ID *uuid.UUID `json:"id,omitempty"`
// Name - Gets or sets the name of the iteration.
Name *string `json:"name,omitempty"`
// IsDefault - Gets or sets a value indicating whether the iteration is the default iteration for the project.
IsDefault *bool `json:"isDefault,omitempty"`
// Status - READ-ONLY; Gets the current iteration status.
Status *string `json:"status,omitempty"`
// Created - READ-ONLY; Gets the time this iteration was completed.
Created *date.Time `json:"created,omitempty"`
// LastModified - READ-ONLY; Gets the time this iteration was last modified.
LastModified *date.Time `json:"lastModified,omitempty"`
// TrainedAt - READ-ONLY; Gets the time this iteration was last modified.
TrainedAt *date.Time `json:"trainedAt,omitempty"`
// ProjectID - READ-ONLY; Gets The project id. of the iteration.
ProjectID *uuid.UUID `json:"projectId,omitempty"`
// Exportable - READ-ONLY; Whether the iteration can be exported to another format for download.
Exportable *bool `json:"exportable,omitempty"`
// DomainID - READ-ONLY; Get or sets a guid of the domain the iteration has been trained on.
DomainID *uuid.UUID `json:"domainId,omitempty"`
// ClassificationType - READ-ONLY; Gets the classification type of the project. Possible values include: 'Multiclass', 'Multilabel'
ClassificationType Classifier `json:"classificationType,omitempty"`
}
func (i Iteration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Iteration.
IterationPerformance represents the detailed performance data for a trained iteration.
type IterationPerformance struct {
autorest.Response `json:"-"`
// PerTagPerformance - READ-ONLY; Gets the per-tag performance details for this iteration.
PerTagPerformance *[]TagPerformance `json:"perTagPerformance,omitempty"`
// Precision - READ-ONLY; Gets the precision.
Precision *float64 `json:"precision,omitempty"`
// PrecisionStdDeviation - READ-ONLY; Gets the standard deviation for the precision.
PrecisionStdDeviation *float64 `json:"precisionStdDeviation,omitempty"`
// Recall - READ-ONLY; Gets the recall.
Recall *float64 `json:"recall,omitempty"`
// RecallStdDeviation - READ-ONLY; Gets the standard deviation for the recall.
RecallStdDeviation *float64 `json:"recallStdDeviation,omitempty"`
// AveragePrecision - READ-ONLY; Gets the average precision when applicable.
AveragePrecision *float64 `json:"averagePrecision,omitempty"`
}
func (IP IterationPerformance) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IterationPerformance.
ListDomain ...
type ListDomain struct {
autorest.Response `json:"-"`
Value *[]Domain `json:"value,omitempty"`
}
ListExport ...
type ListExport struct {
autorest.Response `json:"-"`
Value *[]Export `json:"value,omitempty"`
}
ListImage ...
type ListImage struct {
autorest.Response `json:"-"`
Value *[]Image `json:"value,omitempty"`
}
ListImagePerformance ...
type ListImagePerformance struct {
autorest.Response `json:"-"`
Value *[]ImagePerformance `json:"value,omitempty"`
}
ListIteration ...
type ListIteration struct {
autorest.Response `json:"-"`
Value *[]Iteration `json:"value,omitempty"`
}
ListProject ...
type ListProject struct {
autorest.Response `json:"-"`
Value *[]Project `json:"value,omitempty"`
}
ListTag ...
type ListTag struct {
autorest.Response `json:"-"`
Value *[]Tag `json:"value,omitempty"`
}
OrderBy enumerates the values for order by.
type OrderBy string
const (
// Newest ...
Newest OrderBy = "Newest"
// Oldest ...
Oldest OrderBy = "Oldest"
// Suggested ...
Suggested OrderBy = "Suggested"
)
func PossibleOrderByValues() []OrderBy
PossibleOrderByValues returns an array of possible values for the OrderBy const type.
Prediction ...
type Prediction struct {
// Probability - READ-ONLY
Probability *float64 `json:"probability,omitempty"`
// TagID - READ-ONLY
TagID *uuid.UUID `json:"tagId,omitempty"`
// TagName - READ-ONLY
TagName *string `json:"tagName,omitempty"`
// BoundingBox - READ-ONLY
BoundingBox *BoundingBox `json:"boundingBox,omitempty"`
}
func (p Prediction) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Prediction.
PredictionQueryResult ...
type PredictionQueryResult struct {
autorest.Response `json:"-"`
// Token - READ-ONLY
Token *PredictionQueryToken `json:"token,omitempty"`
// Results - READ-ONLY
Results *[]StoredImagePrediction `json:"results,omitempty"`
}
func (pqr PredictionQueryResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PredictionQueryResult.
PredictionQueryTag ...
type PredictionQueryTag struct {
// ID - READ-ONLY
ID *uuid.UUID `json:"id,omitempty"`
// MinThreshold - READ-ONLY
MinThreshold *float64 `json:"minThreshold,omitempty"`
// MaxThreshold - READ-ONLY
MaxThreshold *float64 `json:"maxThreshold,omitempty"`
}
func (pqt PredictionQueryTag) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PredictionQueryTag.
PredictionQueryToken ...
type PredictionQueryToken struct {
Session *string `json:"session,omitempty"`
Continuation *string `json:"continuation,omitempty"`
MaxCount *int32 `json:"maxCount,omitempty"`
// OrderBy - Possible values include: 'Newest', 'Oldest', 'Suggested'
OrderBy OrderBy `json:"orderBy,omitempty"`
Tags *[]PredictionQueryTag `json:"tags,omitempty"`
IterationID *uuid.UUID `json:"iterationId,omitempty"`
StartTime *date.Time `json:"startTime,omitempty"`
EndTime *date.Time `json:"endTime,omitempty"`
Application *string `json:"application,omitempty"`
}
Project represents a project.
type Project struct {
autorest.Response `json:"-"`
// ID - READ-ONLY; Gets The project id.
ID *uuid.UUID `json:"id,omitempty"`
// Name - Gets or sets the name of the project.
Name *string `json:"name,omitempty"`
// Description - Gets or sets the description of the project.
Description *string `json:"description,omitempty"`
// Settings - Gets or sets the project settings.
Settings *ProjectSettings `json:"settings,omitempty"`
// Created - READ-ONLY; Gets the date this project was created.
Created *date.Time `json:"created,omitempty"`
// LastModified - READ-ONLY; Gets the date this project was last modified.
LastModified *date.Time `json:"lastModified,omitempty"`
// ThumbnailURI - READ-ONLY; Gets the thumbnail url representing the project.
ThumbnailURI *string `json:"thumbnailUri,omitempty"`
}
func (p Project) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Project.
ProjectSettings represents settings associated with a project.
type ProjectSettings struct {
// DomainID - Gets or sets the id of the Domain to use with this project.
DomainID *uuid.UUID `json:"domainId,omitempty"`
// ClassificationType - Gets or sets the classification type of the project. Possible values include: 'Multiclass', 'Multilabel'
ClassificationType Classifier `json:"classificationType,omitempty"`
}
Region ...
type Region struct {
// TagID - Id of the tag associated with this region.
TagID *uuid.UUID `json:"tagId,omitempty"`
Left *float64 `json:"left,omitempty"`
Top *float64 `json:"top,omitempty"`
Width *float64 `json:"width,omitempty"`
Height *float64 `json:"height,omitempty"`
}
RegionProposal ...
type RegionProposal struct {
// Confidence - READ-ONLY
Confidence *float64 `json:"confidence,omitempty"`
// BoundingBox - READ-ONLY
BoundingBox *BoundingBox `json:"boundingBox,omitempty"`
}
func (rp RegionProposal) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RegionProposal.
StoredImagePrediction result of an image classification request.
type StoredImagePrediction struct {
// ResizedImageURI - READ-ONLY; The URI to the (resized) prediction image.
ResizedImageURI *string `json:"resizedImageUri,omitempty"`
// ThumbnailURI - READ-ONLY; The URI to the thumbnail of the original prediction image.
ThumbnailURI *string `json:"thumbnailUri,omitempty"`
// OriginalImageURI - READ-ONLY; The URI to the original prediction image.
OriginalImageURI *string `json:"originalImageUri,omitempty"`
// Domain - READ-ONLY; Domain used for the prediction.
Domain *uuid.UUID `json:"domain,omitempty"`
// ID - READ-ONLY
ID *uuid.UUID `json:"id,omitempty"`
// Project - READ-ONLY
Project *uuid.UUID `json:"project,omitempty"`
// Iteration - READ-ONLY
Iteration *uuid.UUID `json:"iteration,omitempty"`
// Created - READ-ONLY
Created *date.Time `json:"created,omitempty"`
// Predictions - READ-ONLY
Predictions *[]Prediction `json:"predictions,omitempty"`
}
func (sip StoredImagePrediction) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for StoredImagePrediction.
Tag represents a Tag.
type Tag struct {
autorest.Response `json:"-"`
// ID - READ-ONLY; Gets the Tag ID.
ID *uuid.UUID `json:"id,omitempty"`
// Name - Gets or sets the name of the tag.
Name *string `json:"name,omitempty"`
// Description - Gets or sets the description of the tag.
Description *string `json:"description,omitempty"`
// Type - Gets or sets the type of the tag. Possible values include: 'Regular', 'Negative'
Type TagType `json:"type,omitempty"`
// ImageCount - READ-ONLY; Gets the number of images with this tag.
ImageCount *int32 `json:"imageCount,omitempty"`
}
func (t Tag) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Tag.
TagPerformance represents performance data for a particular tag in a trained iteration.
type TagPerformance struct {
// ID - READ-ONLY
ID *uuid.UUID `json:"id,omitempty"`
// Name - READ-ONLY
Name *string `json:"name,omitempty"`
// Precision - READ-ONLY; Gets the precision.
Precision *float64 `json:"precision,omitempty"`
// PrecisionStdDeviation - READ-ONLY; Gets the standard deviation for the precision.
PrecisionStdDeviation *float64 `json:"precisionStdDeviation,omitempty"`
// Recall - READ-ONLY; Gets the recall.
Recall *float64 `json:"recall,omitempty"`
// RecallStdDeviation - READ-ONLY; Gets the standard deviation for the recall.
RecallStdDeviation *float64 `json:"recallStdDeviation,omitempty"`
// AveragePrecision - READ-ONLY; Gets the average precision when applicable.
AveragePrecision *float64 `json:"averagePrecision,omitempty"`
}
func (tp TagPerformance) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TagPerformance.
TagType enumerates the values for tag type.
type TagType string
const (
// Negative ...
Negative TagType = "Negative"
// Regular ...
Regular TagType = "Regular"
)
func PossibleTagTypeValues() []TagType
PossibleTagTypeValues returns an array of possible values for the TagType const type.
| Name | Synopsis |
|---|---|
| .. | |
| trainingapi | |