REST Resource: projects.locations.dataStores.widgetConfigs

리소스: WidgetConfig

WidgetConfig는 위젯 수준에서 적용되는 구성을 정의합니다.

JSON 표현 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "enableAutocomplete": boolean,
  "fieldsUiComponentsMap": {
    string: {
      object (UIComponentField)
    },
    ...
  },
  "facetField": [
    {
      object (FacetField)
    }
  ],
  "dataStoreType": enum (DataStoreType),
  "contentSearchSpec": {
    object (ContentSearchSpec)
  },
  "enableSummarization": boolean,
  "enableSnippetResultSummary": boolean,
  "configId": string,
  "enableQualityFeedback": boolean,
  "solutionType": enum (SolutionType),
  "industryVertical": enum (IndustryVertical),
  "allowPublicAccess": boolean,
  "allowlistedDomains": [
    string
  ],
  "enableSafeSearch": boolean,
  "enableConversationalSearch": boolean,
  "llmEnabled": boolean,
  "enableResultScore": boolean,
  "resultDisplayType": enum (ResultDisplayType),
  "minimumDataTermAccepted": boolean,
  "enableWebApp": boolean,
  "dataStoreUiConfigs": [
    {
      object (DataStoreUiConfig)
    }
  ],
  "collectionComponents": [
    {
      object (CollectionComponent)
    }
  ],
  "enableSearchAsYouType": boolean,
  "defaultSearchRequestOrderBy": string,
  "uiSettings": {
    object (UiSettings)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "uiBranding": {
    object (UiBrandingSettings)
  },
  "homepageSetting": {
    object (HomepageSetting)
  },
  "assistantSettings": {
    object (AssistantSettings)
  },
  "customerProvidedConfig": {
    object (CustomerProvidedConfig)
  },
  "enablePrivateKnowledgeGraph": boolean,
  "geminiBundle": boolean
}
필드
name

string

변경할 수 없습니다. 위젯 구성의 전체 리소스 이름입니다. 형식은 projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/widgetConfigs/{widgetConfigId}입니다.

이 필드는 UTF-8로 인코딩된 문자열이어야 하며 길이 제한은 1024자(영문 기준)입니다.
displayName

string

(필수 항목) 인간이 읽을 수 있는 위젯 구성 표시 이름입니다. Discovery UI에서 사용됩니다.

이 필드는 UTF-8로 인코딩된 문자열이어야 하며 길이 제한은 128자(영문 기준)입니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다.
createTime

string (Timestamp format)

출력 전용입니다. WidgetConfig가 생성된 타임스탬프입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.
updateTime

string (Timestamp format)

출력 전용입니다. WidgetConfig가 업데이트된 타임스탬프입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.
enableAutocomplete
(deprecated)

boolean

자동 완성을 사용 설정할지 여부입니다.
fieldsUiComponentsMap
(deprecated)

map (key: string, value: object (UIComponentField))

키는 UI 구성요소입니다. Mock. 현재 지원되는 UI 구성요소는 title, thumbnail, url, custom1, custom2, custom3입니다.

값은 필드 이름과, 해당 필드의 기기별 공개 상태 정보를 함께 나타냅니다.

3개의 커스텀 필드는 선택사항이며 필요에 따라 추가하거나 삭제할 수 있습니다. 반면, title, thumbnail, url은 필수 UI 구성요소이므로 삭제할 수 없습니다.
facetField[]
(deprecated)

object (FacetField)

최종 사용자 뷰에 표시되는 패싯의 구성 및 표시 방식입니다.
dataStoreType

enum (DataStoreType)

출력 전용입니다. 상위 데이터 스토어의 유형입니다.
contentSearchSpec
(deprecated)

object (ContentSearchSpec)

콘텐츠 검색이 원하는 방식으로 동작하도록 구성하는 콘텐츠 검색 사양입니다.
enableSummarization
(deprecated)

boolean

검색 응답에 대한 요약 기능을 사용 설정하거나 사용 중지합니다.
enableSnippetResultSummary
(deprecated)

boolean

각 스니펫 결과에 대한 요약 기능을 사용 설정하거나 사용 중지합니다.
configId

string

출력 전용입니다. WidgetConfig의 고유 난독화 식별자입니다.
enableQualityFeedback
(deprecated)

boolean

최종 사용자의 검색 결과 품질 의견 수집 기능을 사용 설정하거나 사용 중지합니다.
solutionType

