Package google.cloud.vision.v1p3beta1

색인

ImageAnnotator

얼굴, 랜드마크, 로고, 라벨, 텍스트 인식 등 클라이언트 이미지에 대한 Google Cloud Vision API 감지 태스크를 수행하는 서비스입니다. ImageAnnotator 서비스는 이미지에서 감지된 항목을 반환합니다.

AsyncBatchAnnotateFiles

rpc AsyncBatchAnnotateFiles(AsyncBatchAnnotateFilesRequest) returns (Operation)

여러 페이지를 포함할 수 있고 페이지당 여러 이미지를 포함할 수 있는 PDF 파일과 같은 일반 파일 목록에 대해 비동기 이미지 감지 및 주석을 실행합니다. google.longrunning.Operations 인터페이스를 통해 진행 상태 및 결과를 가져올 수 있습니다. Operation.metadata에는 OperationMetadata(메타데이터)가 포함됩니다. Operation.response에는 AsyncBatchAnnotateFilesResponse(결과)가 포함됩니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

자세한 내용은 인증 개요를 참조하세요.

BatchAnnotateImages

rpc BatchAnnotateImages(BatchAnnotateImagesRequest) returns (BatchAnnotateImagesResponse)

이미지 배치에 대한 이미지 감지 및 주석을 실행합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

자세한 내용은 인증 개요를 참조하세요.

ProductSearch

