Skip to content

DetectCustomLabelsRequest

Source code in docs_src/capo_rekognition/types/detect_custom_labels_request.py 
16
17
18
19
20
21
22
23
class DetectCustomLabelsRequest(TypedDict, closed=True):
    project_version_arn: "capo_rekognition.types.project_version_arn.ProjectVersionArn"
    """<p>The ARN of the model version that you want to use. Only models associated with Custom Labels projects accepted by the operation. If a provided ARN refers to a model version associated with a project for a different feature type, then an InvalidParameterException is returned.</p>"""
    image: "capo_rekognition.types.image.Image"
    max_results: NotRequired["capo_rekognition.types.u_integer.UInteger"]
    """<p>Maximum number of results you want the service to return in the response. The service returns the specified number of highest confidence labels ranked from highest confidence to lowest.</p>"""
    min_confidence: NotRequired["capo_rekognition.types.percent.Percent"]
    """<p>Specifies the minimum confidence level for the labels to return. <code>DetectCustomLabels</code> doesn't return any labels with a confidence value that's lower than this specified value. If you specify a value of 0, <code>DetectCustomLabels</code> returns all labels, regardless of the assumed threshold applied to each label. If you don't specify a value for <code>MinConfidence</code>, <code>DetectCustomLabels</code> returns labels based on the assumed threshold of each label.</p>"""

image instance-attribute 

image: Image

max_results instance-attribute 

max_results: NotRequired[UInteger]

Maximum number of results you want the service to return in the response. The service returns the specified number of highest confidence labels ranked from highest confidence to lowest.

min_confidence instance-attribute 

min_confidence: NotRequired[Percent]

Specifies the minimum confidence level for the labels to return. DetectCustomLabels doesn't return any labels with a confidence value that's lower than this specified value. If you specify a value of 0, DetectCustomLabels returns all labels, regardless of the assumed threshold applied to each label. If you don't specify a value for MinConfidence, DetectCustomLabels returns labels based on the assumed threshold of each label.

project_version_arn instance-attribute 

project_version_arn: ProjectVersionArn

The ARN of the model version that you want to use. Only models associated with Custom Labels projects accepted by the operation. If a provided ARN refers to a model version associated with a project for a different feature type, then an InvalidParameterException is returned.