제한사항
검색 구성에 패싯 속성이 있는 경우 매핑된 필드는 항상 검색 기준 속성의 필드와 일치해야 합니다. 이러한 필드는 유형, 세부사항, 검색 전략이 동일한 기존 데이터 스키마여야 합니다.
검색 구성 만들기
REST
SearchConfig
리소스를 만들려면 projects.locations.corpora.searchConfigs.create
메서드를 사용하여 POST 요청을 전송합니다.
다음은 맞춤 검색 기준으로 검색 구성을 만드는 방법의 예입니다.
요청 데이터를 사용하기 전에 다음을 바꿉니다.
- REGIONALIZED_ENDPOINT: 엔드포인트에
LOCATION_ID
와 일치하는 접두사가 포함될 수 있습니다(예:europe-west4-
). 리전화된 엔드포인트에 대해 자세히 알아보세요. - PROJECT_NUMBER: Google Cloud 프로젝트 번호
- LOCATION_ID: Vertex AI Vision을 사용하는 리전입니다. 예를 들면
us-central1
,europe-west4
입니다. 사용 가능한 리전을 참고하세요. - CORPUS_ID: 타겟 코퍼스의 ID입니다.
- SEARCHCONFIG: 타겟
SearchConfig
의 이름입니다. - 이 예시의
SearchConfig
는person
입니다.
HTTP 메서드 및 URL:
POST https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs?search_config_id=person
JSON 요청 본문:
{ "search_criteria_property": { "mapped_fields": "player", "mapped_fields": "coach", "mapped_fields": "cheerleader", } }
요청을 보내려면 다음 옵션 중 하나를 선택합니다.
curl
요청 본문을 request.json
파일에 저장하고 다음 명령어를 실행합니다.
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs?search_config_id=person"
PowerShell
요청 본문을 request.json
파일에 저장하고 다음 명령어를 실행합니다.
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs?search_config_id=person" | Select-Object -Expand Content
다음과 비슷한 JSON 응답이 표시됩니다.
{ "name": "projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs/person", "searchCriteriaProperty": { "mappedFields": [ "player", "coach", "cheerleader" ] } }
검색 구성 업데이트
REST
SearchConfig
리소스를 업데이트하려면 projects.locations.corpora.searchConfigs.patch
메서드를 사용하여 POST 요청을 전송합니다.
다음은 맞춤 검색 기준으로 검색 구성을 만드는 방법의 예입니다.
요청 데이터를 사용하기 전에 다음을 바꿉니다.
- REGIONALIZED_ENDPOINT: 엔드포인트에
LOCATION_ID
와 일치하는 접두사가 포함될 수 있습니다(예:europe-west4-
). 리전화된 엔드포인트에 대해 자세히 알아보세요. - PROJECT: Google Cloud 프로젝트 ID 또는 프로젝트 번호
- LOCATION_ID: Vertex AI Vision을 사용하는 리전입니다. 예를 들면
us-central1
,europe-west4
입니다. 사용 가능한 리전을 참고하세요. - CORPUS_ID: 타겟 코퍼스의 ID입니다.
- SEARCHCONFIG_ID: 타겟
SearchConfig
의 ID입니다. "mappedFields"
: 하나 이상의 기존 사용자 제공 주석 키입니다.
HTTP 메서드 및 URL:
PATCH https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs/SEARCHCONFIG_ID
JSON 요청 본문:
{ "name": "projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs/SEARCHCONFIG_ID1", "searchCriteriaProperty": { "mappedFields": "dataschema2" } }
요청을 보내려면 다음 옵션 중 하나를 선택합니다.
curl
요청 본문을 request.json
파일에 저장하고 다음 명령어를 실행합니다.
curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs/SEARCHCONFIG_ID"
PowerShell
요청 본문을 request.json
파일에 저장하고 다음 명령어를 실행합니다.
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method PATCH `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs/SEARCHCONFIG_ID" | Select-Object -Expand Content
다음과 비슷한 JSON 응답이 표시됩니다.
{ "name": "projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs/SEARCHCONFIG_ID1", "searchCriteriaProperty": { "mappedFields": [ "dataschema2" ] } }
검색 구성 가져오기
다음 예에서는 창고에 저장된 데이터에서 사용자를 더 쉽게 검색할 수 있도록 기존 SearchConfig
를 검색하는 방법을 보여줍니다.
REST
SearchConfig
에 대한 세부정보를 가져오려면 projects.locations.corpora.searchConfigs.get 메서드를 사용하여 GET 요청을 전송합니다.
요청 데이터를 사용하기 전에 다음을 바꿉니다.
- REGIONALIZED_ENDPOINT: 엔드포인트에
LOCATION_ID
와 일치하는 접두사가 포함될 수 있습니다(예:europe-west4-
). 리전화된 엔드포인트에 대해 자세히 알아보세요. - PROJECT_NUMBER: Google Cloud 프로젝트 번호
- LOCATION_ID: Vertex AI Vision을 사용하는 리전입니다. 예를 들면
us-central1
,europe-west4
입니다. 사용 가능한 리전을 참고하세요. - CORPUS_ID: 타겟 코퍼스의 ID입니다.
- SEARCHCONFIG: 타겟
SearchConfig
의 이름입니다. - 이 예시의
SearchConfig
는person
입니다.
HTTP 메서드 및 URL:
GET https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs/SEARCHCONFIG
요청을 보내려면 다음 옵션 중 하나를 선택합니다.
curl
다음 명령어를 실행합니다.
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs/SEARCHCONFIG"
PowerShell
다음 명령어를 실행합니다.
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs/SEARCHCONFIG" | Select-Object -Expand Content
다음과 비슷한 JSON 응답이 표시됩니다.
{ "name": "projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs/person" "facet_property": { // Top-level facet group name. "display_name": "Person", // Each mapped_field will be displayed in the UI as a selectable value // under "Person". "mapped_fields": "player", // The maximum number of mapped_fields to be displayed. "result_size": 2, // The facet type is a singular value. In this case, type string. "bucket_type": FACET_BUCKET_TYPE_VALUE } }
검색 구성 나열
다음 예에서는 이전에 생성된 모든 SearchConfig
리소스를 나열하는 방법을 보여줍니다.
요청에서 page_size
필드를 설정하여 나열된 검색 구성의 수를 지정할 수 있습니다.
REST
모든 검색 구성을 나열하려면 projects.locations.corpora.searchConfigs.list
메서드를 사용하여 GET 요청을 전송합니다.
이 예시에서 page_size
필드는 2로 설정되어 응답이 검색 구성 2개로 제한됩니다. 페이지 크기를 지정하지 않으면 기본값 25가 사용됩니다.
요청 데이터를 사용하기 전에 다음을 바꿉니다.
- REGIONALIZED_ENDPOINT: 엔드포인트에
LOCATION_ID
와 일치하는 접두사가 포함될 수 있습니다(예:europe-west4-
). 리전화된 엔드포인트에 대해 자세히 알아보세요. - PROJECT_NUMBER: Google Cloud 프로젝트 번호
- LOCATION_ID: Vertex AI Vision을 사용하는 리전입니다. 예를 들면
us-central1
,europe-west4
입니다. 사용 가능한 리전을 참고하세요. - CORPUS_ID: 타겟 코퍼스의 ID입니다.
- PAGE_SIZE: (선택사항) 반환할 결과 수입니다.
HTTP 메서드 및 URL:
GET https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs?page_size=2
요청을 보내려면 다음 옵션 중 하나를 선택합니다.
curl
다음 명령어를 실행합니다.
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs?page_size=2"
PowerShell
다음 명령어를 실행합니다.
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs?page_size=2" | Select-Object -Expand Content
다음과 비슷한 JSON 응답이 표시됩니다.
{ "next_page_token": "xyz", "search_configs": { "name": "projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs/person", "facet_property": { // Top-level facet group name. "display_name": "Person", // Each mapped_field will be displayed in the console as a selectable value // under "Person". "mapped_fields": "player", // The maximum number of mapped_fields to be displayed. "result_size": 2, // The facet type is a singular value. In this case, type string. "bucket_type": FACET_BUCKET_TYPE_VALUE } }, "search_configs": { "name": "projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs/location", "facet_property": { // Top-level facet group name. "display_name": "location", // Each mapped_field will be displayed in the console as a selectable value // under "location". "mapped_fields": "city", // The maximum number of mapped_fields to be displayed. "result_size": 2, // The facet type is a singular value. In this case, type string. "bucket_type": FACET_BUCKET_TYPE_VALUE } } }
요청에서 page_size=2
필드가 설정되어 있으므로 응답에는 SearchConfigs
가 두 개만 포함됩니다. 검색 구성의 다음 페이지를 보려면 다음 요청에 이전 응답의 next_page_token
설정을 포함하세요.
- https://warehouse-visionai.googleapis.com/v1alpha/[...]/searchConfigs?page_size=2&page_token='xyz'
검색 구성 삭제
REST 및 명령줄
다음 코드 샘플은 projects.locations.corpora.searchConfigs.delete
메서드를 사용하여 SearchConfig
를 삭제합니다. 이 요청이 성공하려면 SearchConfig
가 있어야 합니다.
요청 데이터를 사용하기 전에 다음을 바꿉니다.
- REGIONALIZED_ENDPOINT: 엔드포인트에
LOCATION_ID
와 일치하는 접두사가 포함될 수 있습니다(예:europe-west4-
). 리전화된 엔드포인트에 대해 자세히 알아보세요. - PROJECT_NUMBER: Google Cloud 프로젝트 번호
- LOCATION_ID: Vertex AI Vision을 사용하는 리전입니다. 예를 들면
us-central1
,europe-west4
입니다. 사용 가능한 리전을 참고하세요. - CORPUS_ID: 타겟 코퍼스의 ID입니다.
- SEARCHCONFIG_ID: 타겟
SearchConfig
의 ID입니다.
HTTP 메서드 및 URL:
DELETE https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs/SEARCHCONFIG_ID
요청을 보내려면 다음 옵션 중 하나를 선택합니다.
curl
다음 명령어를 실행합니다.
curl -X DELETE \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs/SEARCHCONFIG_ID"
PowerShell
다음 명령어를 실행합니다.
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method DELETE `
-Headers $headers `
-Uri "https://warehouse-visionai.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/corpora/CORPUS_ID/searchConfigs/SEARCHCONFIG_ID" | Select-Object -Expand Content
다음과 비슷한 JSON 응답이 표시됩니다.
{}