- 리소스: WidgetConfig
- JSON 표현
- UIComponentField
- DeviceVisibility
- FacetField
- DataStoreType
- ResultDisplayType
- DataStoreUiConfig
- CollectionComponent
- DataStoreComponent
- DataStoreConfigType
- UiSettings
- InteractionType
- GenerativeAnswerConfig
- ImageSource
- FeatureState
- AccessSettings
- UiBrandingSettings
- 이미지
- HomepageSetting
- 바로가기
- AssistantSettings
- WebGroundingType
- CustomerProvidedConfig
- CustomerType
- 메서드
리소스: WidgetConfig
WidgetConfig는 위젯 수준에서 구성을 캡처합니다.
JSON 표현 |
---|
{ "name": string, "displayName": string, "createTime": string, "updateTime": string, "enableAutocomplete": boolean, "fieldsUiComponentsMap": { string: { object ( |
필드 | |
---|---|
name |
변경할 수 없습니다. 위젯 구성의 전체 리소스 이름입니다. 형식은 이 필드는 UTF-8로 인코딩된 문자열이어야 하며 길이 제한은 1,024자(영문 기준)입니다. |
displayName |
필수 항목입니다. 사람이 읽을 수 있는 위젯 구성 표시 이름입니다. Discovery UI에서 사용됩니다. 이 필드는 UTF-8로 인코딩된 문자열이어야 하며 길이 제한은 128자(영문 기준)입니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다. |
createTime |
출력 전용입니다. 생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 |
updateTime |
출력 전용입니다. 생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 |
enableAutocomplete |
자동 완성을 사용 설정할지 여부입니다. |
fieldsUiComponentsMap |
키는 UI 구성요소입니다. 모의 현재 지원되는 값은 기기 공개 범위와 함께 필드의 이름입니다. 3개의 맞춤 입력란은 선택사항이며 추가하거나 삭제할 수 있습니다. |
facetField[] |
최종 사용자 뷰의 패싯 구성 및 모양입니다. |
dataStoreType |
출력 전용입니다. 상위 데이터 저장소의 유형입니다. |
contentSearchSpec |
콘텐츠 검색의 원하는 동작을 구성하는 콘텐츠 검색 사양입니다. |
enableSummarization |
검색 응답의 요약을 사용 설정 또는 사용 중지합니다. |
enableSnippetResultSummary |
각 스니펫 결과에 대한 요약을 사용 설정하거나 사용 중지합니다. |
configId |
출력 전용입니다. |
enableQualityFeedback |
최종 사용자로부터 검색 결과 품질 의견을 수집하는 기능을 사용 설정 또는 사용 중지합니다. |
solutionType |
필수 항목입니다. 변경할 수 없습니다. 이 WidgetConfig를 사용할 수 있는 솔루션 유형을 지정합니다. |
industryVertical |
출력 전용입니다. WidgetConfig가 등록하는 업종 카테고리입니다. WidgetConfig 업종은 연결된 |
allowPublicAccess |
위젯과의 인증 없는 통합을 허용할지 여부입니다. true로 설정하면 고객 호스팅 백엔드 서버에서 제공하는 인증 토큰 없이 위젯에서 검색 또는 기타 솔루션에 대한 공개 액세스가 허용됩니다. |
allowlistedDomains[] |
이 위젯을 로드할 수 있는 허용된 도메인입니다. |
enableSafeSearch |
세이프 서치 사용 여부입니다. |
enableConversationalSearch |
대화형 검색 (LLM, 멀티턴)을 허용할지 (비LLM, 싱글턴) 여부입니다. |
llmEnabled |
출력 전용입니다. 해당 데이터 스토어에서 LLM이 사용 설정되어 있는지 여부입니다. |
enableResultScore |
결과 점수를 표시할지 여부입니다. |
resultDisplayType |
UCS 위젯에 표시할 스니펫 유형입니다.
|
minimumDataTermAccepted |
출력 전용입니다. 고객이 데이터 사용 약관에 동의했는지 여부입니다. |
enableWebApp |
독립형 웹 앱을 사용 설정할지 여부입니다. |
dataStoreUiConfigs[] |
데이터 스토어별로 구성 가능한 UI 구성 |
collectionComponents[] |
출력 전용입니다. 위젯 구성과 연결된 모든 컬렉션과 하위 데이터 저장소를 나열하는 컬렉션 구성요소입니다. 이러한 데이터 소스는 위젯 서비스 API에서 필터링하는 데 사용할 수 있으며 사용자는 선택한 데이터 소스에서 결과를 반환할 수 있습니다. |
enableSearchAsYouType |
검색 위젯에 입력과 동시에 검색 동작을 사용 설정할지 여부 |
defaultSearchRequestOrderBy |
지정된 경우 검색 결과의 기본 순서입니다. 해당 요청에서 SearchRequest#orderBy를 설정하는 데 사용됩니다. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body |
experimentalFeatures |
위젯 (또는 웹 앱)에서 불안정한 기능/실험적 기능을 전환할 수 있습니다. |
uiSettings |
클라우드 콘솔 위젯 구성 페이지에 표시되는 일반 위젯 검색 설정을 설명합니다. 지원 중단된 최상위 속성을 대체합니다. |
accessSettings |
Cloud 콘솔 통합 페이지에 표시되는 모든 위젯 액세스 설정에 사용됩니다. 지원 중단된 최상위 속성을 대체합니다. |
uiBranding |
위젯 제목, 로고, 파비콘, 색상과 같은 검색 위젯 UI 브랜딩 설정을 설명합니다. |
homepageSetting |
(선택사항) 위젯의 홈페이지 설정을 설명합니다. |
assistantSettings |
(선택사항) 출력 전용입니다. 위젯의 어시스턴트 설정을 설명합니다. |
customerProvidedConfig |
(선택사항) 출력 전용입니다. 고객 관련 구성을 설명합니다. 현재 정부 고객에게만 사용됩니다. 이 필드는 프로젝트 온보딩 후 수정할 수 없습니다. |
enablePrivateKnowledgeGraph |
(선택사항) 출력 전용입니다. 비공개 지식 그래프를 사용 설정할지 여부입니다. |
UIComponentField
UI 구성요소에 매핑되는 패싯 필드입니다.
JSON 표현 |
---|
{
"field": string,
"deviceVisibility": [
enum ( |
필드 | |
---|---|
field |
필수 항목입니다. 등록된 필드 이름입니다. 형식은 |
deviceVisibility[] |
다양한 유형의 기기에서 필드 공개 상태입니다. |
displayTemplate |
필드가 표시되는 방식을 맞춤설정하는 템플릿입니다. 값의 예는 '가격: {value}'와 같은 문자열입니다. |
DeviceVisibility
다양한 유형의 기기에서 필드의 공개 상태입니다.
열거형 | |
---|---|
DEVICE_VISIBILITY_UNSPECIFIED |
지정되지 않은 경우의 기본값입니다. 요청에 사용되면 서버가 INVALID_ARGUMENT를 반환합니다. |
MOBILE |
UI 구성요소가 모바일 기기에 표시됩니다. |
DESKTOP |
UI 구성요소가 브라우저 기반 클라이언트에 표시됩니다. |
FacetField
필드와 최종 사용자 위젯 모양의 매핑을 저장하는 패싯 필드입니다.
JSON 표현 |
---|
{ "field": string, "displayName": string } |
필드 | |
---|---|
field |
필수 항목입니다. 등록된 필드 이름입니다. 형식은 |
displayName |
(선택사항) 최종 사용자에게 표시되는 필드 이름입니다. |
DataStoreType
위젯의 상위 데이터 스토어 유형입니다.
열거형 | |
---|---|
DATA_STORE_TYPE_UNSPECIFIED |
지정되지 않은 데이터 저장소 유형입니다. |
SITE_SEARCH |
상위 데이터 스토어에 사이트 검색엔진이 포함되어 있습니다. |
STRUCTURED |
상위 데이터 스토어에는 구조화된 데이터용 검색엔진이 포함되어 있습니다. |
UNSTRUCTURED |
상위 데이터 스토어에는 비정형 데이터용 검색엔진이 포함되어 있습니다. |
BLENDED |
상위 데이터 스토어는 여러 데이터 스토어가 있는 혼합 검색에 제공됩니다. |
ResultDisplayType
ucs 위젯에 표시할 결과의 유형입니다.
열거형 | |
---|---|
RESULT_DISPLAY_TYPE_UNSPECIFIED |
지정되지 않은 표시 유형 (스니펫 표시가 기본값임) |
SNIPPET |
스니펫 필드의 결과를 표시합니다. |
EXTRACTIVE_ANSWER |
추출 답변 필드의 결과를 표시합니다. |
DataStoreUiConfig
데이터 스토어의 UI 구성요소 구성입니다.
JSON 표현 |
---|
{ "name": string, "id": string, "facetField": [ { object ( |
필드 | |
---|---|
name |
데이터 스토어의 이름입니다. 데이터 저장소 리소스 이름 형식이어야 합니다( |
id |
출력 전용입니다. 위젯 서비스에 사용되는 데이터 스토어의 식별자입니다. 현재는 dataStoreId를 참조하지만 향후에는 필드를 암호화된 데이터 스토어 이름 UUID로 이전할 예정입니다. |
facetField[] |
필드와 최종 사용자 위젯 모양의 매핑을 저장하는 패싯 필드입니다. |
fieldsUiComponentsMap |
키는 UI 구성요소입니다. 모의 현재 지원되는 값은 기기 공개 범위와 함께 필드의 이름입니다. 3개의 맞춤 입력란은 선택사항이며 추가하거나 삭제할 수 있습니다. |
CollectionComponent
필터링에 사용할 수 있는 데이터 스토어 컬렉션 필드가 포함된 읽기 전용 컬렉션 구성요소
JSON 표현 |
---|
{
"name": string,
"id": string,
"displayName": string,
"dataStoreComponents": [
{
object ( |
필드 | |
---|---|
name |
컬렉션의 이름입니다. 컬렉션 리소스 이름이어야 합니다. 형식은 |
id |
출력 전용입니다. 위젯 서비스에 사용되는 컬렉션의 식별자입니다. 현재는 collectionId를 참조하지만 향후에는 필드가 암호화된 컬렉션 이름 UUID로 이전됩니다. |
displayName |
컬렉션의 표시 이름입니다. |
dataStoreComponents[] |
데이터 스토어 컬렉션의 경우 하위 데이터 스토어 목록입니다. |
dataSource |
|
dataSourceDisplayName |
출력 전용입니다. 데이터 소스의 표시 이름입니다. |
connectorIconLink |
출력 전용입니다. 커넥터 소스의 아이콘 링크입니다. |
DataStoreComponent
필터링에 사용할 수 있는 데이터 스토어 필드를 포함하는 읽기 전용 데이터 스토어 구성요소입니다. CollectionComponent
의 하위 요소입니다.
JSON 표현 |
---|
{ "name": string, "id": string, "displayName": string, "entityName": string, "workspaceType": enum ( |
필드 | |
---|---|
name |
데이터 스토어의 이름입니다. 데이터 저장소 리소스 이름 형식이어야 합니다( |
id |
출력 전용입니다. 위젯 서비스에 사용되는 데이터 스토어의 식별자입니다. 현재는 dataStoreId를 참조하지만 향후에는 필드를 암호화된 데이터 스토어 이름 UUID로 이전할 예정입니다. |
displayName |
데이터 스토어의 표시 이름입니다. |
entityName |
|
workspaceType |
출력 전용입니다. |
contentConfig |
출력 전용입니다. 데이터 스토어의 콘텐츠 구성입니다. |
dataStoreConfigType |
출력 전용입니다. 데이터 스토어 구성의 유형입니다. |
DataStoreConfigType
데이터 스토어 구성의 유형입니다.
열거형 | |
---|---|
DATA_STORE_CONFIG_TYPE_UNSPECIFIED |
기본값. 이 값은 사용되지 않습니다. |
ALLOW_DB_CONFIG |
데이터 스토어가 AlloyDB에 연결되어 있습니다. |
THIRD_PARTY_OAUTH_CONFIG |
데이터 스토어가 서드 파티 데이터 소스에 연결되어 있습니다. |
NOTEBOOKLM_CONFIG |
데이터 스토어가 NotebookLM Enterprise에 연결되어 있습니다. |
UiSettings
클라우드 콘솔 UI 구성 페이지에 표시되는 일반 위젯 (또는 웹 앱) UI 설정을 설명합니다.
JSON 표현 |
---|
{ "interactionType": enum ( |
필드 | |
---|---|
interactionType |
위젯 (또는 웹 앱) 상호작용 유형을 설명합니다. |
generativeAnswerConfig |
생성 답변 구성을 설명합니다. |
resultDescriptionType |
결과 추출이 표시되는지 여부와 표시되는 방식 (스니펫 또는 추출 답변)을 제어합니다. 지정되지 않은 경우 결과가 없는 것으로 기본 설정됩니다. |
enableAutocomplete |
자동 완성을 사용 설정할지 여부입니다. |
enableSafeSearch |
세이프 서치 사용 여부입니다. |
enableQualityFeedback |
최종 사용자로부터 검색 결과 품질 의견을 수집하는 기능을 사용 설정 또는 사용 중지합니다. |
enableSearchAsYouType |
검색 위젯에 입력과 동시에 검색 동작을 사용 설정할지 여부입니다. |
defaultSearchRequestOrderBy |
지정된 경우 검색 결과의 기본 순서입니다. 해당 요청에서 SearchRequest#orderBy를 설정하는 데 사용됩니다. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body |
dataStoreUiConfigs[] |
데이터 스토어별 구성입니다. |
disableUserEventsCollection |
true로 설정하면 위젯이 사용자 이벤트를 수집하지 않습니다. |
enableVisualContentSummary |
true로 설정하면 위젯이 해당 검색 요청에 시각적 콘텐츠 요약을 사용 설정합니다. 의료 검색에서만 사용됩니다. |
enablePeopleSearch |
(선택사항) true로 설정하면 위젯에서 사용자 검색이 사용 설정됩니다. |
enableCreateAgentButton |
(선택사항) true로 설정하면 위젯에서 에이전트 만들기 버튼이 사용 설정됩니다. |
features |
출력 전용입니다. 엔진이 기능을 선택하거나 선택 해제하는 기능 구성 지원되는 키:
|
InteractionType
상호작용 유형을 설명합니다.
열거형 | |
---|---|
INTERACTION_TYPE_UNSPECIFIED |
지정되지 않음 기본값은 SEARCH_ONLY입니다. |
SEARCH_ONLY |
생성 답변 없이 검색합니다. |
SEARCH_WITH_ANSWER |
생성형 답변으로 검색합니다. |
SEARCH_WITH_FOLLOW_UPS |
후속 질문을 지원하는 생성형 답변으로 검색합니다. 멀티턴 검색이라고도 합니다. |
GenerativeAnswerConfig
생성 답변의 구성을 설명합니다.
JSON 표현 |
---|
{
"resultCount": integer,
"modelVersion": string,
"modelPromptPreamble": string,
"maxRephraseSteps": integer,
"languageCode": string,
"disableRelatedQuestions": boolean,
"ignoreNonAnswerSeekingQuery": boolean,
"ignoreAdversarialQuery": boolean,
"ignoreLowRelevantContent": boolean,
"imageSource": enum ( |
필드 | |
---|---|
resultCount |
답변을 생성할 상위 결과의 수입니다. 최대 10개 |
modelVersion |
답변을 생성하는 데 사용된 모델 버전입니다. |
modelPromptPreamble |
대답을 생성하는 모델을 지시하는 프롬프트의 시작 부분에 있는 텍스트입니다. |
maxRephraseSteps |
최대 수정 단계입니다. 최대 단계 수는 5단계입니다. 설정되지 않았거나 1 미만으로 설정된 경우 기본적으로 1로 설정됩니다. |
languageCode |
요약의 언어 코드입니다. BCP47에 정의된 언어 태그를 사용합니다. 참고: 이 기능은 실험적 기능입니다. |
disableRelatedQuestions |
생성된 답변에 추천 관련 질문이 포함되어 있는지 여부입니다. |
ignoreNonAnswerSeekingQuery |
(선택사항) 답변을 구하지 않는 쿼리를 필터링할지 여부를 지정합니다. 기본값은 검색어가 답변을 구하지 않는 질문으로 분류되면 답변이 반환되지 않습니다. 이 필드가 |
ignoreAdversarialQuery |
(선택사항) 적대적인 질문을 필터링할지 여부를 지정합니다. |
ignoreLowRelevantContent |
(선택사항) 콘텐츠와 관련이 없는 쿼리를 필터링할지 여부를 지정합니다. |
imageSource |
(선택사항) 답변으로 반환되는 이미지의 소스입니다. |
ImageSource
답변으로 반환되는 이미지의 소스입니다.
열거형 | |
---|---|
IMAGE_SOURCE_UNSPECIFIED |
지정되지 않은 이미지 소스 (다중 모달 기능은 기본적으로 사용 중지됨) |
ALL_AVAILABLE_SOURCES |
서비스가 사용 가능한 모든 소스에서 선택을 결정할 때의 동작입니다. |
CORPUS_IMAGE_ONLY |
코퍼스의 이미지를 답변에 포함합니다. |
FIGURE_GENERATION_ONLY |
대답에서 그림 생성을 트리거합니다. |
FeatureState
엔진의 기능 상태입니다.
열거형 | |
---|---|
FEATURE_STATE_UNSPECIFIED |
기능 상태가 지정되지 않았습니다. |
FEATURE_STATE_ON |
이 기능은 액세스할 수 있도록 사용 설정되어 있습니다. |
FEATURE_STATE_OFF |
이 기능은 액세스할 수 없도록 사용 중지되어 있습니다. |
AccessSettings
위젯 액세스 설정을 설명합니다.
JSON 표현 |
---|
{ "allowPublicAccess": boolean, "allowlistedDomains": [ string ], "enableWebApp": boolean, "workforceIdentityPoolProvider": string, "languageCode": string } |
필드 | |
---|---|
allowPublicAccess |
인증되지 않은 공개 액세스가 허용되는지 여부입니다. |
allowlistedDomains[] |
검색 위젯을 통합할 수 있는 도메인 목록입니다. |
enableWebApp |
웹 앱 액세스 사용 설정 여부입니다. |
workforceIdentityPoolProvider |
(선택사항) 위젯에 액세스하는 데 사용되는 직원 ID 풀 제공업체입니다. |
languageCode |
(선택사항) 사용자 인터페이스의 언어 코드입니다. BCP47에 정의된 언어 태그를 사용합니다. 설정하지 않으면 기본 언어 코드는 'en-US'입니다. |
UiBrandingSettings
위젯 UI 브랜딩 설정을 설명합니다.
JSON 표현 |
---|
{
"logo": {
object ( |
필드 | |
---|---|
logo |
로고 이미지입니다. |
이미지
이미지를 저장하는 옵션입니다.
JSON 표현 |
---|
{ // Union field |
필드 | |
---|---|
통합 필드 storage_method . 이미지를 저장하는 다양한 방법(예: URL 또는 base64 인코딩 문자열) storage_method 은 다음 중 하나여야 합니다. |
|
url |
이미지 URL입니다. |
HomepageSetting
위젯의 홈페이지 설정을 설명합니다. 여기에는 바로가기와 같은 모든 홈페이지 관련 설정 및 구성이 포함됩니다.
JSON 표현 |
---|
{
"shortcuts": [
{
object ( |
필드 | |
---|---|
shortcuts[] |
(선택사항) 홈페이지에 표시할 바로가기입니다. LINT.IfChange(max_shortcuts_number) LINT.ThenChange(//depot/google3/cloud/console/web/ai/unified_cloud_search/components/widget_preview/widget_homepage_shortcut_config_form.ts:max_shortcuts_number) |
단축키
홈페이지의 바로가기 (고정된 콘텐츠) 항목을 설명합니다. 홈페이지는 API가 반환하는 순서와 동일한 순서로 이러한 바로가기를 렌더링합니다. 고객이 바로가기를 재정렬하거나 삭제하려는 경우 UI는 항상 바로가기의 새로운 전체 목록을 제공해야 합니다.
JSON 표현 |
---|
{
"title": string,
"icon": {
object ( |
필드 | |
---|---|
title |
(선택사항) 바로가기의 제목입니다. |
icon |
(선택사항) 바로가기의 아이콘 URL입니다. |
destinationUri |
(선택사항) 바로가기의 도착 URL입니다. |
AssistantSettings
위젯의 어시스턴트 설정을 설명합니다.
JSON 표현 |
---|
{
"googleSearchGroundingEnabled": boolean,
"webGroundingType": enum ( |
필드 | |
---|---|
googleSearchGroundingEnabled |
Google 검색 그라운딩 전환 버튼이 표시되는지 여부입니다. 지원 중단되었습니다. 대신 |
webGroundingType |
(선택사항) 사용할 웹 그라운딩 유형입니다. |
defaultWebGroundingToggleOff |
출력 전용입니다. 이 필드는 |
disableLocationContext |
(선택사항) 출력 전용입니다. 사용자 위치 컨텍스트를 사용 중지할지 여부입니다. |
WebGroundingType
사용할 웹 그라운딩 유형입니다.
열거형 | |
---|---|
WEB_GROUNDING_TYPE_UNSPECIFIED |
기본값, 지정되지 않은 설정입니다. 사용 중지된 것과 같습니다. |
WEB_GROUNDING_TYPE_DISABLED |
웹 그라운딩이 사용 중지되었습니다. |
WEB_GROUNDING_TYPE_GOOGLE_SEARCH |
Google 검색을 사용한 그라운딩이 사용 설정되어 있습니다. |
WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH |
Enterprise Web Search를 사용한 그라운딩이 사용 설정되어 있습니다. |
CustomerProvidedConfig
고객이 제공한 구성입니다.
JSON 표현 |
---|
{
"customerType": enum ( |
필드 | |
---|---|
customerType |
고객 유형입니다. |
CustomerType
고객 유형입니다.
열거형 | |
---|---|
DEFAULT_CUSTOMER |
기본 고객 유형입니다. |
GOVERNMENT_CUSTOMER |
정부 고객 유형입니다. 법적 요구사항으로 인해 정부 고객에게는 일부 기능이 사용 중지됩니다. |
메서드 |
|
---|---|
|
WidgetConfig 을 가져옵니다. |