visualrecognitionv3

type Class struct {

	// The name of the class.
	ClassName *string `json:"class" validate:"required"`
}

type ClassResult struct {

	// Name of the class.
	//
	// Class names are translated in the language defined by the **Accept-Language** request header for the build-in
	// classifier IDs (`default`, `food`, and `explicit`). Class names of custom classifiers are not translated. The
	// response might not be in the specified language when the requested language is not supported or when there is no
	// translation for the class name.
	ClassName *string `json:"class" validate:"required"`

	// Confidence score for the property in the range of 0 to 1. A higher score indicates greater likelihood that the class
	// is depicted in the image. The default threshold for returning scores from a classifier is 0.5.
	Score *float32 `json:"score" validate:"required"`

	// Knowledge graph of the property. For example, `/fruit/pome/apple/eating apple/Granny Smith`. Included only if
	// identified.
	TypeHierarchy *string `json:"type_hierarchy,omitempty"`
}

type ClassifiedImage struct {

	// Source of the image before any redirects. Not returned when the image is uploaded.
	SourceURL *string `json:"source_url,omitempty"`

	// Fully resolved URL of the image after redirects are followed. Not returned when the image is uploaded.
	ResolvedURL *string `json:"resolved_url,omitempty"`

	// Relative path of the image file if uploaded directly. Not returned when the image is passed by URL.
	Image *string `json:"image,omitempty"`

	// Information about what might have caused a failure, such as an image that is too large. Not returned when there is
	// no error.
	Error *ErrorInfo `json:"error,omitempty"`

	// The classifiers.
	Classifiers []ClassifierResult `json:"classifiers" validate:"required"`
}

type ClassifiedImages struct {

	// Number of custom classes identified in the images.
	CustomClasses *int64 `json:"custom_classes,omitempty"`

	// Number of images processed for the API call.
	ImagesProcessed *int64 `json:"images_processed,omitempty"`

	// Classified images.
	Images []ClassifiedImage `json:"images" validate:"required"`

	// Information about what might cause less than optimal output. For example, a request sent with a corrupt .zip file
	// and a list of image URLs will still complete, but does not return the expected output. Not returned when there is no
	// warning.
	Warnings []WarningInfo `json:"warnings,omitempty"`
}

type Classifier struct {

	// ID of a classifier identified in the image.
	ClassifierID *string `json:"classifier_id" validate:"required"`

	// Name of the classifier.
	Name *string `json:"name" validate:"required"`

	// Unique ID of the account who owns the classifier. Might not be returned by some requests.
	Owner *string `json:"owner,omitempty"`

	// Training status of classifier.
	Status *string `json:"status,omitempty"`

	// Whether the classifier can be downloaded as a Core ML model after the training status is `ready`.
	CoreMlEnabled *bool `json:"core_ml_enabled,omitempty"`

	// If classifier training has failed, this field might explain why.
	Explanation *string `json:"explanation,omitempty"`

	// Date and time in Coordinated Universal Time (UTC) that the classifier was created.
	Created *strfmt.DateTime `json:"created,omitempty"`

	// Classes that define a classifier.
	Classes []Class `json:"classes,omitempty"`

	// Date and time in Coordinated Universal Time (UTC) that the classifier was updated. Might not be returned by some
	// requests. Identical to `updated` and retained for backward compatibility.
	Retrained *strfmt.DateTime `json:"retrained,omitempty"`

	// Date and time in Coordinated Universal Time (UTC) that the classifier was most recently updated. The field matches
	// either `retrained` or `created`. Might not be returned by some requests.
	Updated *strfmt.DateTime `json:"updated,omitempty"`
}

type ClassifierResult struct {

	// Name of the classifier.
	Name *string `json:"name" validate:"required"`

	// ID of a classifier identified in the image.
	ClassifierID *string `json:"classifier_id" validate:"required"`

	// Classes within the classifier.
	Classes []ClassResult `json:"classes" validate:"required"`
}

type Classifiers struct {

	// List of classifiers.
	Classifiers []Classifier `json:"classifiers" validate:"required"`
}

