visualrecognitionv4

type AddImageTrainingDataOptions struct {

	// The identifier of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// The identifier of the image.
	ImageID *string `json:"image_id" validate:"required"`

	// Training data for specific objects.
	Objects []TrainingDataObject `json:"objects,omitempty"`

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

type AddImagesOptions struct {

	// The identifier of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// An array of image files (.jpg or .png) or .zip files with images.
	// - Include a maximum of 20 images in a request.
	// - Limit the .zip file to 100 MB.
	// - Limit each image file to 10 MB.
	//
	// You can also include an image with the **image_url** parameter.
	ImagesFile []FileWithMetadata `json:"images_file,omitempty"`

	// The array of URLs of image files (.jpg or .png).
	// - Include a maximum of 20 images in a request.
	// - Limit each image file to 10 MB.
	// - Minimum width and height is 30 pixels, but the service tends to perform better with images that are at least 300 x
	// 300 pixels. Maximum is 5400 pixels for either height or width.
	//
	// You can also include images with the **images_file** parameter.
	ImageURL []string `json:"image_url,omitempty"`

	// Training data for a single image. Include training data only if you add one image with the request.
	//
	// The `object` property can contain alphanumeric, underscore, hyphen, space, and dot characters. It cannot begin with
	// the reserved prefix `sys-` and must be no longer than 32 characters.
	TrainingData *string `json:"training_data,omitempty"`

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

type AnalyzeOptions struct {

	// The IDs of the collections to analyze.
	CollectionIds []string `json:"collection_ids" validate:"required"`

	// The features to analyze.
	Features []string `json:"features" validate:"required"`

	// An array of image files (.jpg or .png) or .zip files with images.
	// - Include a maximum of 20 images in a request.
	// - Limit the .zip file to 100 MB.
	// - Limit each image file to 10 MB.
	//
	// You can also include an image with the **image_url** parameter.
	ImagesFile []FileWithMetadata `json:"images_file,omitempty"`

	// An array of URLs of image files (.jpg or .png).
	// - Include a maximum of 20 images in a request.
	// - Limit each image file to 10 MB.
	// - Minimum width and height is 30 pixels, but the service tends to perform better with images that are at least 300 x
	// 300 pixels. Maximum is 5400 pixels for either height or width.
	//
	// You can also include images with the **images_file** parameter.
	ImageURL []string `json:"image_url,omitempty"`

	// The minimum score a feature must have to be returned.
	Threshold *float32 `json:"threshold,omitempty"`

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

type AnalyzeResponse struct {

	// Analyzed images.
	Images []Image `json:"images" validate:"required"`

	// Information about what might cause less than optimal output.
	Warnings []Warning `json:"warnings,omitempty"`

	// A unique identifier of the request. Included only when an error or warning is returned.
	Trace *string `json:"trace,omitempty"`
}

type Collection struct {

	// The identifier of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

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

	// The description of the collection.
	Description *string `json:"description" validate:"required"`

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

	// Date and time in Coordinated Universal Time (UTC) that the collection was most recently updated.
	Updated *strfmt.DateTime `json:"updated" validate:"required"`

	// Number of images in the collection.
	ImageCount *int64 `json:"image_count" validate:"required"`

	// Training status information for the collection.
	TrainingStatus *TrainingStatus `json:"training_status" validate:"required"`
}

type CollectionObjects struct {

	// The identifier of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// The identified objects in a collection.
	Objects []ObjectDetail `json:"objects" validate:"required"`
}

type CollectionsList struct {

	// The collections in this service instance.
	Collections []Collection `json:"collections" validate:"required"`
}

type CreateCollectionOptions struct {

	// The name of the collection. The name can contain alphanumeric, underscore, hyphen, and dot characters. It cannot
	// begin with the reserved prefix `sys-`.
	Name *string `json:"name,omitempty"`

	// The description of the collection.
	Description *string `json:"description,omitempty"`

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

type DeleteCollectionOptions struct {

	// The identifier of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

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

type DeleteImageOptions struct {

	// The identifier of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// The identifier of the image.
	ImageID *string `json:"image_id" validate:"required"`

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

type DeleteObjectOptions struct {

	// The identifier of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// The name of the object.
	Object *string `json:"object" 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 DetectedObjects struct {

	// The collections with identified objects.
	Collections []CollectionObjects `json:"collections,omitempty"`
}

type Error struct {

	// Identifier of the problem.
	Code *string `json:"code" validate:"required"`

	// An explanation of the problem with possible solutions.
	Message *string `json:"message" validate:"required"`

	// A URL for more information about the solution.
	MoreInfo *string `json:"more_info,omitempty"`

	// Details about the specific area of the problem.
	Target *ErrorTarget `json:"target,omitempty"`
}

type ErrorTarget struct {

	// The parameter or property that is the focus of the problem.
	Type *string `json:"type" validate:"required"`

	// The property that is identified with the problem.
	Name *string `json:"name" validate:"required"`
}

type FileWithMetadata struct {

	// The data / content for the file.
	Data io.ReadCloser `json:"data" validate:"required"`

	// The filename of the file.
	Filename *string `json:"filename,omitempty"`

	// The content type of the file.
	ContentType *string `json:"content_type,omitempty"`
}

type GetCollectionOptions struct {

	// The identifier of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

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

type GetImageDetailsOptions struct {

	// The identifier of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// The identifier of the image.
	ImageID *string `json:"image_id" validate:"required"`

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

type GetJpegImageOptions struct {

	// The identifier of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// The identifier of the image.
	ImageID *string `json:"image_id" validate:"required"`

	// The image size. Specify `thumbnail` to return a version that maintains the original aspect ratio but is no larger
	// than 200 pixels in the larger dimension. For example, an original 800 x 1000 image is resized to 160 x 200 pixels.
	Size *string `json:"size,omitempty"`

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

type GetModelFileOptions struct {

	// The identifier of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// The feature for the model.
	Feature *string `json:"feature" validate:"required"`

	// The format of the returned model.
	ModelFormat *string `json:"model_format" validate:"required"`

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

type GetObjectMetadataOptions struct {

	// The identifier of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// The name of the object.
	Object *string `json:"object" validate:"required"`

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

type GetTrainingUsageOptions struct {

	// The earliest day to include training events. Specify dates in YYYY-MM-DD format. If empty or not specified, the
	// earliest training event is included.
	StartTime *string `json:"start_time,omitempty"`

	// The most recent day to include training events. Specify dates in YYYY-MM-DD format. All events for the day are
	// included. If empty or not specified, the current day is used. Specify the same value as `start_time` to request
	// events for a single day.
	EndTime *string `json:"end_time,omitempty"`

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

type Image struct {

	// The source type of the image.
	Source *ImageSource `json:"source" validate:"required"`

	// Height and width of an image.
	Dimensions *ImageDimensions `json:"dimensions" validate:"required"`

	// Container for the list of collections that have objects detected in an image.
	Objects *DetectedObjects `json:"objects" validate:"required"`

	// A container for the problems in the request.
	Errors []Error `json:"errors,omitempty"`
}

type ImageDetails struct {

	// The identifier of the image.
	ImageID *string `json:"image_id,omitempty"`

	// Date and time in Coordinated Universal Time (UTC) that the image was most recently updated.
	Updated *strfmt.DateTime `json:"updated,omitempty"`

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

	// The source type of the image.
	Source *ImageSource `json:"source" validate:"required"`

	// Height and width of an image.
	Dimensions *ImageDimensions `json:"dimensions,omitempty"`

	// Details about the errors.
	Errors []Error `json:"errors,omitempty"`

	// Training data for all objects.
	TrainingData *TrainingDataObjects `json:"training_data,omitempty"`
}

type ImageDetailsList struct {

	// The images in the collection.
	Images []ImageDetails `json:"images,omitempty"`

	// Information about what might cause less than optimal output.
	Warnings []Warning `json:"warnings,omitempty"`

	// A unique identifier of the request. Included only when an error or warning is returned.
	Trace *string `json:"trace,omitempty"`
}

type ImageDimensions struct {

	// Height in pixels of the image.
	Height *int64 `json:"height,omitempty"`

	// Width in pixels of the image.
	Width *int64 `json:"width,omitempty"`
}

type ImageSource struct {

	// The source type of the image.
	Type *string `json:"type" validate:"required"`

	// Name of the image file if uploaded. Not returned when the image is passed by URL.
	Filename *string `json:"filename,omitempty"`

	// Name of the .zip file of images if uploaded. Not returned when the image is passed directly or by URL.
	ArchiveFilename *string `json:"archive_filename,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"`
}

type ImageSummary struct {

	// The identifier of the image.
	ImageID *string `json:"image_id,omitempty"`

	// Date and time in Coordinated Universal Time (UTC) that the image was most recently updated.
	Updated *strfmt.DateTime `json:"updated,omitempty"`
}

type ImageSummaryList struct {

	// The images in the collection.
	Images []ImageSummary `json:"images" validate:"required"`
}

type ListCollectionsOptions struct {

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

type ListImagesOptions struct {

	// The identifier of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

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

type ListObjectMetadataOptions struct {

	// The identifier of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

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

type Location struct {

	// Y-position of top-left pixel of the bounding box.
	Top *int64 `json:"top" validate:"required"`

	// X-position of top-left pixel of the bounding box.
	Left *int64 `json:"left" validate:"required"`

	// Width in pixels of of the bounding box.
	Width *int64 `json:"width" validate:"required"`

	// Height in pixels of the bounding box.
	Height *int64 `json:"height" validate:"required"`
}

type ObjectDetail struct {

	// The label for the object.
	Object *string `json:"object" validate:"required"`

	// Defines the location of the bounding box around the object.
	Location *Location `json:"location" validate:"required"`

	// Confidence score for the object in the range of 0 to 1. A higher score indicates greater likelihood that the object
	// is depicted at this location in the image.
	Score *float32 `json:"score" validate:"required"`
}

type ObjectMetadata struct {

	// The name of the object.
	Object *string `json:"object,omitempty"`

	// Number of bounding boxes with this object name in the collection.
	Count *int64 `json:"count,omitempty"`
}

type ObjectMetadataList struct {

	// Number of unique named objects in the collection.
	ObjectCount *int64 `json:"object_count" validate:"required"`

	// The objects in the collection.
	Objects []ObjectMetadata `json:"objects,omitempty"`
}

type ObjectTrainingStatus struct {

	// Whether you can analyze images in the collection with the **objects** feature.
	Ready *bool `json:"ready" validate:"required"`

	// Whether training is in progress.
	InProgress *bool `json:"in_progress" validate:"required"`

	// Whether there are changes to the training data since the most recent training.
	DataChanged *bool `json:"data_changed" validate:"required"`

	// Whether the most recent training failed.
	LatestFailed *bool `json:"latest_failed" validate:"required"`

	// Whether the model can be downloaded after the training status is `ready`.
	RscnnReady *bool `json:"rscnn_ready" validate:"required"`

	// Details about the training. If training is in progress, includes information about the status. If training is not in
	// progress, includes a success message or information about why training failed.
	Description *string `json:"description" validate:"required"`
}

type TrainOptions struct {

	// The identifier of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

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

type TrainingDataObject struct {

	// The name of the object.
	Object *string `json:"object,omitempty"`

	// Defines the location of the bounding box around the object.
	Location *Location `json:"location,omitempty"`
}

type TrainingDataObjects struct {

	// Training data for specific objects.
	Objects []TrainingDataObject `json:"objects,omitempty"`
}

type TrainingEvent struct {

	// Trained object type. Only `objects` is currently supported.
	Type *string `json:"type,omitempty"`

	// Identifier of the trained collection.
	CollectionID *string `json:"collection_id,omitempty"`

	// Date and time in Coordinated Universal Time (UTC) that training on the collection finished.
	CompletionTime *strfmt.DateTime `json:"completion_time,omitempty"`

	// Training status of the training event.
	Status *string `json:"status,omitempty"`

	// The total number of images that were used in training for this training event.
	ImageCount *int64 `json:"image_count,omitempty"`
}

type TrainingEvents struct {

	// The starting day for the returned training events in Coordinated Universal Time (UTC). If not specified in the
	// request, it identifies the earliest training event.
	StartTime *strfmt.DateTime `json:"start_time,omitempty"`

	// The ending day for the returned training events in Coordinated Universal Time (UTC). If not specified in the
	// request, it lists the current time.
	EndTime *strfmt.DateTime `json:"end_time,omitempty"`

	// The total number of training events in the response for the start and end times.
	CompletedEvents *int64 `json:"completed_events,omitempty"`

	// The total number of images that were used in training for the start and end times.
	TrainedImages *int64 `json:"trained_images,omitempty"`

	// The completed training events for the start and end time.
	Events []TrainingEvent `json:"events,omitempty"`
}

type TrainingStatus struct {

	// Training status for the objects in the collection.
	Objects *ObjectTrainingStatus `json:"objects" validate:"required"`
}

type UpdateCollectionOptions struct {

	// The identifier of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// The name of the collection. The name can contain alphanumeric, underscore, hyphen, and dot characters. It cannot
	// begin with the reserved prefix `sys-`.
	Name *string `json:"name,omitempty"`

	// The description of the collection.
	Description *string `json:"description,omitempty"`

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

type UpdateObjectMetadata struct {

	// The updated name of the object. The name can contain alphanumeric, underscore, hyphen, space, and dot characters. It
	// cannot begin with the reserved prefix `sys-`.
	Object *string `json:"object" validate:"required"`

	// Number of bounding boxes in the collection with the updated object name.
	Count *int64 `json:"count,omitempty"`
}

type UpdateObjectMetadataOptions struct {

	// The identifier of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// The name of the object.
	Object *string `json:"object" validate:"required"`

	// The updated name of the object. The name can contain alphanumeric, underscore, hyphen, space, and dot characters. It
	// cannot begin with the reserved prefix `sys-`.
	NewObject *string `json:"new_object" validate:"required"`

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

type VisualRecognitionV4 struct {
	Service *core.BaseService
	Version string
}

type VisualRecognitionV4Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
	Version       string
}

type Warning struct {

	// Identifier of the problem.
	Code *string `json:"code" validate:"required"`

	// An explanation of the problem with possible solutions.
	Message *string `json:"message" validate:"required"`

	// A URL for more information about the solution.
	MoreInfo *string `json:"more_info,omitempty"`
}