Method: projects.locations.corpora.searchAssets

미디어 저작물을 검색합니다.

HTTP 요청

POST https://visionai.googleapis.com/v1alpha1/{corpus=projects/*/locations/*/corpora/*}:searchAssets

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
corpus

string

필수 입력란입니다. 검색할 상위 말뭉치입니다. 형식: `projects/{projectId}/locations/{locationId}/corpora/{corpus_id}'

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "pageSize": integer,
  "pageToken": string,
  "contentTimeRanges": {
    object (DateTimeRangeArray)
  },
  "criteria": [
    {
      object (Criteria)
    }
  ],
  "exclusionCriteria": [
    {
      object (Criteria)
    }
  ],
  "facetSelections": [
    {
      object (FacetGroup)
    }
  ],
  "resultAnnotationKeys": [
    string
  ],
  "searchQuery": string,

  // Union field sort_spec can be only one of the following:
  "schemaKeySortingStrategy": {
    object (SchemaKeySortingStrategy)
  }
  // End of list of possible types for union field sort_spec.
}
필드
pageSize

integer

이 페이지에 반환할 결과의 개수입니다. 0이면 서버에서 적절한 pageSize를 결정합니다.
pageToken

string

다음 페이지를 가져오는 연속 토큰입니다. 비어 있으면 첫 번째 페이지를 가져오는 중임을 의미합니다.
contentTimeRanges

object (DateTimeRangeArray)

일치하는 동영상 콘텐츠가 포함되어야 하는 시간 범위입니다. 범위를 지정하지 않으면 시간 제한이 없습니다. 이 필드는 아래 기준과 동일하게 취급되지만 자주 사용되므로 편의를 위해 별도로 정의됩니다. endTime가 미래인 경우 요청이 수신된 시간으로 제한됩니다.
criteria[]

object (Criteria)

검색 결과에 적용되는 기준입니다.
exclusionCriteria[]

object (Criteria)

검색 결과에서 제외할 기준입니다. fetchMatchedAnnotations은 무시됩니다.
facetSelections[]

object (FacetGroup)

가장 최근의 측정기준 선택 상태를 저장합니다. 여기에는 사용자가 선택한 측정기준 그룹만 표시됩니다. 선택 상태는 선택 또는 선택 해제 중 하나입니다. 선택한 측정기준 버킷만 검색 기준으로 사용됩니다.
resultAnnotationKeys[]

string

각 검색 결과와 함께 검색하고 반환할 주석을 지정하는 주석 키 목록입니다. 주석 세분화는 GRANULARITY_ASSET_LEVEL이어야 하며 검색 전략은 NO_SEARCH가 아니어야 합니다.
searchQuery

string

전 세계 검색어입니다. 사용자가 값이 속한 필드를 지정하지 않고도 저작물을 검색할 수 있습니다.
통합 필드 sort_spec. 정렬 사양 이 필드가 지정되지 않으면 기본적으로 다음과 같이 처리됩니다. - STREAM_VIDEO: 검색 결과가 시작 시간순으로 정렬됩니다. sort_spec은 다음 중 하나여야 합니다.
schemaKeySortingStrategy

object (SchemaKeySortingStrategy)

데이터 스키마 키 아래의 값을 기준으로 정렬합니다.

응답 본문

corpora.searchAssets의 응답 메시지입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "searchResultItems": [
    {
      object (SearchResultItem)
    }
  ],
  "nextPageToken": string,
  "facetResults": [
    {
      object (FacetGroup)
    }
  ]
}
필드
searchResultItems[]

object (SearchResultItem)

반환된 검색 결과입니다.
nextPageToken

string

다음 페이지 연속 토큰입니다.
facetResults[]

object (FacetGroup)

사용자가 이미 선택한 상품 속성 값과 업데이트된 상품 속성 검색 결과가 포함된 특정 검색어의 상품 속성 검색 결과입니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

IAM 권한

corpus 리소스에 대해서는 다음 IAM 권한이 필요합니다.

  • visionai.assets.search

자세한 내용은 IAM 문서를 참조하세요.

SchemaKeySortingStrategy

데이터 스키마 키를 기준으로 정렬하는 방법을 지정하는 전략입니다.

JSON 표현 
{
  "options": [
    {
      object (Option)
    }
  ]
}
필드
options[]

object (Option)

앞의 옵션은 뒤의 옵션보다 우선순위가 높습니다.

옵션

데이터 스키마 키 1개 옵션

JSON 표현 
{
  "dataSchemaKey": string,
  "sortDecreasing": boolean,
  "aggregateMethod": enum (AggregateMethod)
}
필드
dataSchemaKey

string

정렬하는 데 사용되는 데이터입니다.
sortDecreasing

boolean

내림차순으로 정렬할지 아니면 오름차순으로 정렬할지입니다. 기본적으로 결과는 오름차순으로 정렬됩니다.
aggregateMethod

enum (AggregateMethod)

현재 데이터 스키마 키의 집계 메서드입니다.

AggregateMethod

하나의 결과에 동일한 키를 가진 값이 여러 개 있는 경우 정렬에 사용되는 값을 지정합니다. 기본적으로 결과가 내림차순으로 정렬된 경우 AGGREGATE_METHOD_LARGEST가 사용되고, 결과가 오름차순으로 정렬된 경우 AGGREGATE_METHOD_SMALLEST가 사용됩니다.

열거형
AGGREGATE_METHOD_UNSPECIFIED 지정되지 않은 집계 메서드는 위에서 언급한 대로 덮어쓰기됩니다.
AGGREGATE_METHOD_LARGEST 정렬할 가장 큰 (사전순 또는 숫자) 값을 가져옵니다.
AGGREGATE_METHOD_SMALLEST 정렬할 최소 (사전순 또는 숫자) 값을 가져옵니다.

FacetGroup

백엔드와 프런트엔드 간에 전달되는 측면 버킷 그룹입니다.

JSON 표현 
{
  "facetId": string,
  "displayName": string,
  "buckets": [
    {
      object (FacetBucket)
    }
  ],
  "bucketType": enum (FacetBucketType),
  "fetchMatchedAnnotations": boolean
}
필드
facetId

string

측정기준 그룹의 고유 ID입니다.
displayName

string

패싯의 표시 이름입니다. UI에서 측정기준 렌더링에 사용합니다.
buckets[]

object (FacetBucket)

패싯과 연결된 버킷입니다. 예를 들어 '팀' 측정기준의 경우 버킷은 49ers, patriots 등이 될 수 있습니다.
bucketType

enum (FacetBucketType)

Facet bucket type
fetchMatchedAnnotations

boolean

이 속성이 true이면 이 측정기준 그룹의 선택에 대해 쿼리 일치 주석을 반환합니다. 이 옵션은 파티션 수준 주석을 기반으로 하는 측정기준에만 적용됩니다. 다음과 같은 측정기준 값을 지원합니다. - INTEGER - STRING (DataSchema.SearchStrategy.EXACT_SEARCH만 해당)

FacetBucket

측정기준 값, 선택 상태, 메타데이터를 보유합니다.

JSON 표현 
{
  "selected": boolean,

  // Union field bucket_value can be only one of the following:
  "value": {
    object (FacetValue)
  },
  "range": {
    object (Range)
  }
  // End of list of possible types for union field bucket_value.
}
필드
selected

boolean

하나의 측정기준 버킷이 선택되었는지 여부입니다. 이 필드는 사용자의 측정기준 선택을 나타냅니다. SearchVideosRequest의 프런트엔드에서 설정합니다.
통합 필드 bucket_value. 패싯과 연결된 버킷입니다. 예를 들어 측정기준 '팀'의 버킷은 '49ers', 'patriots' 등이 될 수 있고, 측정기준 '선수'의 버킷은 'tom brady', 'drew brees' 등이 될 수 있습니다. bucket_value은 다음 중 하나일 수 있습니다.
value

object (FacetValue)

특이 값
range

object (Range)

범위 값입니다.

범위

면 분할이 적용되는 값 범위[start, end)입니다.

JSON 표현 
{
  "start": {
    object (FacetValue)
  },
  "end": {
    object (FacetValue)
  }
}
필드
start

object (FacetValue)

범위의 시작입니다. 존재하지 않는 것은 일부 경계 (예: -inf)를 나타냅니다.
end

object (FacetValue)

범위의 끝입니다. 존재하지 않는 것은 일부 경계 (예: inf)를 나타냅니다.