enum (SolutionType)

(필수 항목) 변경할 수 없습니다. 이 WidgetConfig를 사용할 수 있는 솔루션 유형을 지정합니다.
industryVertical

enum (IndustryVertical)

출력 전용입니다. WidgetConfig가 등록하는 업종 카테고리입니다. WidgetConfig 업종 카테고리는 연결된 Engine의 설정을 기반으로 합니다.
allowPublicAccess
(deprecated)

boolean

위젯에서 인증 없이 통합을 허용할지 여부입니다. 이 값을 true로 설정하면 고객이 호스팅하는 백엔드 서버가 인증 토큰을 제공하지 않아도 위젯을 통해 검색 또는 기타 솔루션에 대한 공개 액세스가 허용됩니다.
allowlistedDomains[]
(deprecated)

string

이 위젯을 로드할 수 있는 허용된 도메인 목록입니다.
llmEnabled

boolean

출력 전용입니다. 해당 데이터 스토어에서 LLM이 사용 설정되어 있는지 여부입니다.
enableResultScore

boolean

결과 점수를 표시할지 여부입니다.
resultDisplayType
(deprecated)

enum (ResultDisplayType)

UCS 위젯에서 표시할 스니펫 유형입니다.

  • 기존 사용자: RESULT_DISPLAY_TYPE_UNSPECIFIED
  • 신규 비엔터프라이즈 검색 사용자: SNIPPET
  • 신규 엔터프라이즈 검색 사용자: EXTRACTIVE_ANSWER
minimumDataTermAccepted

boolean

출력 전용입니다. 고객이 데이터 사용 약관에 동의했는지 여부입니다.
enableWebApp
(deprecated)

boolean

독립형 웹 앱을 사용 설정할지 여부입니다.
dataStoreUiConfigs[]
(deprecated)

object (DataStoreUiConfig)

데이터 스토어별로 구성 가능한 UI 구성입니다.
collectionComponents[]

object (CollectionComponent)

출력 전용입니다. 이 위젯 구성과 연결된 모든 컬렉션 및 하위 데이터 스토어를 나열하는 컬렉션 구성요소입니다. 이러한 데이터 소스는 위젯 서비스 API에서 필터링에 사용할 수 있으며, 사용자는 선택된 데이터 소스에서 가져온 결과를 반환할 수 있습니다.
enableSearchAsYouType
(deprecated)

boolean

검색 위젯에서 입력 즉시 검색 기능을 사용 설정할지 여부입니다.
defaultSearchRequestOrderBy
(deprecated)

string

지정된 경우 검색 결과의 기본 정렬 방식입니다.

이는 해당 요청에서 SearchRequest#orderBy 값을 설정하는 데 사용됩니다. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
uiSettings

object (UiSettings)

클라우드 콘솔의 위젯 구성 페이지에 표시되는 일반적인 위젯 검색 설정을 설명합니다. 상위 레벨에서 지원 중단된 속성들을 대체합니다.
accessSettings

object (AccessSettings)

Cloud 콘솔 통합 페이지에서 표시되는 모든 위젯 액세스 설정에 사용됩니다. 상위 레벨에서 지원 중단된 속성들을 대체합니다.
uiBranding

object (UiBrandingSettings)

위젯 제목, 로고, 파비콘, 색상 등 검색 위젯의 UI 브랜딩 설정을 설명합니다.
homepageSetting

object (HomepageSetting)

(선택사항) 위젯의 홈페이지 설정을 설명합니다.
assistantSettings

object (AssistantSettings)

(선택사항) 출력 전용입니다. 위젯의 어시스턴트 설정을 설명합니다.
customerProvidedConfig

object (CustomerProvidedConfig)

(선택사항) 출력 전용입니다. 고객 관련 구성을 설명하며, 현재는 정부 고객에게만 사용됩니다. 프로젝트 온보딩 후에는 이 필드를 수정할 수 없습니다.
enablePrivateKnowledgeGraph

boolean

(선택사항) 출력 전용입니다. 비공개 지식 그래프를 사용 설정할지 여부입니다.
geminiBundle

boolean

출력 전용입니다. 사용 중인 구독이 Gemini 번들인지 여부입니다.

메서드

get

 WidgetConfig를 가져옵니다.

patch

 WidgetConfig를 업데이트합니다.