type ClassifyOptions struct {

	// An image file (.gif, .jpg, .png, .tif) or .zip file with images. Maximum image size is 10 MB. Include no more than
	// 20 images and limit the .zip file to 100 MB. Encode the image and .zip file names in UTF-8 if they contain non-ASCII
	// characters. The service assumes UTF-8 encoding if it encounters non-ASCII characters.
	//
	// You can also include an image with the **url** parameter.
	ImagesFile *os.File `json:"images_file,omitempty"`

	// The filename for imagesFile.
	ImagesFilename *string `json:"images_filename,omitempty"`

	// The content type of imagesFile.
	ImagesFileContentType *string `json:"images_file_content_type,omitempty"`

	// The URL of an image (.gif, .jpg, .png, .tif) to analyze. The minimum recommended pixel density is 32X32 pixels, but
	// the service tends to perform better with images that are at least 224 x 224 pixels. The maximum image size is 10 MB.
	//
	// You can also include images with the **images_file** parameter.
	URL *string `json:"url,omitempty"`

	// The minimum score a class must have to be displayed in the response. Set the threshold to `0.0` to return all
	// identified classes.
	Threshold *float32 `json:"threshold,omitempty"`

	// The categories of classifiers to apply. The **classifier_ids** parameter overrides **owners**, so make sure that
	// **classifier_ids** is empty.
	// - Use `IBM` to classify against the `default` general classifier. You get the same result if both **classifier_ids**
	// and **owners** parameters are empty.
	// - Use `me` to classify against all your custom classifiers. However, for better performance use **classifier_ids**
	// to specify the specific custom classifiers to apply.
	// - Use both `IBM` and `me` to analyze the image against both classifier categories.
	Owners []string `json:"owners,omitempty"`

	// Which classifiers to apply. Overrides the **owners** parameter. You can specify both custom and built-in classifier
	// IDs. The built-in `default` classifier is used if both **classifier_ids** and **owners** parameters are empty.
	//
	// The following built-in classifier IDs require no training:
	// - `default`: Returns classes from thousands of general tags.
	// - `food`: Enhances specificity and accuracy for images of food items.
	// - `explicit`: Evaluates whether the image might be pornographic.
	ClassifierIds []string `json:"classifier_ids,omitempty"`

	// The desired language of parts of the response. See the response for details.
	AcceptLanguage *string `json:"Accept-Language,omitempty"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

type CreateClassifierOptions struct {

	// The name of the new classifier. Encode special characters in UTF-8.
	Name *string `json:"name" validate:"required"`

	// A .zip file of images that depict the visual subject of a class in the new classifier. You can include more than one
	// positive example file in a call.
	//
	// Specify the parameter name by appending `_positive_examples` to the class name. For example,
	// `goldenretriever_positive_examples` creates the class **goldenretriever**.
	//
	// Include at least 10 images in .jpg or .png format. The minimum recommended image resolution is 32X32 pixels. The
	// maximum number of images is 10,000 images or 100 MB per .zip file.
	//
	// Encode special characters in the file name in UTF-8.
	PositiveExamples map[string]*os.File `json:"positive_examples" validate:"required"`

	// A .zip file of images that do not depict the visual subject of any of the classes of the new classifier. Must
	// contain a minimum of 10 images.
	//
	// Encode special characters in the file name in UTF-8.
	NegativeExamples *os.File `json:"negative_examples,omitempty"`

	// The filename for negativeExamples.
	NegativeExamplesFilename *string `json:"negative_examples_filename,omitempty"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

type DeleteClassifierOptions struct {

	// The ID of the classifier.
	ClassifierID *string `json:"classifier_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

type DeleteUserDataOptions struct {

	// The customer ID for which all data is to be deleted.
	CustomerID *string `json:"customer_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

type DetectFacesOptions struct {

	// An image file (gif, .jpg, .png, .tif.) or .zip file with images. Limit the .zip file to 100 MB. You can include a
	// maximum of 15 images in a request.
	//
	// Encode the image and .zip file names in UTF-8 if they contain non-ASCII characters. The service assumes UTF-8
	// encoding if it encounters non-ASCII characters.
	//
	// You can also include an image with the **url** parameter.
	ImagesFile *os.File `json:"images_file,omitempty"`

	// The filename for imagesFile.
	ImagesFilename *string `json:"images_filename,omitempty"`

	// The content type of imagesFile.
	ImagesFileContentType *string `json:"images_file_content_type,omitempty"`

	// The URL of an image to analyze. Must be in .gif, .jpg, .png, or .tif format. The minimum recommended pixel density
	// is 32X32 pixels, but the service tends to perform better with images that are at least 224 x 224 pixels. The maximum
	// image size is 10 MB. Redirects are followed, so you can use a shortened URL.
	//
	// You can also include images with the **images_file** parameter.
	URL *string `json:"url,omitempty"`

	// The desired language of parts of the response. See the response for details.
	AcceptLanguage *string `json:"Accept-Language,omitempty"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

type DetectedFaces struct {

	// Number of images processed for the API call.
	ImagesProcessed *int64 `json:"images_processed" validate:"required"`

	// The images.
	Images []ImageWithFaces `json:"images" validate:"required"`

	// Information about what might cause less than optimal output. For example, a request sent with a corrupt .zip file
	// and a list of image URLs will still complete, but does not return the expected output. Not returned when there is no
	// warning.
	Warnings []WarningInfo `json:"warnings,omitempty"`
}

type ErrorInfo struct {

	// HTTP status code.
	Code *int64 `json:"code" validate:"required"`

	// Human-readable error description. For example, `File size limit exceeded`.
	Description *string `json:"description" validate:"required"`

	// Codified error string. For example, `limit_exceeded`.
	ErrorID *string `json:"error_id" validate:"required"`
}

type Face struct {

	// Age information about a face.
	Age *FaceAge `json:"age,omitempty"`

	// Information about the gender of the face.
	Gender *FaceGender `json:"gender,omitempty"`

	// The location of the bounding box around the face.
	FaceLocation *FaceLocation `json:"face_location,omitempty"`
}

type FaceAge struct {

	// Estimated minimum age.
	Min *int64 `json:"min,omitempty"`

	// Estimated maximum age.
	Max *int64 `json:"max,omitempty"`

	// Confidence score in the range of 0 to 1. A higher score indicates greater confidence in the estimated value for the
	// property.
	Score *float32 `json:"score" validate:"required"`
}

type FaceGender struct {

	// Gender identified by the face. For example, `MALE` or `FEMALE`.
	Gender *string `json:"gender" validate:"required"`

	// The word for "male" or "female" in the language defined by the **Accept-Language** request header.
	GenderLabel *string `json:"gender_label" validate:"required"`

	// Confidence score in the range of 0 to 1. A higher score indicates greater confidence in the estimated value for the
	// property.
	Score *float32 `json:"score" validate:"required"`
}

type FaceLocation struct {

	// Width in pixels of face region.
	Width *float64 `json:"width" validate:"required"`

	// Height in pixels of face region.
	Height *float64 `json:"height" validate:"required"`

	// X-position of top-left pixel of face region.
	Left *float64 `json:"left" validate:"required"`

	// Y-position of top-left pixel of face region.
	Top *float64 `json:"top" validate:"required"`
}

type GetClassifierOptions struct {

	// The ID of the classifier.
	ClassifierID *string `json:"classifier_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

type GetCoreMlModelOptions struct {

	// The ID of the classifier.
	ClassifierID *string `json:"classifier_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

type ImageWithFaces struct {

	// Faces detected in the images.
	Faces []Face `json:"faces" validate:"required"`

	// Relative path of the image file if uploaded directly. Not returned when the image is passed by URL.
	Image *string `json:"image,omitempty"`

	// Source of the image before any redirects. Not returned when the image is uploaded.
	SourceURL *string `json:"source_url,omitempty"`

	// Fully resolved URL of the image after redirects are followed. Not returned when the image is uploaded.
	ResolvedURL *string `json:"resolved_url,omitempty"`

	// Information about what might have caused a failure, such as an image that is too large. Not returned when there is
	// no error.
	Error *ErrorInfo `json:"error,omitempty"`
}

type ListClassifiersOptions struct {

	// Specify `true` to return details about the classifiers. Omit this parameter to return a brief list of classifiers.
	Verbose *bool `json:"verbose,omitempty"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

type UpdateClassifierOptions struct {

	// The ID of the classifier.
	ClassifierID *string `json:"classifier_id" validate:"required"`

	// A .zip file of images that depict the visual subject of a class in the classifier. The positive examples create or
	// update classes in the classifier. You can include more than one positive example file in a call.
	//
	// Specify the parameter name by appending `_positive_examples` to the class name. For example,
	// `goldenretriever_positive_examples` creates the class `goldenretriever`.
	//
	// Include at least 10 images in .jpg or .png format. The minimum recommended image resolution is 32X32 pixels. The
	// maximum number of images is 10,000 images or 100 MB per .zip file.
	//
	// Encode special characters in the file name in UTF-8.
	PositiveExamples map[string]*os.File `json:"positive_examples,omitempty"`

	// A .zip file of images that do not depict the visual subject of any of the classes of the new classifier. Must
	// contain a minimum of 10 images.
	//
	// Encode special characters in the file name in UTF-8.
	NegativeExamples *os.File `json:"negative_examples,omitempty"`

	// The filename for negativeExamples.
	NegativeExamplesFilename *string `json:"negative_examples_filename,omitempty"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

type VisualRecognitionV3 struct {
	Service *core.BaseService
}

type VisualRecognitionV3Options struct {
	Version            string
	URL                string
	IAMApiKey          string
	IAMAccessToken     string
	IAMURL             string
	IAMClientId        string
	IAMClientSecret    string
	ICP4DAccessToken   string
	ICP4DURL           string
	AuthenticationType string
}

type WarningInfo struct {

	// Codified warning string, such as `limit_reached`.
	WarningID *string `json:"warning_id" validate:"required"`

	// Information about the error.
	Description *string `json:"description" validate:"required"`
}