API Reference
The following API reference is organized by Model Type. The actual ‘Post’ path below should be replaced with the path to the specific model API endpoint URL.
gcp_detect_safe_search
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
imageRef.Bytes (string) – Base64 encoded image. Only one of Bytes or URL should be specified
imageRef.URL (string) – URI of image. Only one of Bytes or URL should be specified
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response[].adult (string) – Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.
response[].medical (string) – Likelihood that this is a medical image.
response[].racy (string) – Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.
response[].spoof (string) – Spoof likelihood. The likelihood that an modification was made to the image’s canonical version to make it appear funny or offensive.
response[].violence (string) – Likelihood that this image contains violent content.
gcp_detect_logos
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
imageRef.Bytes (string) – Base64 encoded image. Only one of Bytes or URL should be specified
imageRef.URL (string) – URI of image. Only one of Bytes or URL should be specified
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response[].boundingPoly.normalizedVertices[].x (number) – X coordinate.
response[].boundingPoly.normalizedVertices[].y (number) – Y coordinate.
response[].boundingPoly.vertices[].x (integer) – X coordinate.
response[].boundingPoly.vertices[].y (integer) – Y coordinate.
response[].confidence (number) – Deprecated. Use `score` instead. The accuracy of the entity detection in an image. For example, for an image in which the “Eiffel Tower” entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].
response[].description (string) – Entity textual description, expressed in its locale language.
response[].locale (string) – The language code for the locale in which the entity textual description is expressed.
response[].locations[].latLng.latitude (number) – The latitude in degrees. It must be in the range [-90.0, +90.0].
response[].locations[].latLng.longitude (number) – The longitude in degrees. It must be in the range [-180.0, +180.0].
response[].mid (string) – Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).
response[].properties[].name (string) – Name of the property.
response[].properties[].uint64Value (string) – Value of numeric properties.
response[].properties[].value (string) – Value of the property.
response[].score (number) – Overall score of the result. Range [0, 1].
response[].topicality (number) – The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of “tower” is likely higher to an image containing the detected “Eiffel Tower” than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].
rekognition_detect_moderation_labels
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
HumanLoopConfig.DataAttributes.ContentClassifiers[] (string) –
HumanLoopConfig.FlowDefitinitionArn (string) –
HumanLoopConfig.HumanLoopName (string) –
Image.Bytes (string) – Base64 encoded image. Only one of Bytes or URL should be specified
Image.URL (string) – URI of image. Only one of Bytes or URL should be specified
MinConfidence (number) –
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.HumanLoopActivationOutput.HumanLoopActivationConditionsEvaluationResults (string) –
response.HumanLoopActivationOutput.HumanLoopActivationReasons[] (string) –
response.HumanLoopActivationOutput.HumanLoopArn (string) –
response.ModerationLabels[].Confidence (number) –
response.ModerationLabels[].Name (string) –
response.ModerationLabels[].ParentName (string) –
response.ModerationModelVersion (string) –
rekognition_detect_text
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
Filters.RegionsOfInterest.BoundingBox.Height (number) –
Filters.RegionsOfInterest.BoundingBox.Left (number) –
Filters.RegionsOfInterest.BoundingBox.Top (number) –
Filters.RegionsOfInterest.BoundingBox.Width (number) –
Filters.WordFilter.MinBoundingBoxHeight (number) –
Filters.WordFilter.MinBoundingBoxWidth (number) –
Filters.WordFilter.MinConfidence (number) –
Image.Bytes (string) – Base64 encoded image. Only one of Bytes or URL should be specified
Image.URL (string) – URI of image. Only one of Bytes or URL should be specified
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.TextDetectios[].Confidence (number) –
response.TextDetectios[].DetectedText (string) –
response.TextDetectios[].Geometry.BoundingBox.Height (number) –
response.TextDetectios[].Geometry.BoundingBox.Left (number) –
response.TextDetectios[].Geometry.BoundingBox.Top (number) –
response.TextDetectios[].Geometry.BoundingBox.Width (number) –
response.TextDetectios[].Geometry.Polygon[].X (number) –
response.TextDetectios[].Geometry.Polygon[].Y (number) –
response.TextDetectios[].Id (number) –
response.TextDetectios[].ParentId (number) –
response.TextDetectios[].Type (string) –
response.TextModelVersion (string) –
summarization
gcp_detect_object
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
imageRef.Bytes (string) – Base64 encoded image. Only one of Bytes or URL should be specified
imageRef.URL (string) – URI of image. Only one of Bytes or URL should be specified
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response[].boundingPoly.normalizedVertices[].x (number) – X coordinate.
response[].boundingPoly.normalizedVertices[].y (number) – Y coordinate.
response[].boundingPoly.vertices[].x (integer) – X coordinate.
response[].boundingPoly.vertices[].y (integer) – Y coordinate.
response[].languageCode (string) – The BCP-47 language code, such as “en-US” or “sr-Latn”. For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
response[].mid (string) – Object ID that should align with EntityAnnotation mid.
response[].name (string) – Object name, expressed in its language_code language.
response[].score (number) – Score of the result. Range [0, 1].
optical-character-recognition
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
Bytes (string) – Base64 encoded image. Only one of Bytes or URL should be specified
URL (string) – URI of image. Only one of Bytes or URL should be specified
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.raw_response (object) –
response.text (string) –
rekognition_compare_faces
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
QualityFilter (string) –
SimilarityThreshold (number) –
SourceImage.Bytes (string) – Base64 encoded image. Only one of Bytes or URL should be specified
SourceImage.URL (string) – URI of image. Only one of Bytes or URL should be specified
TargetImage.Bytes (string) – Base64 encoded image. Only one of Bytes or URL should be specified
TargetImage.URL (string) – URI of image. Only one of Bytes or URL should be specified
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.FaceMatches[].Face.BoundingBox.Height (number) –
response.FaceMatches[].Face.BoundingBox.Left (number) –
response.FaceMatches[].Face.BoundingBox.Top (number) –
response.FaceMatches[].Face.BoundingBox.Width (number) –
response.FaceMatches[].Face.Confidence (number) –
response.FaceMatches[].Face.Emotions[].Confidence (number) –
response.FaceMatches[].Face.Emotions[].Value (boolean) –
response.FaceMatches[].Face.Landmarks[].Type (string) –
response.FaceMatches[].Face.Landmarks[].X (number) –
response.FaceMatches[].Face.Landmarks[].Y (number) –
response.FaceMatches[].Face.Pose.Pitch (number) –
response.FaceMatches[].Face.Pose.Roll (number) –
response.FaceMatches[].Face.Pose.Yaw (number) –
response.FaceMatches[].Face.Quality.Brightness (number) –
response.FaceMatches[].Face.Quality.Sharpness (number) –
response.FaceMatches[].Face.Smile.Confidence (number) –
response.FaceMatches[].Face.Smile.Value (boolean) –
response.FaceMatches[].Similarity (number) –
response.SourceImageFace.BoundingBox.Height (number) –
response.SourceImageFace.BoundingBox.Left (number) –
response.SourceImageFace.BoundingBox.Top (number) –
response.SourceImageFace.BoundingBox.Width (number) –
response.SourceImageFace.Confidence (number) –
response.UnmatchedFaces[].BoundingBox.Height (number) –
response.UnmatchedFaces[].BoundingBox.Left (number) –
response.UnmatchedFaces[].BoundingBox.Top (number) –
response.UnmatchedFaces[].BoundingBox.Width (number) –
response.UnmatchedFaces[].Confidence (number) –
response.UnmatchedFaces[].Emotions[].Confidence (number) –
response.UnmatchedFaces[].Emotions[].Value (boolean) –
response.UnmatchedFaces[].Landmarks[].Type (string) –
response.UnmatchedFaces[].Landmarks[].X (number) –
response.UnmatchedFaces[].Landmarks[].Y (number) –
response.UnmatchedFaces[].Pose.Pitch (number) –
response.UnmatchedFaces[].Pose.Roll (number) –
response.UnmatchedFaces[].Pose.Yaw (number) –
response.UnmatchedFaces[].Quality.Brightness (number) –
response.UnmatchedFaces[].Quality.Sharpness (number) –
response.UnmatchedFaces[].Smile.Confidence (number) –
response.UnmatchedFaces[].Smile.Value (boolean) –
rekognition_detect_labels
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
Image.Bytes (string) – Base64 encoded image. Only one of Bytes or URL should be specified
Image.URL (string) – URI of image. Only one of Bytes or URL should be specified
MaxLabels (integer) –
MinConfidence (number) –
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.LabelModelVersion (string) –
response.Labels[].Confidence (number) –
response.Labels[].Instances[].BoundingBox.Height (number) –
response.Labels[].Instances[].BoundingBox.Left (number) –
response.Labels[].Instances[].BoundingBox.Top (number) –
response.Labels[].Instances[].BoundingBox.Width (number) –
response.Labels[].Instances[].Confidence (number) –
response.Labels[].Name (string) –
response.Labels[].Parents[].Name (string) –
text-classification
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
input (string) – (required)
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response[].label (string) –
response[].score (number) –
audio-classification
gcp_detect_labels
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
imageRef.Bytes (string) – Base64 encoded image. Only one of Bytes or URL should be specified
imageRef.URL (string) – URI of image. Only one of Bytes or URL should be specified
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response[].boundingPoly.normalizedVertices[].x (number) – X coordinate.
response[].boundingPoly.normalizedVertices[].y (number) – Y coordinate.
response[].boundingPoly.vertices[].x (integer) – X coordinate.
response[].boundingPoly.vertices[].y (integer) – Y coordinate.
response[].confidence (number) – Deprecated. Use `score` instead. The accuracy of the entity detection in an image. For example, for an image in which the “Eiffel Tower” entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].
response[].description (string) – Entity textual description, expressed in its locale language.
response[].locale (string) – The language code for the locale in which the entity textual description is expressed.
response[].locations[].latLng.latitude (number) – The latitude in degrees. It must be in the range [-90.0, +90.0].
response[].locations[].latLng.longitude (number) – The longitude in degrees. It must be in the range [-180.0, +180.0].
response[].mid (string) – Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).
response[].properties[].name (string) – Name of the property.
response[].properties[].uint64Value (string) – Value of numeric properties.
response[].properties[].value (string) – Value of the property.
response[].score (number) – Overall score of the result. Range [0, 1].
response[].topicality (number) – The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of “tower” is likely higher to an image containing the detected “Eiffel Tower” than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].
gcp_detect_faces
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
imageRef.Bytes (string) – Base64 encoded image. Only one of Bytes or URL should be specified
imageRef.URL (string) – URI of image. Only one of Bytes or URL should be specified
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response[].angerLikelihood (string) – Anger likelihood.
response[].blurredLikelihood (string) – Blurred likelihood.
response[].boundingPoly.normalizedVertices[].x (number) – X coordinate.
response[].boundingPoly.normalizedVertices[].y (number) – Y coordinate.
response[].boundingPoly.vertices[].x (integer) – X coordinate.
response[].boundingPoly.vertices[].y (integer) – Y coordinate.
response[].detectionConfidence (number) – Detection confidence. Range [0, 1].
response[].fdBoundingPoly.normalizedVertices[].x (number) – X coordinate.
response[].fdBoundingPoly.normalizedVertices[].y (number) – Y coordinate.
response[].fdBoundingPoly.vertices[].x (integer) – X coordinate.
response[].fdBoundingPoly.vertices[].y (integer) – Y coordinate.
response[].headwearLikelihood (string) – Headwear likelihood.
response[].joyLikelihood (string) – Joy likelihood.
response[].landmarkingConfidence (number) – Face landmarking confidence. Range [0, 1].
response[].landmarks[].position.x (number) – X coordinate.
response[].landmarks[].position.y (number) – Y coordinate.
response[].landmarks[].position.z (number) – Z coordinate (or depth).
response[].landmarks[].type (string) – Face landmark type.
response[].panAngle (number) – Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].
response[].rollAngle (number) – Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].
response[].sorrowLikelihood (string) – Sorrow likelihood.
response[].surpriseLikelihood (string) – Surprise likelihood.
response[].tiltAngle (number) – Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image’s horizontal plane. Range [-180,180].
response[].underExposedLikelihood (string) – Under-exposed likelihood.
conversational
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
input (string) – (required)
oldInputs[] (string) –
oldOutputs[] (string) –
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.conversation.generated_responses[] (string) –
response.conversation.past_user_inputs[] (string) –
response.generated_text (string) –
response.warnings[] (string) –
zero-shot-classification
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
input (string) – (required)
labels[] (string) –
multiLabel (boolean) – Whether multiple candidate labels can be true. Default False
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response[].labels[] (string) –
response[].scores[] (number) –
response[].sequence (string) –
response[].warnings[] (string) –
gcp_detect_properties
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
imageRef.Bytes (string) – Base64 encoded image. Only one of Bytes or URL should be specified
imageRef.URL (string) – URI of image. Only one of Bytes or URL should be specified
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.dominantColors.colors[].color.alpha (number) – The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
response.dominantColors.colors[].color.blue (number) – The amount of blue in the color as a value in the interval [0, 1].
response.dominantColors.colors[].color.green (number) – The amount of green in the color as a value in the interval [0, 1].
response.dominantColors.colors[].color.red (number) – The amount of red in the color as a value in the interval [0, 1].
response.dominantColors.colors[].pixelFraction (number) – The fraction of pixels the color occupies in the image. Value in range [0, 1].
response.dominantColors.colors[].score (number) – Image-specific score for this color. Value in range [0, 1].
gcp_detect_web_geo
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
imageRef.Bytes (string) – Base64 encoded image. Only one of Bytes or URL should be specified
imageRef.URL (string) – URI of image. Only one of Bytes or URL should be specified
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.bestGuessLabels[].label (string) – Label for extra metadata.
response.bestGuessLabels[].languageCode (string) – The BCP-47 language code for label, such as “en-US” or “sr-Latn”. For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
response.fullMatchingImages[].score (number) – (Deprecated) Overall relevancy score for the image.
response.fullMatchingImages[].url (string) – The result image URL.
response.pagesWithMatchingImages[].fullMatchingImages[].score (number) – (Deprecated) Overall relevancy score for the image.
response.pagesWithMatchingImages[].fullMatchingImages[].url (string) – The result image URL.
response.pagesWithMatchingImages[].pageTitle (string) – Title for the web page, may contain HTML markups.
response.pagesWithMatchingImages[].partialMatchingImages[].score (number) – (Deprecated) Overall relevancy score for the image.
response.pagesWithMatchingImages[].partialMatchingImages[].url (string) – The result image URL.
response.pagesWithMatchingImages[].score (number) – (Deprecated) Overall relevancy score for the web page.
response.pagesWithMatchingImages[].url (string) – The result web page URL.
response.partialMatchingImages[].score (number) – (Deprecated) Overall relevancy score for the image.
response.partialMatchingImages[].url (string) – The result image URL.
response.visuallySimilarImages[].score (number) – (Deprecated) Overall relevancy score for the image.
response.visuallySimilarImages[].url (string) – The result image URL.
response.webEntities[].description (string) – Canonical description of the entity, in English.
response.webEntities[].entityId (string) – Opaque entity ID.
response.webEntities[].score (number) – Overall relevancy score for the entity. Not normalized and not comparable across different image queries.
rekognition_detect_faces
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
Image.Bytes (string) – Base64 encoded image. Only one of Bytes or URL should be specified
Image.URL (string) – URI of image. Only one of Bytes or URL should be specified
QualityFilter (string) –
SimilarityThreshold (number) –
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.FaceDetails[].AgeRange.Confidence (number) –
response.FaceDetails[].AgeRange.Value (boolean) –
response.FaceDetails[].Beard.Confidence (number) –
response.FaceDetails[].Beard.Value (boolean) –
response.FaceDetails[].BoundingBox.Height (number) –
response.FaceDetails[].BoundingBox.Left (number) –
response.FaceDetails[].BoundingBox.Top (number) –
response.FaceDetails[].BoundingBox.Width (number) –
response.FaceDetails[].Confidence (number) –
response.FaceDetails[].Emotions[].Confidence (number) –
response.FaceDetails[].Emotions[].Value (boolean) –
response.FaceDetails[].Eyeglasses.Confidence (number) –
response.FaceDetails[].Eyeglasses.Value (boolean) –
response.FaceDetails[].EyesOpen.Confidence (number) –
response.FaceDetails[].EyesOpen.Value (boolean) –
response.FaceDetails[].Gender.Confidence (number) –
response.FaceDetails[].Gender.Value (boolean) –
response.FaceDetails[].Landmarks[].Type (string) –
response.FaceDetails[].Landmarks[].X (number) –
response.FaceDetails[].Landmarks[].Y (number) –
response.FaceDetails[].MouthOpen.Confidence (number) –
response.FaceDetails[].MouthOpen.Value (boolean) –
response.FaceDetails[].Mustache.Confidence (number) –
response.FaceDetails[].Mustache.Value (boolean) –
response.FaceDetails[].Pose.Pitch (number) –
response.FaceDetails[].Pose.Roll (number) –
response.FaceDetails[].Pose.Yaw (number) –
response.FaceDetails[].Quality.Brightness (number) –
response.FaceDetails[].Quality.Sharpness (number) –
response.FaceDetails[].Smile.Confidence (number) –
response.FaceDetails[].Smile.Value (boolean) –
response.FaceDetails[].Sunglasses.Confidence (number) –
response.FaceDetails[].Sunglasses.Value (boolean) –
gcp_detect_crop_hints
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
imageRef.Bytes (string) – Base64 encoded image. Only one of Bytes or URL should be specified
imageRef.URL (string) – URI of image. Only one of Bytes or URL should be specified
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.cropHints[].boundingPoly.normalizedVertices[].x (number) – X coordinate.
response.cropHints[].boundingPoly.normalizedVertices[].y (number) – Y coordinate.
response.cropHints[].boundingPoly.vertices[].x (integer) – X coordinate.
response.cropHints[].boundingPoly.vertices[].y (integer) – Y coordinate.
response.cropHints[].confidence (number) – Confidence of this being a salient region. Range [0, 1].
response.cropHints[].importanceFraction (number) – Fraction of importance of this salient region with respect to the original image.
gcp_detect_document
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
imageRef.Bytes (string) – Base64 encoded image. Only one of Bytes or URL should be specified
imageRef.URL (string) – URI of image. Only one of Bytes or URL should be specified
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.pages[].blocks[].blockType (string) – Detected block type (text, image etc) for this block.
response.pages[].blocks[].boundingBox.normalizedVertices[].x (number) – X coordinate.
response.pages[].blocks[].boundingBox.normalizedVertices[].y (number) – Y coordinate.
response.pages[].blocks[].boundingBox.vertices[].x (integer) – X coordinate.
response.pages[].blocks[].boundingBox.vertices[].y (integer) – Y coordinate.
response.pages[].blocks[].confidence (number) – Confidence of the OCR results on the block. Range [0, 1].
response.pages[].blocks[].paragraphs[].boundingBox.normalizedVertices[].x (number) – X coordinate.
response.pages[].blocks[].paragraphs[].boundingBox.normalizedVertices[].y (number) – Y coordinate.
response.pages[].blocks[].paragraphs[].boundingBox.vertices[].x (integer) – X coordinate.
response.pages[].blocks[].paragraphs[].boundingBox.vertices[].y (integer) – Y coordinate.
response.pages[].blocks[].paragraphs[].confidence (number) – Confidence of the OCR results for the paragraph. Range [0, 1].
response.pages[].blocks[].paragraphs[].property.detectedBreak.isPrefix (boolean) – True if break prepends the element.
response.pages[].blocks[].paragraphs[].property.detectedBreak.type (string) – Detected break type.
response.pages[].blocks[].paragraphs[].property.detectedLanguages[].confidence (number) – Confidence of detected language. Range [0, 1].
response.pages[].blocks[].paragraphs[].property.detectedLanguages[].languageCode (string) – The BCP-47 language code, such as “en-US” or “sr-Latn”. For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
response.pages[].blocks[].paragraphs[].words[].boundingBox.normalizedVertices[].x (number) – X coordinate.
response.pages[].blocks[].paragraphs[].words[].boundingBox.normalizedVertices[].y (number) – Y coordinate.
response.pages[].blocks[].paragraphs[].words[].boundingBox.vertices[].x (integer) – X coordinate.
response.pages[].blocks[].paragraphs[].words[].boundingBox.vertices[].y (integer) – Y coordinate.
response.pages[].blocks[].paragraphs[].words[].confidence (number) – Confidence of the OCR results for the word. Range [0, 1].
response.pages[].blocks[].paragraphs[].words[].property.detectedBreak.isPrefix (boolean) – True if break prepends the element.
response.pages[].blocks[].paragraphs[].words[].property.detectedBreak.type (string) – Detected break type.
response.pages[].blocks[].paragraphs[].words[].property.detectedLanguages[].confidence (number) – Confidence of detected language. Range [0, 1].
response.pages[].blocks[].paragraphs[].words[].property.detectedLanguages[].languageCode (string) – The BCP-47 language code, such as “en-US” or “sr-Latn”. For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
response.pages[].blocks[].paragraphs[].words[].symbols[].boundingBox.normalizedVertices[].x (number) – X coordinate.
response.pages[].blocks[].paragraphs[].words[].symbols[].boundingBox.normalizedVertices[].y (number) – Y coordinate.
response.pages[].blocks[].paragraphs[].words[].symbols[].boundingBox.vertices[].x (integer) – X coordinate.
response.pages[].blocks[].paragraphs[].words[].symbols[].boundingBox.vertices[].y (integer) – Y coordinate.
response.pages[].blocks[].paragraphs[].words[].symbols[].confidence (number) – Confidence of the OCR results for the symbol. Range [0, 1].
response.pages[].blocks[].paragraphs[].words[].symbols[].property.detectedBreak.isPrefix (boolean) – True if break prepends the element.
response.pages[].blocks[].paragraphs[].words[].symbols[].property.detectedBreak.type (string) – Detected break type.
response.pages[].blocks[].paragraphs[].words[].symbols[].property.detectedLanguages[].confidence (number) – Confidence of detected language. Range [0, 1].
response.pages[].blocks[].paragraphs[].words[].symbols[].property.detectedLanguages[].languageCode (string) – The BCP-47 language code, such as “en-US” or “sr-Latn”. For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
response.pages[].blocks[].paragraphs[].words[].symbols[].text (string) – The actual UTF-8 representation of the symbol.
response.pages[].blocks[].property.detectedBreak.isPrefix (boolean) – True if break prepends the element.
response.pages[].blocks[].property.detectedBreak.type (string) – Detected break type.
response.pages[].blocks[].property.detectedLanguages[].confidence (number) – Confidence of detected language. Range [0, 1].
response.pages[].blocks[].property.detectedLanguages[].languageCode (string) – The BCP-47 language code, such as “en-US” or “sr-Latn”. For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
response.pages[].confidence (number) – Confidence of the OCR results on the page. Range [0, 1].
response.pages[].height (integer) – Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.
response.pages[].property.detectedBreak.isPrefix (boolean) – True if break prepends the element.
response.pages[].property.detectedBreak.type (string) – Detected break type.
response.pages[].property.detectedLanguages[].confidence (number) – Confidence of detected language. Range [0, 1].
response.pages[].property.detectedLanguages[].languageCode (string) – The BCP-47 language code, such as “en-US” or “sr-Latn”. For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
response.pages[].width (integer) – Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.
response.text (string) – UTF-8 text detected on the pages.
gcp_detect_web
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
imageRef.Bytes (string) – Base64 encoded image. Only one of Bytes or URL should be specified
imageRef.URL (string) – URI of image. Only one of Bytes or URL should be specified
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.bestGuessLabels[].label (string) – Label for extra metadata.
response.bestGuessLabels[].languageCode (string) – The BCP-47 language code for label, such as “en-US” or “sr-Latn”. For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
response.fullMatchingImages[].score (number) – (Deprecated) Overall relevancy score for the image.
response.fullMatchingImages[].url (string) – The result image URL.
response.pagesWithMatchingImages[].fullMatchingImages[].score (number) – (Deprecated) Overall relevancy score for the image.
response.pagesWithMatchingImages[].fullMatchingImages[].url (string) – The result image URL.
response.pagesWithMatchingImages[].pageTitle (string) – Title for the web page, may contain HTML markups.
response.pagesWithMatchingImages[].partialMatchingImages[].score (number) – (Deprecated) Overall relevancy score for the image.
response.pagesWithMatchingImages[].partialMatchingImages[].url (string) – The result image URL.
response.pagesWithMatchingImages[].score (number) – (Deprecated) Overall relevancy score for the web page.
response.pagesWithMatchingImages[].url (string) – The result web page URL.
response.partialMatchingImages[].score (number) – (Deprecated) Overall relevancy score for the image.
response.partialMatchingImages[].url (string) – The result image URL.
response.visuallySimilarImages[].score (number) – (Deprecated) Overall relevancy score for the image.
response.visuallySimilarImages[].url (string) – The result image URL.
response.webEntities[].description (string) – Canonical description of the entity, in English.
response.webEntities[].entityId (string) – Opaque entity ID.
response.webEntities[].score (number) – Overall relevancy score for the entity. Not normalized and not comparable across different image queries.
question-answering
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
context (string) – (required)
question (string) – (required)
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.answer (string) –
response.end (integer) –
response.score (number) –
response.start (integer) –
fill-mask
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
input (string) – (required)
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response[].score (number) –
response[].sequence (string) –
response[].token (integer) –
response[].token_str (string) –
image-classification
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
imageRef.Bytes (string) – Base64 encoded image. Only one of Bytes or URL should be specified
imageRef.URL (string) – URI of image. Only one of Bytes or URL should be specified
limit (integer) – Number of top classifiication results show
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.classification[].classification (string) – (required)
response.classification[].score (number) – (required)
response.error.code (integer) – (required)
response.error.message (string) – (required)
response.model (string) – (required)
gcp_detect_landmarks
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
imageRef.Bytes (string) – Base64 encoded image. Only one of Bytes or URL should be specified
imageRef.URL (string) – URI of image. Only one of Bytes or URL should be specified
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response[].boundingPoly.normalizedVertices[].x (number) – X coordinate.
response[].boundingPoly.normalizedVertices[].y (number) – Y coordinate.
response[].boundingPoly.vertices[].x (integer) – X coordinate.
response[].boundingPoly.vertices[].y (integer) – Y coordinate.
response[].confidence (number) – Deprecated. Use `score` instead. The accuracy of the entity detection in an image. For example, for an image in which the “Eiffel Tower” entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].
response[].description (string) – Entity textual description, expressed in its locale language.
response[].locale (string) – The language code for the locale in which the entity textual description is expressed.
response[].locations[].latLng.latitude (number) – The latitude in degrees. It must be in the range [-90.0, +90.0].
response[].locations[].latLng.longitude (number) – The longitude in degrees. It must be in the range [-180.0, +180.0].
response[].mid (string) – Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).
response[].properties[].name (string) – Name of the property.
response[].properties[].uint64Value (string) – Value of numeric properties.
response[].properties[].value (string) – Value of the property.
response[].score (number) – Overall score of the result. Range [0, 1].
response[].topicality (number) – The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of “tower” is likely higher to an image containing the detected “Eiffel Tower” than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].
image-object-detection
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
imageRef.Bytes (string) – Base64 encoded image. Only one of Bytes or URL should be specified
imageRef.URL (string) – URI of image. Only one of Bytes or URL should be specified
minimum_score (integer) – Filter out detections with score below this
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.detection[].bounding_box[] (number) –
response.detection[].obj_class (string) – (required)
response.detection[].score (number) – (required)
response.error.code (integer) – (required)
response.error.message (string) – (required)
response.model (string) –
translation
rekognition_detect_protective_equipment
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
Image.Bytes (string) – Base64 encoded image. Only one of Bytes or URL should be specified
Image.URL (string) – URI of image. Only one of Bytes or URL should be specified
SummarizationAttributes.MinConfidence (number) –
SummarizationAttributes.RequiredEquipmentTypes[] (string) –
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.Persons[].BodyParts[].Confidence (number) –
response.Persons[].BodyParts[].EquipmentDetections[].BoundingBox.Height (number) –
response.Persons[].BodyParts[].EquipmentDetections[].BoundingBox.Left (number) –
response.Persons[].BodyParts[].EquipmentDetections[].BoundingBox.Top (number) –
response.Persons[].BodyParts[].EquipmentDetections[].BoundingBox.Width (number) –
response.Persons[].BodyParts[].EquipmentDetections[].Confidence (number) –
response.Persons[].BodyParts[].EquipmentDetections[].CoversBodyPart.Confidence (number) –
response.Persons[].BodyParts[].EquipmentDetections[].CoversBodyPart.Value (boolean) –
response.Persons[].BodyParts[].EquipmentDetections[].Type (string) –
response.Persons[].BodyParts[].Name (string) –
response.Persons[].BoundingBox.Height (number) –
response.Persons[].BoundingBox.Left (number) –
response.Persons[].BoundingBox.Top (number) –
response.Persons[].BoundingBox.Width (number) –
response.Persons[].Confidence (number) –
response.Persons[].Id (number) –
response.ProtectiveEquipmentModelVersion (string) –
response.Summary.PersonsIndeterminate[] (number) –
response.Summary.PersonsWithRequiredEquipment[] (number) –
response.Summary.PersonsWithoutRequiredEquipment[] (number) –
gcp_detect_text
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
imageRef.Bytes (string) – Base64 encoded image. Only one of Bytes or URL should be specified
imageRef.URL (string) – URI of image. Only one of Bytes or URL should be specified
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response[].boundingPoly.normalizedVertices[].x (number) – X coordinate.
response[].boundingPoly.normalizedVertices[].y (number) – Y coordinate.
response[].boundingPoly.vertices[].x (integer) – X coordinate.
response[].boundingPoly.vertices[].y (integer) – Y coordinate.
response[].confidence (number) – Deprecated. Use `score` instead. The accuracy of the entity detection in an image. For example, for an image in which the “Eiffel Tower” entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].
response[].description (string) – Entity textual description, expressed in its locale language.
response[].locale (string) – The language code for the locale in which the entity textual description is expressed.
response[].locations[].latLng.latitude (number) – The latitude in degrees. It must be in the range [-90.0, +90.0].
response[].locations[].latLng.longitude (number) – The longitude in degrees. It must be in the range [-180.0, +180.0].
response[].mid (string) – Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).
response[].properties[].name (string) – Name of the property.
response[].properties[].uint64Value (string) – Value of numeric properties.
response[].properties[].value (string) – Value of the property.
response[].score (number) – Overall score of the result. Range [0, 1].
response[].topicality (number) – The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of “tower” is likely higher to an image containing the detected “Eiffel Tower” than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].
automatic-speech-recognition
text-generation
pose-detection
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
Bytes (string) – Base64 encoded image. Only one of Bytes or URL should be specified
URL (string) – URI of image. Only one of Bytes or URL should be specified
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.response.candidate[].body25_index (number) –
response.response.candidate[].confidence (number) – (required)
response.response.candidate[].index (number) – (required)
response.response.candidate[].x (number) – (required)
response.response.candidate[].y (number) – (required)
response.response.coco_format_subsets[][] (number) –
car_license_plate_recognizer
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
Bytes (string) – Base64 encoded image. Only one of Bytes or URL should be specified
URL (string) – URI of image. Only one of Bytes or URL should be specified
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response[].confidence (number) –
response[].coordinate.xmax (integer) –
response[].coordinate.xmin (integer) –
response[].coordinate.ymax (integer) –
response[].coordinate.ymin (integer) –
response[].label (string) –
response[].value (string) –
token-classification
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
input (string) – (required)
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response[].end (integer) –
response[].entity_group (string) –
response[].score (number) –
response[].start (integer) –
response[].word (string) –
prophet-univar-ts
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
freq (string) – Requested Frequency of forecast. (required)
periods (integer) – Integer used to indicate forecast period for the given time interval (required)
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.additive_terms[] (number) –
response.additive_terms_lower[] (number) –
response.additive_terms_upper[] (number) –
response.ds[] (string) –
response.multiplicative_terms[] (number) –
response.multiplicative_terms_lower[] (number) –
response.multiplicative_terms_upper[] (number) –
response.trend[] (number) –
response.trend_lower[] (number) –
response.trend_upper[] (number) –
response.weekly[] (number) –
response.weekly_lower[] (number) –
response.weekly_upper[] (number) –
response.yearly[] (number) –
response.yearly_lower[] (number) –
response.yearly_upper[] (number) –
response.yhat[] (number) –
response.yhat_lower[] (number) –
response.yhat_tiyaro[] (number) –
response.yhat_upper[] (number) –
autoarima-univar-ts
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
periods (integer) – Integer used to indicate forecast period for the given time interval (required)
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.prediction[] (number) –
lightgbm-univar-exo-ts
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
inputCols[] (string) –
testdata (string) – Base64 encoded CSV file that includes the test data on which the inference will be run (required)
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.prediction[] (number) –
randomforest-univar-ts
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
periods (integer) – Integer used to indicate forecast period for the given time interval (required)
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.prediction[] (number) –
randomforest-univar-exo-ts
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
inputCols[] (string) –
testdata (string) – Base64 encoded CSV file that includes the test data on which the inference will be run (required)
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.prediction[] (number) –
xgboost-univar-ts
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
periods (integer) – Integer used to indicate forecast period for the given time interval (required)
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.prediction[] (number) –
xgboost-univar-exo-ts
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
inputCols[] (string) –
testdata (string) – Base64 encoded CSV file that includes the test data on which the inference will be run (required)
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.prediction[] (number) –
sarimax-univar-ts
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
periods (integer) – Integer used to indicate forecast period for the given time interval (required)
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.prediction[] (number) –
lightgbm-univar-ts
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
periods (integer) – Integer used to indicate forecast period for the given time interval (required)
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.prediction[] (number) –
catboost-univar-exo-ts
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
inputCols[] (string) –
testdata (string) – Base64 encoded CSV file that includes the test data on which the inference will be run (required)
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.prediction[] (number) –
catboost-univar-ts
- POST /model_specific_path
- Query Parameters
serviceTier (string) – Available service tiers: [cpuflex(default), gpuflex]
- Request JSON Object
periods (integer) – Integer used to indicate forecast period for the given time interval (required)
- Status Codes
200 OK – Success
default – Unexpected error
- Response JSON Object
response.prediction[] (number) –