제품 검색에 사용할 참조 이미지의 Product 및 ProductSet를 관리합니다. 다음 리소스 모델을 사용합니다.

  • API에는 projects/*/locations/*/productSets/*라는 ProductSet 리소스 컬렉션이 있습니다. 이는 ID를 제한하기 위해 서로 다른 제품을 그룹에 배치하는 데 사용됩니다.

동시에

  • API에는 projects/*/locations/*/products/*라는 Product 리소스 모음이 있습니다.

  • Product에는 projects/*/locations/*/products/*/referenceImages/*라는 ReferenceImage 리소스 모음이 있습니다.

AddProductToProductSet

rpc AddProductToProductSet(AddProductToProductSetRequest) returns (Empty)

지정된 ProductSet에 Product를 추가합니다. Product가 이미 존재하는 경우 변경되지 않습니다.

Product 1개를 최대 100개의 ProductSet에 추가할 수 있습니다.

발생 가능한 오류:

  • Product 또는 ProductSet가 존재하지 않는 경우 NOT_FOUND를 반환합니다.
승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

자세한 내용은 인증 개요를 참조하세요.

CreateProduct

rpc CreateProduct(CreateProductRequest) returns (Product)

새 제품 리소스를 만들고 반환합니다.

발생 가능한 오류:

  • display_name이 누락되었거나 4,096자를 초과하면 INVALID_ARGUMENT를 반환합니다.
  • 설명이 4,096자를 초과하면 INVALID_ARGUMENT를 반환합니다.
  • product_category가 누락되었거나 잘못된 경우 INVALID_ARGUMENT를 반환합니다.
승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

자세한 내용은 인증 개요를 참조하세요.

CreateProductSet

rpc CreateProductSet(CreateProductSetRequest) returns (ProductSet)

새 ProductSet 리소스를 만들고 반환합니다.

발생 가능한 오류:

  • display_name이 없거나 4,096자를 초과하면 INVALID_ARGUMENT를 반환합니다.
승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

자세한 내용은 인증 개요를 참조하세요.

CreateReferenceImage

rpc CreateReferenceImage(CreateReferenceImageRequest) returns (ReferenceImage)

새 ReferenceImage 리소스를 만들고 반환합니다.

bounding_poly 필드는 선택사항입니다. bounding_poly를 지정하지 않으면 시스템이 상위 제품의 product_category와 호환되는 이미지에서 관심 리전을 감지합니다. 이를 지정하면 감지를 항상 건너뜁니다. 시스템에서 다각형을 회전되지 않은 직사각형으로 변환합니다.

이미지 해상도가 너무 커서(50MP 초과) 처리할 수 없으면 파이프라인이 이미지 크기를 조절합니다.

발생 가능한 오류:

  • image_uri가 없거나 4,096자(영문 기준)를 초과하면 INVALID_ARGUMENT를 반환합니다.
  • product가 없으면 INVALID_ARGUMENT를 반환합니다.
  • bounds_poly가 제공되지 않고 상위 제품의 product_category와 호환되지 않는 항목이 없으면 INVALID_ARGUMENT를 반환합니다.
  • bounds_poly에 10개를 초과하는 다각형이 포함되어 있으면 INVALID_ARGUMENT를 반환합니다.
승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

자세한 내용은 인증 개요를 참조하세요.

DeleteProduct

rpc DeleteProduct(DeleteProductRequest) returns (Empty)

제품 및 해당 참조 이미지를 영구적으로 삭제합니다.

제품과 모든 이미지의 메타데이터는 즉시 삭제되지만, 제품을 포함하는 ProductSet에 대한 검색 쿼리는 모든 관련 캐시가 새로고침될 때까지 작동할 수 있습니다.

발생 가능한 오류:

  • Product가 없는 경우 NOT_FOUND를 반환합니다.
승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

자세한 내용은 인증 개요를 참조하세요.

DeleteProductSet

rpc DeleteProductSet(DeleteProductSetRequest) returns (Empty)

ProductSet를 영구적으로 삭제합니다. ProductSet의 Product 및 ReferenceImage는 삭제되지 않습니다.

실제 이미지 파일은 Google Cloud Storage에서 삭제되지 않습니다.

발생 가능한 오류:

  • ProductSet가 없는 경우 NOT_FOUND를 반환합니다.
승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

자세한 내용은 인증 개요를 참조하세요.

DeleteReferenceImage

rpc DeleteReferenceImage(DeleteReferenceImageRequest) returns (Empty)

참조 이미지를 영구적으로 삭제합니다.

이미지 메타데이터는 즉시 삭제되지만, 이미지를 포함하는 ProductSet에 대한 검색 쿼리는 모든 관련 캐시가 새로고침될 때까지 작동할 수 있습니다.

실제 이미지 파일은 Google Cloud Storage에서 삭제되지 않습니다.

발생 가능한 오류:

  • 참조 이미지가 없으면 NOT_FOUND를 반환합니다.
승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

자세한 내용은 인증 개요를 참조하세요.

GetProduct

rpc GetProduct(GetProductRequest) returns (Product)

Product와 연결된 정보를 가져옵니다.

발생 가능한 오류:

  • Product가 없는 경우 NOT_FOUND를 반환합니다.
승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

자세한 내용은 인증 개요를 참조하세요.

GetProductSet

rpc GetProductSet(GetProductSetRequest) returns (ProductSet)

ProductSet와 연결된 정보를 가져옵니다.

발생 가능한 오류:

  • ProductSet가 없는 경우 NOT_FOUND를 반환합니다.
승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

자세한 내용은 인증 개요를 참조하세요.

GetReferenceImage

rpc GetReferenceImage(GetReferenceImageRequest) returns (ReferenceImage)

ReferenceImage와 연결된 정보를 가져옵니다.

발생 가능한 오류:

  • 지정된 이미지가 없으면 NOT_FOUND를 반환합니다.
승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

자세한 내용은 인증 개요를 참조하세요.

ImportProductSets

rpc ImportProductSets(ImportProductSetsRequest) returns (Operation)

이미지 정보 목록을 기반으로 지정된 제품 세트로 참조 이미지 목록을 가져오는 비동기 API입니다.

google.longrunning.Operation API를 사용하여 요청 진행 상태와 결과를 추적할 수 있습니다. Operation.metadata에는 BatchOperationMetadata가 포함됩니다. (진행 사항) Operation.response에는 ImportProductSetsResponse가 포함됩니다. (결과)

이 메서드의 입력 소스는 Google Cloud Storage의 csv 파일입니다. csv 파일의 형식은 ImportProductSetsGcsSource.csv_file_uri를 참조하세요.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

자세한 내용은 인증 개요를 참조하세요.

ListProductSets

rpc ListProductSets(ListProductSetsRequest) returns (ListProductSetsResponse)

지정되지 않은 순서로 ProductSet를 나열합니다.

발생 가능한 오류:

  • page_size가 100보다 크거나 1보다 작으면 INVALID_ARGUMENT를 반환합니다.
승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

자세한 내용은 인증 개요를 참조하세요.

ListProducts

rpc ListProducts(ListProductsRequest) returns (ListProductsResponse)

지정되지 않은 순서로 제품을 나열합니다.

발생 가능한 오류:

  • page_size가 100보다 크거나 1보다 작으면 INVALID_ARGUMENT를 반환합니다.
승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

자세한 내용은 인증 개요를 참조하세요.

ListProductsInProductSet

rpc ListProductsInProductSet(ListProductsInProductSetRequest) returns (ListProductsInProductSetResponse)

ProductSet의 Product를 지정되지 않은 순서로 나열합니다. ProductSet가 없으면 응답의 제품 필드가 비어 있게 됩니다.

발생 가능한 오류:

  • page_size가 100보다 크거나 1보다 작으면 INVALID_ARGUMENT를 반환합니다.
승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

자세한 내용은 인증 개요를 참조하세요.

ListReferenceImages

rpc ListReferenceImages(ListReferenceImagesRequest) returns (ListReferenceImagesResponse)

참조 이미지를 나열합니다.

발생 가능한 오류:

  • 상위 제품이 없으면 NOT_FOUND를 반환합니다.
  • page_size가 100보다 크거나 1보다 작으면 INVALID_ARGUMENT를 반환합니다.
승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

자세한 내용은 인증 개요를 참조하세요.

RemoveProductFromProductSet

rpc RemoveProductFromProductSet(RemoveProductFromProductSetRequest) returns (Empty)

지정된 ProductSet에서 Product를 삭제합니다.

발생 가능한 오류:

  • ProductSet에서 Product를 찾을 수 없는 경우 NOT_FOUND를 반환합니다.
승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

자세한 내용은 인증 개요를 참조하세요.

UpdateProduct

rpc UpdateProduct(UpdateProductRequest) returns (Product)

Product 리소스를 변경합니다. 현재는 display_name, description, labels 필드만 업데이트할 수 있습니다.

라벨이 업데이트되는 경우 다음 색인 시간까지 변경사항이 쿼리에 반영되지 않습니다.

발생 가능한 오류:

  • Product가 없는 경우 NOT_FOUND를 반환합니다.
  • display_name이 update_mask에 있지만 요청에서 누락되었거나 4,096자를 초과하는 경우 INVALID_ARGUMENT를 반환합니다.
  • update_mask에 설명이 있지만 4,096자를 초과하는 경우 INVALID_ARGUMENT를 반환합니다.
  • product_category가 update_mask에 제공된 경우 INVALID_ARGUMENT를 반환합니다.
승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

자세한 내용은 인증 개요를 참조하세요.

UpdateProductSet

rpc UpdateProductSet(UpdateProductSetRequest) returns (ProductSet)

ProductSet 리소스를 변경합니다. 현재 display_name만 업데이트할 수 있습니다.

발생 가능한 오류:

  • ProductSet가 없는 경우 NOT_FOUND를 반환합니다.
  • display_name이 update_mask에 있지만 요청에서 누락되었거나 4,096자를 초과하는 경우 INVALID_ARGUMENT를 반환합니다.
승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

자세한 내용은 인증 개요를 참조하세요.

AddProductToProductSetRequest

AddProductToProductSet 메서드에 대한 요청 메시지입니다.

필드
name

string

수정할 ProductSet의 리소스 이름입니다.

형식은 projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID입니다.

product

string

이 ProductSet에 추가할 Product의 리소스 이름입니다.

형식은 projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID입니다.

AnnotateFileResponse

단일 파일 주석 요청에 대한 응답입니다. 파일에는 개별 응답이 있는 하나 이상의 이미지가 포함될 수 있습니다.

필드
input_config

InputConfig

이 응답이 생성된 파일에 대한 정보입니다.

responses[]

AnnotateImageResponse

파일 내에서 발견된 이미지에 대한 개별 응답입니다.

AnnotateImageRequest

사용자가 제공한 기능으로 사용자가 제공한 이미지에 대한 Google Cloud Vision API 작업을 수행하기 위한 요청입니다.

필드
image

Image

처리할 이미지입니다.

features[]

Feature

요청한 기능입니다.

image_context

ImageContext

이미지와 함께 제공될 수 있는 추가 컨텍스트입니다.

AnnotateImageResponse

이미지 주석 요청에 대한 응답입니다.

필드
face_annotations[]

FaceAnnotation

있는 경우 얼굴 인식이 성공적으로 완료된 것입니다.

landmark_annotations[]

EntityAnnotation

있는 경우 랜드마크 인식이 성공적으로 완료된 것입니다.

logo_annotations[]

EntityAnnotation

있는 경우 로고 인식이 성공적으로 완료된 것입니다.

label_annotations[]

EntityAnnotation

있는 경우 라벨 인식이 성공적으로 완료된 것입니다.

localized_object_annotations[]

LocalizedObjectAnnotation

있는 경우 현지화된 객체 인식이 성공적으로 완료된 것입니다. 이는 신뢰도 점수를 기준으로 내림차순으로 정렬됩니다.

text_annotations[]

EntityAnnotation

있는 경우 텍스트(OCR) 인식이 성공적으로 완료된 것입니다.

full_text_annotation

TextAnnotation

있는 경우 텍스트(OCR) 인식 또는 문서(OCR) 텍스트 인식이 성공적으로 완료된 것입니다. 이 주석은 OCR에서 감지한 텍스트의 계층 구조를 보여줍니다.

safe_search_annotation

SafeSearchAnnotation

있는 경우 세이프서치 주석이 성공적으로 완료된 것입니다.

image_properties_annotation

ImageProperties

있는 경우 이미지 속성이 성공적으로 추출된 것입니다.

crop_hints_annotation

CropHintsAnnotation

있는 경우 자르기 힌트가 성공적으로 완료된 것입니다.

web_detection

WebDetection

있는 경우 웹 감지가 성공적으로 완료된 것입니다.

product_search_results

ProductSearchResults

있는 경우 제품 검색이 성공적으로 완료된 것입니다.

error

Status

설정한 경우 작업의 오류 메시지가 표시됩니다. error가 설정되어 있더라도 작성된 이미지 주석의 정확성이 보장됩니다.

context

ImageAnnotationContext

있는 경우 이미지의 출처를 파악하기 위해 컨텍스트 정보가 필요합니다.

AsyncAnnotateFileRequest

오프라인 파일 주석 요청입니다.

필드
input_config

InputConfig

필수. 입력 파일에 대한 정보입니다.

features[]

Feature

필수. 요청한 기능입니다.

image_context

ImageContext

파일의 이미지와 함께 제공될 수 있는 추가 컨텍스트입니다.

output_config

OutputConfig

필수. 원하는 출력 위치와 메타데이터(예: 형식)입니다.

AsyncAnnotateFileResponse

단일 오프라인 파일 주석 요청에 대한 응답입니다.

필드
output_config

OutputConfig

AsyncAnnotateFileRequest의 출력 위치 및 메타데이터입니다.

AsyncBatchAnnotateFilesRequest

여러 비동기 파일 주석 요청이 단일 서비스 호출로 일괄 처리됩니다.

필드
requests[]

AsyncAnnotateFileRequest

이 배치에 대한 개별 비동기 파일 주석 요청입니다.

AsyncBatchAnnotateFilesResponse

비동기 배치 파일 주석 요청에 대한 응답입니다.

필드
responses[]

AsyncAnnotateFileResponse

파일 주석 응답 목록으로서 AsyncBatchAnnotateFilesRequest의 각 요청당 하나씩 존재합니다.

BatchAnnotateImagesRequest

여러 이미지 주석 요청이 단일 서비스 호출로 일괄 처리됩니다.

필드
requests[]

AnnotateImageRequest

이 배치에 대한 개별 이미지 주석 요청입니다.

BatchAnnotateImagesResponse

배치 이미지 주석 요청에 대한 응답입니다.

필드
responses[]

AnnotateImageResponse

배치 내의 이미지 주석 요청에 대한 개별 응답입니다.

BatchOperationMetadata

현재 상태와 같은 배치 작업의 메타데이터입니다.

이는 google::longrunning::Operations 서비스의 GetOperation 호출에서 반환한 Operationmetadata 필드에 포함됩니다.

필드
state

State

배치 작업의 현재 상태입니다.

submit_time

Timestamp

일괄 요청이 서버에 제출된 시간입니다.

end_time

Timestamp

일괄 요청이 완료되고 google.longrunning.Operation.done이 true로 설정된 시간입니다.

상태

일괄 요청이 가질 수 있는 상태를 열거합니다.

열거형
STATE_UNSPECIFIED 잘못된 상태입니다.
PROCESSING 요청이 처리되고 있습니다.
SUCCESSFUL 요청이 완료되었으며 하나 이상의 항목이 성공적으로 처리되었습니다.
FAILED 요청이 완료되었으며 성공적으로 처리된 항목이 없습니다.
CANCELLED 사용자가 longrunning.Operations.CancelOperation을 호출한 후에 요청이 완료되었습니다. cancel 명령어 전에 처리된 모든 레코드는 요청에 지정된 대로 출력됩니다.

Block

페이지의 논리적 요소

필드
property

TextProperty

블록에 대해 인식된 추가 정보입니다.

bounding_box

BoundingPoly

블록의 경계 상자입니다. 꼭짓점은 왼쪽 위, 오른쪽 위, 오른쪽 아래, 왼쪽 아래 순서입니다. 경계 상자의 회전이 감지되면 텍스트를 '자연스러운' 방향으로 읽을 때 정의된 대로 왼쪽 위 모서리를 기준으로 회전하여 표시됩니다. 예를 들면 다음과 같습니다.

  • 가로 텍스트는 다음과 같이 표시됩니다.
    0----1
    |    |
    3----2
  • 왼쪽 위 모서리를 기준으로 180도 회전하면 다음과 같이 됩니다.
    2----3
    |    |
    1----0

꼭짓점 순서는 여전히 (0, 1, 2, 3)입니다.

paragraphs[]

Paragraph

이 블록의 단락 목록입니다(이 블록이 텍스트 유형인 경우).

block_type

BlockType

이 블록에서 인식된 블록 유형(텍스트, 이미지 등)입니다.

confidence

float

블록에 대한 OCR 결과의 신뢰도입니다. 범위 [0, 1]

BlockType

OCR에서 식별한 블록 유형(텍스트, 이미지 등)입니다.

열거형
UNKNOWN 알 수 없는 블록 유형입니다.
TEXT 일반 텍스트 블록입니다.
TABLE 테이블 블록입니다.
PICTURE 이미지 블록입니다.
RULER 가로/세로선 상자입니다.
BARCODE 바코드 블록입니다.

BoundingPoly

인식된 이미지 주석의 경계 다각형입니다.

필드
vertices[]

Vertex

경계 다각형의 꼭짓점입니다.

normalized_vertices[]

NormalizedVertex

경계 다각형의 정규화된 꼭짓점입니다.

ColorInfo

RGB 채널, 점수, 이미지에서 색상이 차지하는 비율로 구성된 색상 정보입니다.

필드
color

Color

색상의 RGB 구성요소입니다.

score

float

이 색상에 대한 이미지별 지수입니다. [0, 1] 범위의 값입니다.

pixel_fraction

float

이미지에서 색상이 차지하는 픽셀 비율입니다. [0, 1] 범위의 값입니다.

CreateProductRequest

CreateProduct 메서드에 대한 요청 메시지입니다.

필드
parent

string

Product를 만들어야 하는 프로젝트입니다.

형식은 projects/PROJECT_ID/locations/LOC_ID입니다.

product

Product

만들 제품입니다.

product_id

string

이 Product에 사용자가 제공한 리소스 ID입니다. 이 값을 설정하면 서버에서 리소스 ID로 이 값을 사용합니다. 이미 사용 중인 경우 ALREADY_EXISTS 코드와 함께 오류가 반환됩니다. 128자(영문 기준) 이하여야 합니다. / 문자를 포함할 수 없습니다.

CreateProductSetRequest

CreateProductSet 메서드에 대한 요청 메시지입니다.

필드
parent

string

ProductSet를 만들어야 하는 프로젝트입니다.

형식은 projects/PROJECT_ID/locations/LOC_ID입니다.

product_set

ProductSet

만들 ProductSet입니다.

product_set_id

string

이 ProductSet에 사용자가 제공한 리소스 ID입니다. 이 값을 설정하면 서버에서 리소스 ID로 이 값을 사용합니다. 이미 사용 중인 경우 ALREADY_EXISTS 코드와 함께 오류가 반환됩니다. 128자(영문 기준) 이하여야 합니다. / 문자를 포함할 수 없습니다.

CreateReferenceImageRequest

CreateReferenceImage 메서드에 대한 요청 메시지입니다.

필드
parent

string

참조 이미지를 만들 제품의 리소스 이름입니다.

형식은 projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID입니다.

reference_image

ReferenceImage

만들 참조 이미지입니다. 이미지 ID가 지정되었으면 무시됩니다.

reference_image_id

string

참조 이미지를 추가할 사용자 제공 리소스 ID입니다. 이 값을 설정하면 서버에서 리소스 ID로 이 값을 사용합니다. 이미 사용 중인 경우 ALREADY_EXISTS 코드와 함께 오류가 반환됩니다. 128자(영문 기준) 이하여야 합니다. / 문자를 포함할 수 없습니다.

CropHint

이미지를 제공할 때 새 자르기를 생성하는 데 사용되는 단일 자르기 힌트입니다.

필드
bounding_poly

BoundingPoly

잘라낼 영역의 경계 다각형입니다. 경계 상자의 좌표는 ImageParams에서 반환된 것처럼 원본 이미지의 축척입니다.

confidence

float

이 두드러진 영역의 신뢰도입니다. 범위 [0, 1]

importance_fraction

float

이 두드러진 영역의 원본 이미지와 관련한 중요도 비율입니다.

CropHintsAnnotation

이미지를 제공할 때 새 자르기를 생성하는 데 사용되는 자르기 힌트 세트입니다.

필드
crop_hints[]

CropHint

자르기 힌트 결과입니다.

CropHintsParams

자르기 힌트 주석 요청의 매개변수입니다.

필드
aspect_ratios[]

float

부동 소수점 수 단위의 가로세로 비율로서 이미지 높이에 대한 너비의 비율을 나타냅니다. 예를 들어 원하는 가로세로 비율이 4/3인 경우 해당하는 부동 소수점 수 값은 1.33333이어야 합니다. 지정하지 않으면 가능한 최상의 자르기가 반환됩니다. 가로세로 비율 수는 최대 16개로 제한됩니다. 16개 이후에 제공되는 모든 가로세로 비율은 무시됩니다.

DeleteProductRequest

DeleteProduct 메서드에 대한 요청 메시지입니다.

필드
name

string

삭제할 제품의 리소스 이름입니다.

형식은 projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID입니다.

DeleteProductSetRequest

DeleteProductSet 메서드에 대한 요청 메시지입니다.

필드
name

string

삭제할 ProductSet의 리소스 이름입니다.

형식은 projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID입니다.

DeleteReferenceImageRequest

DeleteReferenceImage 메서드에 대한 요청 메시지입니다.

필드
name

string

삭제할 참조 이미지의 리소스 이름입니다.

형식은 다음과 같습니다.

projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID

DominantColorsAnnotation

주된 색상 및 해당 색상 지수의 모음입니다.

필드
colors[]

ColorInfo

지수 및 픽셀 비율이 있는 RGB 색상 값입니다.

EntityAnnotation

감지된 항목 특성 세트입니다.

필드
mid

string

불투명한 항목 ID입니다. 일부 ID는 Google Knowledge Graph Search API에서 확인할 수 있습니다.

locale

string

항목 텍스트 description을 표현하는 데 사용된 언어 코드입니다.

description

string

locale 언어로 표현된 항목 텍스트 설명입니다.

score

float

결과의 전체 지수입니다. 범위 [0, 1]

confidence
(deprecated)

float

지원 중단됩니다. 대신 score를 사용하세요. 이미지에서 항목 인식의 정확도입니다. 예를 들어 '에펠탑' 항목이 인식된 이미지의 경우 이 필드는 쿼리 이미지에 타워가 있을 확률을 나타냅니다. 범위 [0, 1]

topicality

float

이미지에 대한 ICA(이미지 콘텐츠 주석) 라벨의 관련성입니다. 예를 들어 각 이미지에 타워가 있을 확률이 동일하더라도 멀리 있는 고층 빌딩이 감지된 이미지보다는 '에펠탑'이 감지된 이미지와 '타워'의 관련성이 더 높습니다. 범위 [0, 1]

bounding_poly

BoundingPoly

이 항목이 속한 이미지 영역입니다. LABEL_DETECTION 특성에 대해서는 생성되지 않았습니다.

locations[]

LocationInfo

감지된 항목의 위치 정보입니다. 하나의 위치가 이미지에 나온 현장의 위치를 나타내고 다른 위치가 이미지를 찍은 장소의 위치를 나타낼 수 있으므로 여러 LocationInfo 요소가 표시될 수 있습니다. 일반적으로 랜드마크의 경우 위치 정보가 표시됩니다.

properties[]

Property

일부 항목에는 항목을 충족하는 점수 또는 문자열과 같이 사용자가 제공한 선택적 Property(이름/값) 필드가 포함될 수 있습니다.

FaceAnnotation

얼굴 주석 객체에는 얼굴 인식 결과가 포함됩니다.

필드
bounding_poly

BoundingPoly

얼굴 주변 경계의 다각형입니다. 경계 상자의 좌표는 ImageParams에서 반환된 것처럼 원본 이미지의 축척입니다. 경계 상자는 인간의 기대치에 부합되게 얼굴을 '프레임' 안에 넣도록 연산되며, 랜드마커 결과를 기반으로 합니다. 주석을 달 이미지에 얼굴이 부분적으로 표시되는 경우에 한해 하나 이상의 X 또는 Y 좌표가 BoundingPoly에 생성되지 않을 수 있으며, 이 경우 다각형이 결합되지 않습니다.

fd_bounding_poly

BoundingPoly

fd_bounding_poly 경계 다각형은 boundingPoly보다 얼굴에 더 밀착되며 얼굴의 피부 부분만 둘러싸서 결합한 다각형입니다. 대개 이미지에 표시되는 '피부의 양'을 감지하는 이미지 분석에서 얼굴을 제거하는 데 사용됩니다. 랜드마커 결과를 기반으로 하지 않으며, 초기 얼굴 인식만 기준으로 하므로

fd

(얼굴 인식) 프리픽스를 사용합니다.

landmarks[]

Landmark

감지된 얼굴 특징입니다.

roll_angle

float

롤각. 얼굴에 직각인 축에 대해 이미지 수직선을 기준으로 얼굴의 시계 방향/반시계 방향의 정도를 나타냅니다. 범위 [-180,180]

pan_angle

float

요각. 이미지와 직각인 수직면을 기준으로 얼굴의 왼쪽/오른쪽 각도를 나타냅니다. 범위 [-180,180]

tilt_angle

float

피치각. 이미지의 수평면을 기준으로 얼굴을 위로 들거나 아래로 숙인 각도를 나타냅니다. 범위 [-180,180]

detection_confidence

float

감지 신뢰도입니다. 범위 [0, 1]

landmarking_confidence

float

얼굴 특징 신뢰도입니다. 범위 [0, 1]

joy_likelihood

Likelihood

기쁨 가능성입니다.

sorrow_likelihood

Likelihood

슬픔 가능성입니다.

anger_likelihood

Likelihood

분노 가능성입니다.

surprise_likelihood

Likelihood

놀라움 가능성입니다.

under_exposed_likelihood

Likelihood

노출 부족 가능성입니다.

blurred_likelihood

Likelihood

블러 가능성입니다.

headwear_likelihood

Likelihood

모자 가능성입니다.

랜드마크

얼굴별 특징(예: 얼굴 이목구비)입니다.

필드
type

Type

얼굴 특징 유형입니다.

position

Position

얼굴 특징의 위치입니다.

유형

얼굴 특징 유형입니다. 왼쪽과 오른쪽은 사진의 전형적인 거울 투영을 고려하지 않고 이미지를 보는 사람의 관점에서 정의됩니다. 따라서 일반적으로 LEFT_EYE는 사람의 오른쪽 눈입니다.

열거형
UNKNOWN_LANDMARK 알 수 없는 얼굴 특징이 감지되었습니다. 작성되어서는 안 됩니다.
LEFT_EYE 왼쪽 눈입니다.
RIGHT_EYE 오른쪽 눈입니다.
LEFT_OF_LEFT_EYEBROW 왼쪽 눈썹의 왼쪽입니다.
RIGHT_OF_LEFT_EYEBROW 왼쪽 눈썹의 오른쪽입니다.
LEFT_OF_RIGHT_EYEBROW 오른쪽 눈썹의 왼쪽입니다.
RIGHT_OF_RIGHT_EYEBROW 오른쪽 눈썹의 오른쪽입니다.
MIDPOINT_BETWEEN_EYES 눈 사이의 중간점입니다.
NOSE_TIP 코끝입니다.
UPPER_LIP 윗입술입니다.
LOWER_LIP 아랫입술입니다.
MOUTH_LEFT 입 왼쪽입니다.
MOUTH_RIGHT 입 오른쪽입니다.
MOUTH_CENTER 입의 중심입니다.
NOSE_BOTTOM_RIGHT 코의 오른쪽 맨 아래 부분입니다.
NOSE_BOTTOM_LEFT 코의 왼쪽 맨 아래 부분입니다.
NOSE_BOTTOM_CENTER 코의 맨 아래 중심입니다.
LEFT_EYE_TOP_BOUNDARY 왼쪽 눈의 상단 경계입니다.
LEFT_EYE_RIGHT_CORNER 왼쪽 눈의 오른쪽에 있는 눈머리입니다.
LEFT_EYE_BOTTOM_BOUNDARY 왼쪽 눈의 하단 경계입니다.
LEFT_EYE_LEFT_CORNER 왼쪽 눈의 왼쪽에 있는 눈꼬리입니다.
RIGHT_EYE_TOP_BOUNDARY 오른쪽 눈의 상단 경계입니다.
RIGHT_EYE_RIGHT_CORNER 오른쪽 눈의 오른쪽에 있는 눈꼬리입니다.
RIGHT_EYE_BOTTOM_BOUNDARY 오른쪽 눈의 하단 경계입니다.
RIGHT_EYE_LEFT_CORNER 오른쪽 눈의 왼쪽에 있는 눈머리입니다.
LEFT_EYEBROW_UPPER_MIDPOINT 왼쪽 눈썹의 상단 중간점입니다.
RIGHT_EYEBROW_UPPER_MIDPOINT 오른쪽 눈썹의 상단 중간점입니다.
LEFT_EAR_TRAGION 왼쪽 귀의 이주입니다.
RIGHT_EAR_TRAGION 오른쪽 귀의 이주입니다.
LEFT_EYE_PUPIL 왼쪽 눈동자입니다.
RIGHT_EYE_PUPIL 오른쪽 눈동자입니다.
FOREHEAD_GLABELLA 이마의 미간 부분입니다.
CHIN_GNATHION 아래턱의 끝점입니다.
CHIN_LEFT_GONION 턱 왼쪽의 하악각입니다.
CHIN_RIGHT_GONION 턱 오른쪽의 하악각입니다.

기능

수행할 Google Cloud Vision API 감지 유형과 해당 유형에 반환될 최대 결과 수입니다. features 목록에서 Feature 객체를 여러 개 지정할 수 있습니다.

필드
type

Type

특성 유형입니다.

max_results

int32

이 유형의 최대 결과 수입니다. TEXT_DETECTION, DOCUMENT_TEXT_DETECTION 또는 CROP_HINTS에는 적용되지 않습니다.

model

string

이 특성에 사용할 모델입니다. 지원되는 값은 'builtin/stable'(설정되지 않은 경우 기본값) 및 'builtin/latest'입니다.

유형

추출할 Google Cloud Vision API 특성의 유형입니다.

열거형
TYPE_UNSPECIFIED 지정되지 않은 특성 유형입니다.
FACE_DETECTION 얼굴 인식을 실행합니다.
LANDMARK_DETECTION 랜드마크 인식을 실행합니다.
LOGO_DETECTION 로고 인식을 실행합니다.
LABEL_DETECTION 라벨 인식을 실행합니다.
TEXT_DETECTION 텍스트 인식/광학 문자 인식(OCR)을 실행합니다. 텍스트 인식은 큰 이미지 내의 텍스트 영역에 최적화되어 있습니다. 이미지가 문서인 경우 DOCUMENT_TEXT_DETECTION을 대신 사용하세요.
DOCUMENT_TEXT_DETECTION 밀집된 텍스트 문서 OCR을 실행합니다. DOCUMENT_TEXT_DETECTIONTEXT_DETECTION이 모두 존재하는 경우 우선 적용됩니다.
SAFE_SEARCH_DETECTION 세이프서치를 실행하여 안전하지 않거나 바람직하지 않은 콘텐츠를 감지합니다.
IMAGE_PROPERTIES 이미지의 주요 색상과 같은 이미지 속성의 집합을 계산합니다.
CROP_HINTS 자르기 힌트를 실행합니다.
WEB_DETECTION 웹 감지를 실행합니다.
OBJECT_LOCALIZATION 객체 감지를 위해 로컬라이저를 실행합니다.

GcsDestination

출력이 기록될 Google Cloud Storage 위치입니다.

필드
uri

string

결과가 저장될 Google Cloud Storage URI입니다. 결과는 JSON 형식이며 해당 입력 URI가 앞에 옵니다. 이 필드는 단일 파일 또는 여러 출력의 프리픽스를 나타낼 수 있습니다. 프리픽스는 /로 끝나야 합니다.

예를 들면 다음과 같습니다.

출력이 여러 개 있는 경우에도 각 응답은 여전히 AnnotateFileResponse이며, 각각 전체 AnnotateImageResponse 목록에 대한 하위 집합을 포함합니다. 출력 JSON이 너무 크고 샤딩된 여러 파일에 오버플로될 경우 등에 출력이 여러 번 발생할 수 있습니다.

GcsSource

입력을 읽을 Google Cloud Storage 위치입니다.

필드
uri

string

입력 파일의 Google Cloud Storage URI입니다. Google Cloud Storage 객체여야 합니다. 현재 와일드 카드는 지원되지 않습니다.

GetProductRequest

GetProduct 메서드에 대한 요청 메시지입니다.

필드
name

string

가져올 Product의 리소스 이름입니다.

형식은 projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID입니다.

GetProductSetRequest

GetProductSet 메서드에 대한 요청 메시지입니다.

필드
name

string

가져올 ProductSet의 리소스 이름입니다.

형식은 projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID입니다.

GetReferenceImageRequest

GetReferenceImage 메서드에 대한 요청 메시지입니다.

필드
name

string

가져올 ReferenceImage의 리소스 이름입니다.

형식은 다음과 같습니다.

projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID.

이미지

Google Cloud Vision API 작업을 수행할 클라이언트 이미지입니다.

필드
content

bytes

바이트 스트림으로 나타낸 이미지 내용입니다. 참고: JSON 표현은 base64를 사용하지만, 프로토콜 버퍼는 모든 bytes 필드와 마찬가지로 순수 바이너리 표현을 사용합니다.

source

ImageSource

Google Cloud Storage 이미지 위치 또는 공개적으로 액세스 가능한 이미지 URL입니다. 이미지의 contentsource가 모두 제공되면 content가 우선 적용되며 이미지 주석 요청을 수행하는 데 사용됩니다.

ImageAnnotationContext

이미지가 파일(예: PDF)에서 생성된 경우 이 메시지는 이미지의 소스에 대한 정보를 제공합니다.

필드
uri

string

이미지를 생성하는 데 사용된 파일의 URI입니다.

page_number

int32

파일이 PDF 또는 TIFF이면 이 필드는 이미지 생성에 사용된 파일 내의 페이지 번호를 제공합니다.

ImageContext

이미지 컨텍스트 또는 기능별 매개변수입니다.

필드
lat_long_rect

LatLongRect

사용되지 않음.

language_hints[]

string

TEXT_DETECTION에 사용할 언어 목록입니다. 대부분의 경우에는 빈 값으로 두면 자동 언어 감지가 사용되어 최상의 결과를 얻을 수 있습니다. 라틴 알파벳을 사용하는 언어라면 language_hints를 설정할 필요가 없습니다. 드문 경우지만, 이미지에 포함된 텍스트의 언어를 알고 있는 경우 힌트를 설정하면 결과가 나아지기도 합니다. 단, 힌트가 잘못되었다면 심각한 지장이 발생합니다. 지정한 언어 중 지원되는 언어가 아닌 언어가 하나라도 있으면 텍스트 인식 시 오류가 반환됩니다.

crop_hints_params

CropHintsParams

자르기 힌트 주석 요청의 매개변수입니다.

product_search_params

ProductSearchParams

제품 검색을 위한 매개변수입니다.

web_detection_params

WebDetectionParams

웹 감지를 위한 매개변수입니다.

ImageProperties

주요 색상과 같은 이미지 속성을 저장합니다.

필드
dominant_colors

DominantColorsAnnotation

있는 경우 주요 색상이 성공적으로 완료된 것입니다.

ImageSource

외부 이미지 소스입니다(Google Cloud Storage 또는 웹 URL 이미지 위치).

필드
gcs_image_uri

string

대신 image_uri를 사용하세요.

gs://bucket_name/object_name 형식의 Google Cloud Storage URI입니다. 객체 버전 관리는 지원되지 않습니다. 자세한 내용은 Google Cloud Storage 요청 URI를 참조하세요.

image_uri

string

소스 이미지의 URI입니다. 다음 중 하나일 수 있습니다.

  1. gs://bucket_name/object_name 형식의 Google Cloud Storage URI입니다. 객체 버전 관리는 지원되지 않습니다. 자세한 내용은 Google Cloud Storage 요청 URI를 참조하세요.

  2. 공개적으로 액세스 가능한 이미지 HTTP/HTTPS URL: HTTP/HTTPS URL에서 이미지를 가져올 때 Google은 요청 완료를 보장할 수 없습니다. 지정된 호스트가 요청을 거부하거나(예: 요청 제한 또는 DOS 예방으로 인해) Google이 악용 방지를 위해 해당 사이트에 대한 요청을 제한하는 경우 요청이 실패할 수 있습니다. 프로덕션 애플리케이션의 외부 호스팅 이미지에 의존하면 안 됩니다.

gcs_image_uriimage_uri가 모두 지정된 경우 image_uri가 우선 적용됩니다.

ImportProductSetsGcsSource

각 행에 ImportProductSetRequests 목록을 보관하는 csv 파일의 Google Cloud Storage 위치입니다.

필드
csv_file_uri

string

입력 csv 파일의 Google Cloud Storage URI입니다.

URI는 gs://로 시작해야 합니다.

입력 csv 파일의 형식은 한 줄에 이미지 하나를 포함해야 합니다. 각 줄에는 8개의 열이 있습니다.

  1. image-uri
  2. image-id
  3. product-set-id
  4. product_id
  5. product-category
  6. product-display-name
  7. labels
  8. bounding-poly

image-uri, product-set-id, product-id, product-category 열이 필요합니다. 다른 모든 열은 선택사항입니다.

product-set-idproduct-id 값으로 지정된 ProductSet 또는 Product가 없으면 시스템에서 이미지의 새 ProductSet 또는 Product를 생성합니다. 이 경우 product-display-name 열은 display_name을 참조하고 product-category 열은 product_category를 참조하며 labels 열은 product_labels를 참조합니다.

image-id 열은 선택사항이지만 고유해야 합니다(제공할 경우). 비어 있으면 시스템에서 자동으로 고유한 ID를 이미지에 할당합니다.

product-display-name 열은 선택사항입니다. 비어 있으면 시스템에서 제품의 display_name 필드를 공백(' ')으로 설정합니다. 나중에 API를 사용하여 display_name을 업데이트할 수 있습니다.

product-id가 있는 지정된 Product가 이미 있으면 시스템은 product-display-name, product-category, labels 열을 무시합니다.

labels 열(선택사항)은 다음과 같은 형식의 쉼표로 구분된 키-값 쌍 목록을 포함하는 행입니다.

"key_1=value_1,key_2=value_2,...,key_n=value_n"

bounding-poly 열(선택사항)은 CreateReferenceImage와 동일한 방식으로 이미지에서 관심 리전을 식별합니다. bounding-poly 열을 지정하지 않으면 시스템에서 자동으로 관심 리전을 감지합니다.

한 줄에 최대 1개의 bounding-poly 열이 허용됩니다. 이미지에 여러 관심 리전이 포함되어 있는 경우 동일한 제품 정보를 포함하는 행을 CSV 파일에 추가하고, 각 관심 리전의 bounding-poly 값을 추가합니다.

bounding-poly 열에는 'p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y' 형식의 쉼표로 구분된 짝수 개의 숫자가 포함되어야 합니다. 절대 경계 다각형의 경우 음수가 아닌 정수를, 정규화된 경계 다각형의 경우 [0, 1] 범위의 부동 소수점 값을 사용합니다.

이미지 해상도가 너무 커서(20MP 초과) 처리할 수 없으면 시스템이 이미지 크기를 조절합니다.

ImportProductSetsInputConfig

ImportProductSets 메서드의 입력 콘텐츠입니다.

필드
gcs_source

ImportProductSetsGcsSource

각 행에 ImportProductSetRequests 목록을 보관하는 csv 파일의 Google Cloud Storage 위치입니다.

ImportProductSetsRequest

ImportProductSets 메서드에 대한 요청 메시지입니다.

필드
parent

string

ProductSet를 가져올 프로젝트입니다.

형식은 projects/PROJECT_ID/locations/LOC_ID입니다.

input_config

ImportProductSetsInputConfig

요청 목록의 입력 콘텐츠입니다.

ImportProductSetsResponse

ImportProductSets 메서드에 대한 응답 메시지입니다.

이 메시지는 반환된 google.longrunning.Operation.response 필드의 google.longrunning.Operations.GetOperation 메서드에서 반환됩니다.

필드
reference_images[]

ReferenceImage

성공적으로 가져온 reference_images 목록입니다.

statuses[]

Status

각 ImportProductSet 요청의 성공 및 오류를 포함한 rpc 상태입니다.

여기서 상태 개수는 csv 파일의 행 수와 일치하며, statuses[i]는 csv의 0번째 행부터 i번째 행의 처리 상태(성공 또는 실패)를 저장합니다.

InputConfig

원하는 입력 위치 및 메타데이터입니다.

필드
gcs_source

GcsSource

입력을 읽을 Google Cloud Storage 위치입니다.

mime_type

string

파일 유형입니다. 현재는 'application/pdf' 및 'image/tiff'만 지원됩니다. 와일드 카드는 지원되지 않습니다.

LatLongRect

최소 및 최대 LatLng 쌍으로 결정되는 직사각형입니다.

필드
min_lat_lng

LatLng

최소 위도/경도 쌍입니다.

max_lat_lng

LatLng

최대 위도/경도 쌍입니다.

Likelihood

여러 모델 업그레이드에서 고객에게 매우 안정적인 결과를 제공하기 위해 버킷화된 가능성의 표현입니다.

열거형
UNKNOWN 알 수 없는 가능성입니다.
VERY_UNLIKELY 이미지가 지정된 카테고리에 속할 가능성이 매우 낮습니다.
UNLIKELY 이미지가 지정된 카테고리에 속할 가능성이 낮습니다.
POSSIBLE 이미지가 지정된 카테고리에 속할 가능성이 있습니다.
LIKELY 이미지가 지정된 카테고리에 속할 가능성이 높습니다.
VERY_LIKELY 이미지가 지정된 카테고리에 속할 가능성이 매우 높습니다.

ListProductSetsRequest

ListProductSets 메서드에 대한 요청 메시지입니다.

필드
parent

string

ProductSet를 나열할 프로젝트입니다.

형식은 projects/PROJECT_ID/locations/LOC_ID입니다.

page_size

int32

반환할 최대 항목 수입니다. 10(기본값), 최대 100입니다.

page_token

string

이전 List 요청에서 반환된 next_page_token입니다(있는 경우).

ListProductSetsResponse

ListProductSets 메서드에 대한 응답 메시지입니다.

필드
product_sets[]

ProductSet

ProductSet의 목록입니다.

next_page_token

string

결과의 다음 페이지를 검색하는 토큰으로, 목록에 결과가 더 이상 없으면 비어 있습니다.

ListProductsInProductSetRequest

ListProductsInProductSet 메서드에 대한 요청 메시지입니다.

필드
name

string

Product를 검색할 ProductSet 리소스입니다.

형식은 projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID입니다.

page_size

int32

반환할 최대 항목 수입니다. 10(기본값), 최대 100입니다.

page_token

string

이전 List 요청에서 반환된 next_page_token입니다(있는 경우).

ListProductsInProductSetResponse

ListProductsInProductSet 메서드에 대한 응답 메시지입니다.

필드
products[]

Product

제품 목록입니다.

next_page_token

string

결과의 다음 페이지를 검색하는 토큰으로, 목록에 결과가 더 이상 없으면 비어 있습니다.

ListProductsRequest

ListProducts 메서드에 대한 요청 메시지입니다.

필드
parent

string

Product를 나열할 프로젝트 또는 ProductSet입니다.

형식은 projects/PROJECT_ID/locations/LOC_ID입니다.

page_size

int32

반환할 최대 항목 수입니다. 10(기본값), 최대 100입니다.

page_token

string

이전 List 요청에서 반환된 next_page_token입니다(있는 경우).

ListProductsResponse

ListProducts 메서드에 대한 응답 메시지입니다.

필드
products[]

Product

제품 목록입니다.

next_page_token

string

결과의 다음 페이지를 검색하는 토큰으로, 목록에 결과가 더 이상 없으면 비어 있습니다.

ListReferenceImagesRequest

ListReferenceImages 메서드에 대한 요청 메시지입니다.

필드
parent

string

참조 이미지가 포함된 제품의 리소스 이름입니다.

형식은 projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID입니다.

page_size

int32

반환할 최대 항목 수입니다. 10(기본값), 최대 100입니다.

page_token

string

반환할 결과 페이지를 식별하는 토큰입니다. 이전 참조 이미지 목록 요청에서 반환된 nextPageToken의 값입니다.

지정하지 않으면 기본적으로 첫 번째 페이지가 지정됩니다.

ListReferenceImagesResponse

ListReferenceImages 메서드에 대한 응답 메시지입니다.

필드
reference_images[]

ReferenceImage

참조 이미지 목록입니다.

page_size

int32

반환할 최대 항목 수입니다. 10(기본값), 최대 100입니다.

next_page_token

string

이전 List 요청에서 반환된 next_page_token입니다(있는 경우).

LocalizedObjectAnnotation

경계 상자를 사용해 감지된 객체 집합입니다.

필드
mid

string

EntityAnnotation이 중간에 정렬되어야 하는 객체 ID입니다.

language_code

string

BCP-47 언어 코드(예: 'en-US' 또는 'sr-Latn') 자세한 내용은 http://www.unicode.org/reports/tr35/#Unicode_locale_identifier를 참조하세요.

name

string

language_code 언어로 표현된 객체 이름입니다.

score

float

결과의 점수입니다. 범위 [0, 1]

bounding_poly

BoundingPoly

이 객체가 속한 이미지 영역입니다. 반드시 채워야 하는 필드입니다.

LocationInfo

감지된 항목 위치 정보입니다.

필드
lat_lng

LatLng

위도/경도 위치 좌표입니다.

NormalizedVertex

꼭짓점은 이미지의 2D 점을 나타냅니다. 참고: 정규화된 꼭짓점 좌표는 원본 이미지를 기준으로 하며 범위는 0에서 1 사이입니다.

필드
x

float

X 좌표입니다.

y

float

Y 좌표입니다.

Zero coordinate values


The general format for bounding polys in the JSON response when detected is an array of 4 vertex objects:
  • [{"x": 0.063,"y": 0.018},{"x": 0.123,"y": 0.018},{"x": 0.123,"y": 0.038},{"x": 0.063,"y": 0.038}]
When the API detects a coordinate ("x" or "y") value of 0.0, that coordinate is omitted in the JSON response. For example, a response could take the following form: [{},{"x": 0.028}, {"x": 0.028,"y": 0.043},{"y": 0.043}]. This response shows all three representation possibilities:
  • {} - an empty object when both "x":0.0 and "y":0.0.
  • {"x": 0.028} and {"y": 0.043} - an object with a single key-value pair when one coordinate is 0.0 but the other is a non-zero value.
  • {"x": 0.028,"y": 0.043} - an object with both key-value pairs when both coordinates have a non-zero value.

OperationMetadata

BatchAnnotateImages 작업의 메타데이터를 포함합니다.

필드
state

State

일괄 처리 작업의 현재 상태입니다.

create_time

Timestamp

일괄 요청이 수신된 시간입니다.

update_time

Timestamp

작업 결과가 마지막으로 업데이트된 시간입니다.

상태

일괄 작업 상태입니다.

열거형
STATE_UNSPECIFIED 잘못된 상태입니다.
CREATED 요청이 수신되었습니다.
RUNNING 요청이 처리되고 있습니다.
DONE 일괄 처리가 완료되었습니다.
CANCELLED 일괄 처리가 취소되었습니다.

OutputConfig

원하는 출력 위치 및 메타데이터입니다.

필드
gcs_destination

GcsDestination

출력을 기록할 Google Cloud Storage 위치입니다.

batch_size

int32

Google Cloud Storage의 각 출력 JSON 파일에 넣을 응답 proto의 최대 개수입니다. 유효한 범위는 [1, 100]입니다. 지정되지 않은 경우 기본값은 20입니다.

예를 들어 100페이지로 된 PDF 파일 1개의 경우 100개의 응답 proto가 생성됩니다. batch_size = 20인 경우 각각 20개의 응답 proto가 포함된 5개의 json 파일이 gcs_destination.uri 프리픽스로 기록됩니다.

현재 batch_size는 GcsDestination에만 적용되며 향후 다른 출력 구성에도 지원될 수 있습니다.

Page

OCR에서 감지된 페이지

필드
property

TextProperty

페이지에서 감지된 추가 정보입니다.

width

int32

페이지 너비입니다. PDF의 단위는 점입니다. 이미지(TIFF 포함)의 단위는 픽셀입니다.

height

int32

페이지 높이입니다. PDF의 단위는 점입니다. 이미지(TIFF 포함)의 단위는 픽셀입니다.

blocks[]

Block

이 페이지에 있는 텍스트, 이미지 등의 블록 목록입니다.

confidence

float

페이지에 대한 OCR 결과의 신뢰도입니다. 범위 [0, 1]

Paragraph

특정 순서로 단어 수를 나타내는 텍스트의 구조적 단위

필드
property

TextProperty

단락에 대해 감지된 추가 정보입니다.

bounding_box

BoundingPoly

단락의 경계 상자입니다. 꼭짓점은 왼쪽 위, 오른쪽 위, 오른쪽 아래, 왼쪽 아래 순서입니다. 경계 상자의 회전이 감지되면 텍스트를 '자연스러운' 방향으로 읽을 때 정의된 대로 왼쪽 위 모서리를 기준으로 회전하여 표시됩니다. 예: * 텍스트가 가로인 경우 다음과 같이 표시됩니다. 0----1 | | 3----2 * 왼쪽 위 모서리를 기준으로 180도 회전하면 2----3 | | 1----0이 되고 꼭짓점 순서는 여전히 (0, 1, 2, 3)입니다.

words[]

Word

이 단락의 단어 목록입니다.

confidence

float

단락의 OCR 결과 신뢰도입니다. 범위 [0, 1]

Position

이미지의 3D 위치로서 주로 얼굴 인식 특징에 사용됩니다. 유효한 위치에는 X 및 Y 좌표가 둘 다 있어야 합니다. 위치 좌표는 원본 이미지와 축척이 동일합니다.

필드
x

float

X 좌표입니다.

y

float

Y 좌표입니다.

z

float

Z 좌표 또는 깊이입니다.

Product

Product에는 ReferenceImage가 포함되어 있습니다.

필드
name

string

제품의 리소스 이름입니다.

형식은 projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID입니다.

제품을 만들 때 이 필드는 무시됩니다.

display_name

string

이 Product에 사용자가 제공한 이름입니다. 비워 둘 수 없습니다. 4,096자(영문 기준) 이하여야 합니다.

description

string

이 제품에 저장할 사용자 제공 메타데이터입니다. 4,096자(영문 기준) 이하여야 합니다.

product_category

string

참조 이미지로 식별되는 제품의 카테고리입니다. 'homegoods', 'apparel' 또는 'toys'여야 합니다.

이 필드는 변경할 수 없습니다.

product_labels[]

KeyValue

제품에 연결할 수 있는 키-값 쌍입니다. 쿼리 시 product_labels를 기반으로 제약조건을 지정할 수 있습니다.

정수 값은 문자열로 제공될 수 있습니다(예: '1199'). 정수 값이 있는 문자열만 곧 지원될 예정인 범위 기반 제한과 일치할 수 있습니다.

여러 값을 동일한 키에 할당할 수 있습니다. 제품 하나는 최대 100개의 product_labels를 포함할 수 있습니다.

KeyValue

키-값 쌍으로 표시된 제품 라벨입니다.

필드
key

string

제품에 연결된 라벨의 키입니다. 비워두면 안 되며 128바이트를 초과할 수 없습니다.

value

string

제품에 연결된 라벨의 값입니다. 비워두면 안 되며 128바이트를 초과할 수 없습니다.

ProductSearchParams

제품 검색 요청의 매개 변수입니다.

필드
bounding_poly

BoundingPoly

이미지의 관심 영역을 감싸는 경계 다각형입니다. 선택사항. 지정하지 않으면 시스템 재량에 따라 적용됩니다.

product_set

string

비슷한 이미지 검색에 사용할 ProductSet의 리소스 이름입니다.

형식은 projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID입니다.

product_categories[]

string

검색할 제품 카테고리의 목록입니다. 현재까지 첫 번째 카테고리만 고려되고, 'homegoods', 'apparel', 'toys'를 지정해야 합니다.

filter

string

필터링 표현식입니다 제품 라벨을 기준으로 검색결과를 제한하는 데 사용될 수 있습니다. 현재까지 키-값 표현식의 AND 또는 OR이 지원됩니다. OR 내의 각 표현식은 키가 동일해야 합니다.

예를 들어 '(color = red OR color = blue) AND brand = Google'은 허용되지만 '(color = red OR brand = Google)' 또는 'color: red'는 허용되지 않습니다.

ProductSearchResults

제품 검색 요청에 대한 결과입니다.

필드
index_time

Timestamp

이 결과를 제공한 색인의 타임스탬프입니다. 이 시점 이후의 변경사항은 현재 결과에 반영되지 않습니다.

results[]

Result

결과 목록입니다(각 제품 일치당 하나).

product_grouped_results[]

GroupedResult

쿼리 이미지에서 감지된 제품별로 그룹화된 결과 목록입니다. 각 항목은 쿼리 이미지의 하나의 경계 다각형에 해당하며 해당 리전과 일치하는 제품을 포함합니다. 모든 제품별 결과의 합집합에 중복된 제품 일치가 있을 수 있습니다.

GroupedResult

쿼리 이미지의 단일 제품과 유사한 제품에 대한 정보입니다.

필드
bounding_poly

BoundingPoly

쿼리 이미지에서 감지된 제품을 감싸는 경계 다각형입니다.

results[]

Result

결과 목록입니다(각 제품 일치당 하나).

결과

제품에 대한 정보입니다.

필드
product

Product

제품입니다.

score

float

일치 신뢰도로, 0(신뢰도 없음)에서 1(완전 신뢰) 사이로 나타냅니다.

image

string

제품에서 쿼리와 가장 일치하는 이미지의 리소스 이름입니다.

ProductSet

ProductSet에는 Product가 포함됩니다. ProductSet는 최대 100만 개의 참조 이미지를 포함할 수 있습니다. 이 제한을 초과하면 주기적인 색인 생성이 실패합니다.

필드
name

string

ProductSet의 리소스 이름입니다.

형식은 projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID입니다.

ProductSet를 만들 때 이 필드는 무시됩니다.

display_name

string

이 ProductSet에 사용자가 제공한 이름입니다. 비워 둘 수 없습니다. 4,096자(영문 기준) 이하여야 합니다.

index_time

Timestamp

출력 전용. 이 ProductSet에서 마지막으로 색인이 생성된 시간입니다. 이 시점 전의 모든 업데이트가 쿼리 결과에 반영됩니다. 이 ProductSet에서 색인이 생성된 적이 없는 경우 이 타임스탬프는 기본값인 '1970-01-01T00:00:00Z'로 설정됩니다.

ProductSet를 만들 때 이 필드는 무시됩니다.

index_error

Status

출력 전용. 제품 세트의 색인 생성 중에 오류가 발생하면 이 필드가 채워집니다.

ProductSet를 만들 때 이 필드는 무시됩니다.

속성

Property는 사용자가 제공한 이름/값 쌍으로 구성됩니다.

필드
name

string

속성 이름입니다.

value

string

속성 값입니다.

uint64_value

uint64

숫자 속성의 값입니다.

ReferenceImage

ReferenceImage는 제품 이미지 및 관련 메타데이터(예: 경계 상자)를 나타냅니다.

필드
name

string

참조 이미지의 리소스 이름입니다.

형식은 다음과 같습니다.

projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID.

참조 이미지를 만들 때는 이 필드가 무시됩니다.

uri

string

참조 이미지의 Google Cloud Storage URI입니다.

URI는 gs://로 시작해야 합니다.

필수.

bounding_polys[]

BoundingPoly

참조 이미지에서 관심 영역을 감싸는 경계 다각형입니다. 선택사항. 이 필드가 비어 있으면 시스템이 관심 리전을 감지합니다. 경계 다각형은 최대 10개까지 사용됩니다.

제공된 도형이 회전되지 않은 직사각형으로 변환됩니다. 변환된 후 직사각형의 작은 모서리가 300픽셀 이상이어야 합니다. 가로세로 비율은 1:4 이하여야 합니다. 즉, 1:3은 사용할 수 있지만 1:5는 허용되지 않습니다.

RemoveProductFromProductSetRequest

RemoveProductFromProductSet 메서드에 대한 요청 메시지입니다.

필드
name

string

수정할 ProductSet의 리소스 이름입니다.

형식은 projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID입니다.

product

string

이 ProductSet에서 삭제할 Product의 리소스 이름입니다.

형식은 projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID입니다.

SafeSearchAnnotation

이미지와 관련된 특징 모음으로서, 세이프서치 카테고리(예: 성인용, 패러디, 의료, 폭력)에 대해 컴퓨터 비전 방식으로 연산됩니다.

필드
adult

Likelihood

이미지가 성인 콘텐츠일 가능성을 나타냅니다. 성인 콘텐츠에는 과도한 노출, 포르노 이미지나 만화, 성행위 묘사 등의 요소가 포함될 수 있습니다.

spoof

Likelihood

위장 이미지일 가능성을 나타냅니다. 재미있거나 불쾌감을 주도록 이미지의 정식 버전을 수정했을 가능성입니다.

medical

Likelihood

의료 관련 이미지일 가능성을 나타냅니다.

violence

Likelihood

이미지에 폭력적인 콘텐츠가 있을 가능성을 나타냅니다.

racy

Likelihood

요청 이미지에 선정적인 콘텐츠가 있을 가능성을 나타냅니다. 선정적인 콘텐츠는 노출이 심하거나 속이 미치는 의상, 교묘하게 일부분을 가린 과도한 노출, 음란하거나 도발적인 자세 또는 민감한 신체 부위의 근접 촬영을 포함하되 이에 국한되지 않습니다.

기호

단일 기호 표현

필드
property

TextProperty

기호에 대해 감지된 추가 정보입니다.

bounding_box

BoundingPoly

기호의 경계 상자입니다. 꼭짓점은 왼쪽 위, 오른쪽 위, 오른쪽 아래, 왼쪽 아래 순서입니다. 경계 상자의 회전이 감지되면 텍스트를 '자연스러운' 방향으로 읽을 때 정의된 대로 왼쪽 위 모서리를 기준으로 회전하여 표시됩니다. 예: * 텍스트가 가로인 경우 다음과 같이 표시됩니다. 0----1 | | 3----2 * 왼쪽 위 모서리를 기준으로 180도 회전하면 2----3 | | 1----0이 되고 꼭짓점 순서는 여전히 (0, 1, 2, 3)입니다.

text

string

기호의 실제 UTF-8 표현입니다.

confidence

float

기호의 OCR 결과 신뢰도입니다. 범위 [0, 1]

TextAnnotation

TextAnnotation에는 OCR 추출된 텍스트의 구조화된 표현이 포함됩니다. OCR 추출된 텍스트 구조의 계층 구조는 다음과 같습니다. TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol. Page부터 각 구조의 구성요소는 자체 속성을 추가로 가질 수 있습니다. 속성은 감지된 언어, 줄바꿈 등을 설명합니다. 자세한 내용은 아래의 TextAnnotation.TextProperty 메시지 정의를 참조하세요.

필드
pages[]

Page

OCR에서 감지한 페이지 목록입니다.

text

string

페이지에서 감지된 UTF-8 텍스트입니다.

DetectedBreak

구조적 구성요소의 감지된 시작 또는 끝입니다.

필드
type

BreakType

감지된 줄바꿈 유형입니다.

is_prefix

bool

줄바꿈을 통해 요소가 맨 앞에 오는 경우 참입니다.

BreakType

발견된 줄바꿈 유형을 나타내는 열거형입니다. 새 줄, 공백 등이 여기에 해당합니다.

열거형
UNKNOWN 알 수 없는 줄바꿈 라벨 유형입니다.
SPACE 일반 공백입니다.
SURE_SPACE 확실한 공백입니다(매우 넓음).
EOL_SURE_SPACE 줄바꿈입니다.
HYPHEN 텍스트에 없는 끝행 하이픈으로, SPACE, LEADER_SPACE 또는 LINE_BREAK와 함께 발생하지 않습니다.
LINE_BREAK 단락으로 끝나는 줄바꿈입니다.

DetectedLanguage

구조적 구성요소의 감지된 언어

필드
language_code

string

BCP-47 언어 코드(예: 'en-US' 또는 'sr-Latn') 자세한 내용은 http://www.unicode.org/reports/tr35/#Unicode_locale_identifier를 참조하세요.

confidence

float

감지된 언어의 신뢰도입니다. 범위 [0, 1]

TextProperty

구조적 구성요소에서 감지되는 추가 정보

필드
detected_languages[]

DetectedLanguage

감지된 언어와 신뢰도 목록입니다.

detected_break

DetectedBreak

감지된 텍스트 세그먼트의 시작 또는 끝입니다.

UpdateProductRequest

UpdateProduct 메서드에 대한 요청 메시지입니다.

필드
product

Product

서버에서 Product 리소스를 대체하는 Product 리소스입니다. product.name은 변경할 수 없습니다.

update_mask

FieldMask

업데이트할 필드를 지정하는 FieldMask입니다. update_mask를 지정하지 않으면 모든 변경 가능한 필드가 업데이트됩니다. 유효한 마스크 경로에는 product_labels, display_name, description이 포함됩니다.

UpdateProductSetRequest

UpdateProductSet 메서드에 대한 요청 메시지입니다.

필드
product_set

ProductSet

서버에서 ProductSet를 대체하는 ProductSet 리소스입니다.

update_mask

FieldMask

업데이트할 필드를 지정하는 FieldMask입니다. update_mask를 지정하지 않으면 모든 변경 가능한 필드가 업데이트됩니다. 유효한 마스크 경로는 display_name입니다.

Vertex

꼭짓점은 이미지의 2D 점을 나타냅니다. 참고: 꼭짓점 좌표는 원본 이미지와 축척이 동일합니다.

필드
x

int32

X 좌표입니다.

y

int32

Y 좌표입니다.

Zero coordinate values


The general format for bounding polys in the JSON response when detected is an array of 4 vertex objects:
  • [{"x": 63,"y": 18},{"x": 123,"y": 18},{"x": 123,"y": 38},{"x": 63,"y": 38}]
When the API detects a coordinate ("x" or "y") value of 0, that coordinate is omitted in the JSON response. For example, a response could take the following form: [{},{"x": 28}, {"x": 28,"y": 43},{"y": 43}]. This response shows all three representation possibilities:
  • {} - an empty object when both "x":0 and "y":0.
  • {"x": 28} and {"y": 43} - an object with a single key-value pair when one coordinate is 0 but the other is a non-zero value.
  • {"x": 28,"y": 43} - an object with both key-value pairs when both coordinates have a non-zero value.

WebDetection

인터넷에서 가져온 이미지에 대한 관련 정보입니다.

필드
web_entities[]

WebEntity

인터넷상의 유사한 이미지에서 추론된 항목입니다.

full_matching_images[]

WebImage

인터넷에서 완전히 일치하는 이미지입니다. 크기가 조절된 쿼리 이미지의 사본을 포함할 수 있습니다.

partial_matching_images[]

WebImage

인터넷에서 부분적으로 일치하는 이미지입니다. 이러한 이미지는 몇 가지 핵심 특징을 공유할 만큼 충분히 유사합니다. 예를 들어, 원본 이미지와 잘라낸 이미지가 부분적으로 일치할 수 있습니다.

pages_with_matching_images[]

WebPage

인터넷에서 일치하는 이미지가 포함된 웹페이지입니다.

visually_similar_images[]

WebImage

시각적으로 유사한 이미지 결과입니다.

best_guess_labels[]

WebLabel

요청 이미지의 주제와 가장 가까운 이미지입니다. 개방형 웹의 유사한 이미지에서 추론된 것입니다.

WebEntity

인터넷의 비슷한 이미지에서 추론한 항목입니다.

필드
entity_id

string

불투명한 항목 ID입니다.

score

float

항목의 전체 관련성 점수입니다. 정규화되지 않으므로 서로 다른 이미지 쿼리 간에 비교할 수는 없습니다.

description

string

항목의 정식 설명입니다(영어).

WebImage

온라인 이미지에 대한 메타데이터입니다.

필드
url

string

결과 이미지 URL입니다.

score

float

(지원 중단됨) 이미지의 전체 관련성 점수입니다.

WebLabel

웹 감지를 위한 추가 메타데이터를 제공하는 라벨입니다.

필드
label

string

추가 메타데이터 라벨입니다.

language_code

string

label의 BCP-47 언어 코드입니다(예: 'en-US' 또는 'sr-Latn'). 자세한 내용은 http://www.unicode.org/reports/tr35/#Unicode_locale_identifier를 참조하세요.

WebPage

웹페이지의 메타데이터입니다.

필드
url

string

결과 웹페이지 URL입니다.

score

float

(지원 중단됨) 웹페이지의 전반적인 관련성 점수입니다.

page_title

string

웹페이지의 제목으로서 HTML 마크업이 포함될 수 있습니다.

full_matching_images[]

WebImage

페이지에서 완전히 일치하는 이미지입니다. 크기가 조절된 쿼리 이미지의 사본을 포함할 수 있습니다.

partial_matching_images[]

WebImage

페이지에서 부분적으로 일치하는 이미지입니다. 이러한 이미지는 몇 가지 핵심 특징을 공유할 만큼 충분히 유사합니다. 예를 들어, 원본 이미지와 잘라낸 이미지가 부분적으로 일치할 수 있습니다.

WebDetectionParams

웹 감지 요청의 매개변수입니다.

필드
include_geo_results

bool

이미지에 지리 정보에서 파생된 결과를 포함할지 여부입니다.

Word

단어 표현입니다.

필드
property

TextProperty

단어에 대해 감지된 추가 정보입니다.

bounding_box

BoundingPoly

단어의 경계 상자입니다. 꼭짓점은 왼쪽 위, 오른쪽 위, 오른쪽 아래, 왼쪽 아래 순서입니다. 경계 상자의 회전이 감지되면 텍스트를 '자연스러운' 방향으로 읽을 때 정의된 대로 왼쪽 위 모서리를 기준으로 회전하여 표시됩니다. 예: * 텍스트가 가로인 경우 다음과 같이 표시됩니다. 0----1 | | 3----2 * 왼쪽 위 모서리를 기준으로 180도 회전하면 2----3 | | 1----0이 되고 꼭짓점 순서는 여전히 (0, 1, 2, 3)입니다.

symbols[]

Symbol

단어 내 기호의 목록입니다. 기호의 순서는 자연스럽게 읽는 순서를 따릅니다.

confidence

float

단어의 OCR 결과 신뢰도입니다. 범위 [0, 1]