REST Resource: projects.locations.collections.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,
  "nodes": [
    {
      object (Node)
    }
  ]
}
필드
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 번들인지 여부입니다.
nodes[]

object (Node)

출력 전용입니다. 위젯 구성과 연결된 노드입니다.

UIComponentField

UI 구성요소에 매핑되는 패싯 필드입니다.

JSON 표현 
{
  "field": string,
  "deviceVisibility": [
    enum (DeviceVisibility)
  ],
  "displayTemplate": string
}
필드
field

string

필수 항목입니다. 등록된 필드 이름입니다. 형식은 field.abc입니다.
deviceVisibility[]

enum (DeviceVisibility)

다양한 유형의 기기에서 필드의 공개 상태입니다.
displayTemplate

string

필드가 표시되는 방식을 맞춤설정하는 템플릿입니다. 값의 예는 '가격: {value}'와 같은 문자열입니다.

DeviceVisibility

다양한 유형의 기기에서 필드의 공개 상태입니다.

열거형
DEVICE_VISIBILITY_UNSPECIFIED 지정되지 않은 경우의 기본값입니다. 요청에 사용되면 서버가 INVALID_ARGUMENT를 반환합니다.
MOBILE UI 구성요소가 모바일 기기에 표시됩니다.
DESKTOP UI 구성요소가 브라우저 기반 클라이언트에 표시됩니다.

FacetField

필드와 최종 사용자 위젯 모양의 매핑을 저장하는 패싯 필드입니다.

JSON 표현 
{
  "field": string,
  "displayName": string
}
필드
field

string

필수 항목입니다. 등록된 필드 이름입니다. 형식은 field.abc입니다.
displayName

string

선택사항입니다. 최종 사용자에게 표시되는 필드 이름입니다.

DataStoreType

위젯의 상위 데이터 스토어 유형입니다.

열거형
DATA_STORE_TYPE_UNSPECIFIED 지정되지 않은 데이터 저장소 유형입니다.
STRUCTURED 상위 데이터 스토어에는 구조화된 데이터의 검색엔진이 포함되어 있습니다.
UNSTRUCTURED 상위 데이터 스토어에는 비정형 데이터용 검색엔진이 포함되어 있습니다.
BLENDED 상위 데이터 스토어는 여러 데이터 스토어가 있는 혼합 검색에 제공됩니다.

ResultDisplayType

ucs 위젯에 표시할 결과 유형입니다.

열거형
RESULT_DISPLAY_TYPE_UNSPECIFIED 지정되지 않은 표시 유형 (스니펫 표시가 기본값임)
SNIPPET 스니펫 필드의 결과를 표시합니다.
EXTRACTIVE_ANSWER 추출 답변 필드의 결과를 표시합니다.

DataStoreUiConfig

데이터 스토어의 UI 구성요소 구성입니다.

JSON 표현 
{
  "name": string,
  "id": string,
  "facetField": [
    {
      object (FacetField)
    }
  ],
  "fieldsUiComponentsMap": {
    string: {
      object (UIComponentField)
    },
    ...
  }
}
필드
name

string

데이터 스토어의 이름입니다. 데이터 스토어 리소스 이름이어야 합니다(형식: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}). WidgetService 아래의 API(예: WidgetService.LookupWidgetConfig)의 경우 프로젝트 번호 및 위치 부분이 이 필드에서 삭제됩니다.
id

string

출력 전용입니다. 위젯 서비스에 사용되는 데이터 스토어의 식별자입니다. 현재는 dataStoreId를 참조하지만 향후에는 필드를 암호화된 데이터 스토어 이름 UUID로 이전할 예정입니다.
facetField[]

object (FacetField)

필드와 최종 사용자 위젯 모양의 매핑을 저장하는 패싯 필드입니다.
fieldsUiComponentsMap

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

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

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

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

CollectionComponent

필터링에 사용할 수 있는 데이터 스토어 컬렉션 필드가 포함된 읽기 전용 컬렉션 구성요소

JSON 표현 
{
  "name": string,
  "id": string,
  "displayName": string,
  "dataStoreComponents": [
    {
      object (DataStoreComponent)
    }
  ],
  "dataSource": string,
  "dataSourceDisplayName": string,
  "connectorIconLink": string
}
필드
name

string

컬렉션의 이름입니다. 컬렉션 리소스 이름이어야 합니다. 형식은 projects/{project}/locations/{location}/collections/{collectionId}입니다. WidgetService 아래의 API(예: WidgetService.LookupWidgetConfig)의 경우 프로젝트 번호 및 위치 부분이 이 필드에서 삭제됩니다.
id

string

출력 전용입니다. 위젯 서비스에 사용되는 컬렉션의 식별자입니다. 현재는 collectionId를 참조하지만 향후에는 필드가 암호화된 컬렉션 이름 UUID로 이전됩니다.
displayName

string

컬렉션의 표시 이름입니다.
dataStoreComponents[]

object (DataStoreComponent)

데이터 스토어 컬렉션의 경우 하위 데이터 스토어 목록입니다.
dataSource

string

Collection.data_connector.data_source에서 가져온 데이터 소스의 이름입니다.
dataSourceDisplayName

string

출력 전용입니다. 데이터 소스의 표시 이름입니다.

DataStoreComponent

필터링에 사용할 수 있는 데이터 스토어 필드를 포함하는 읽기 전용 데이터 스토어 구성요소로, CollectionComponent의 하위 요소입니다.

JSON 표현 
{
  "name": string,
  "id": string,
  "displayName": string,
  "entityName": string,
  "workspaceType": enum (Type),
  "contentConfig": enum (ContentConfig),
  "dataStoreConfigType": enum (DataStoreConfigType)
}
필드
name

string

데이터 스토어의 이름입니다. 데이터 스토어 리소스 이름이어야 합니다(형식: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}). WidgetService 아래의 API(예: WidgetService.LookupWidgetConfig)의 경우 프로젝트 번호 및 위치 부분이 이 필드에서 삭제됩니다.
id

string

출력 전용입니다. 위젯 서비스에 사용되는 데이터 스토어의 식별자입니다. 현재는 dataStoreId를 참조하지만 향후에는 필드를 암호화된 데이터 스토어 이름 UUID로 이전할 예정입니다.
displayName

string

데이터 스토어의 표시 이름입니다.
entityName

string

Collection.data_connector.entities.entityName에서 가져온 항목의 이름입니다.
workspaceType

enum (Type)

출력 전용입니다. DataStore.workspace_config.type에서 가져온 워크스페이스 데이터의 워크스페이스 소스 유형입니다.
contentConfig

enum (ContentConfig)

출력 전용입니다. 데이터 스토어의 콘텐츠 구성입니다.
dataStoreConfigType

enum (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": {
    object (GenerativeAnswerConfig)
  },
  "resultDescriptionType": enum (ResultDisplayType),
  "enableAutocomplete": boolean,
  "enableSafeSearch": boolean,
  "enableQualityFeedback": boolean,
  "enableSearchAsYouType": boolean,
  "defaultSearchRequestOrderBy": string,
  "dataStoreUiConfigs": [
    {
      object (DataStoreUiConfig)
    }
  ],
  "disableUserEventsCollection": boolean,
  "enableVisualContentSummary": boolean,
  "enablePeopleSearch": boolean,
  "enableCreateAgentButton": boolean,
  "features": {
    string: enum (FeatureState),
    ...
  },
  "modelConfigs": {
    string: enum (ModelState),
    ...
  },
  "searchAddonSpec": {
    object (SearchAddonSpec)
  }
}
필드
interactionType

enum (InteractionType)

위젯 (또는 웹 앱) 상호작용 유형을 설명합니다.
generativeAnswerConfig

object (GenerativeAnswerConfig)

생성 답변 구성을 설명합니다.
resultDescriptionType

enum (ResultDisplayType)

결과 추출이 표시되는지 여부와 표시되는 방식 (스니펫 또는 추출 답변)을 제어합니다. 지정되지 않은 경우 결과가 없는 것으로 기본 설정됩니다.
enableAutocomplete

boolean

자동 완성을 사용 설정할지 여부입니다.
enableQualityFeedback

boolean

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

boolean

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

string

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

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

object (DataStoreUiConfig)

데이터 스토어별 구성입니다.
disableUserEventsCollection

boolean

true로 설정하면 위젯이 사용자 이벤트를 수집하지 않습니다.
enableVisualContentSummary

boolean

true로 설정하면 위젯이 해당 검색 요청에 시각적 콘텐츠 요약을 사용 설정합니다. 의료 검색에서만 사용됩니다.
enableCreateAgentButton

boolean

선택사항입니다. true로 설정하면 위젯에서 에이전트 만들기 버튼이 사용 설정됩니다.
features

map (key: string, value: enum (FeatureState))

출력 전용입니다. 엔진이 특정 기능을 사용하거나 사용하지 않도록 설정하는 기능 구성입니다. 지원되는 키는 다음과 같습니다.

  • agent-gallery
  • no-code-agent-builder
  • prompt-gallery
  • model-selector
  • notebook-lm
  • people-search
  • people-search-org-chart
  • bi-directional-audio
  • feedback
  • session-sharing
  • personalization-memory
  • personalization-suggested-highlights
  • disable-agent-sharing
  • disable-image-generation
  • disable-video-generation
  • disable-onedrive-upload
  • disable-talk-to-content
  • disable-google-drive-upload
  • disable-welcome-emails
modelConfigs

map (key: string, value: enum (ModelState))

출력 전용입니다. 모델 이름을 이 엔진에 대한 해당 모델의 개별 구성에 매핑합니다. 이를 통해 관리자 사용자는 개별 모델을 사용 설정하거나 사용 중지할 수 있습니다. 여기에는 관리자가 상태를 재정의한 모델만 저장됩니다.

상태가 지정되지 않았거나, 특정 모델에 대해 modelConfigs가 비어 있는 경우, 해당 모델을 사용할 수 있을지 여부는 시스템이 기본 구성에 따라 결정합니다. 예를 들어 미리보기 모델은 관리자가 사용하도록 설정하지 않았다면 기본적으로 사용 중지되어야 합니다.
searchAddonSpec

object (SearchAddonSpec)

선택사항입니다. SearchAddonSpec은 검색 부가기능을 사용 중지하는 데 사용됩니다. 이 필드는 검색 요청에만 지원됩니다.

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 (ImageSource)
}
필드
resultCount

integer

답변을 생성할 상위 결과의 수입니다. 최대 10개
modelVersion

string

답변을 생성하는 데 사용된 모델 버전입니다.
modelPromptPreamble

string

대답을 생성하는 모델을 지시하는 프롬프트의 시작 부분에 있는 텍스트입니다.
maxRephraseSteps

integer

최대 재작성 단계입니다. 최대 단계 수는 5단계입니다. 설정되지 않았거나 1 미만으로 설정된 경우 기본적으로 1이 설정됩니다.
languageCode

string

요약의 언어 코드입니다. BCP47에 정의된 언어 태그를 사용합니다. 참고: 이 기능은 실험적 기능입니다.
ignoreNonAnswerSeekingQuery

boolean

선택사항입니다. 답변을 구하지 않는 쿼리를 필터링할지 여부를 지정합니다. 기본값은 false입니다.

검색어가 답변을 구하지 않는 질문으로 분류되면 답변이 반환되지 않습니다. 이 필드가 true로 설정되면 답변을 구하지 않는 질문에 대한 답변 생성을 건너뛰고 대신 대체 메시지를 반환합니다.
ignoreAdversarialQuery

boolean

선택사항입니다. 적대적인 쿼리를 필터링할지 여부를 지정합니다.
ignoreLowRelevantContent

boolean

선택사항입니다. 콘텐츠와 관련이 없는 쿼리를 필터링할지 여부를 지정합니다.
imageSource

enum (ImageSource)

선택사항입니다. 답변으로 반환되는 이미지의 소스입니다.

ImageSource

답변으로 반환되는 이미지의 소스입니다.

열거형
IMAGE_SOURCE_UNSPECIFIED 지정되지 않은 이미지 소스 (다중 모달 기능은 기본적으로 사용 중지됨)
ALL_AVAILABLE_SOURCES 서비스가 사용 가능한 모든 소스에서 선택을 결정할 때의 동작입니다.
CORPUS_IMAGE_ONLY 답변에 코퍼스의 이미지를 포함합니다.
FIGURE_GENERATION_ONLY 대답에서 그림 생성을 트리거합니다.

FeatureState

엔진 기능의 상태입니다.

열거형
FEATURE_STATE_UNSPECIFIED 기능 상태가 지정되지 않았습니다.
FEATURE_STATE_ON 기능이 사용 설정되어 사용할 수 있습니다.
FEATURE_STATE_OFF 기능이 사용 중지되어 사용할 수 없습니다.

ModelState

엔진에서 모델의 상태를 나타냅니다.

열거형
MODEL_STATE_UNSPECIFIED 모델 상태가 지정되지 않았습니다.
MODEL_ENABLED 관리자가 모델을 사용 설정했습니다.
MODEL_DISABLED 관리자가 모델을 사용 중지했습니다.

SearchAddonSpec

SearchAddonSpec은 검색 부가기능을 사용 중지하는 데 사용됩니다. 기본적으로 이 필드를 지정하지 않으면 해당하는 모든 위치에서 부가기능이 사용 설정됩니다.

JSON 표현 
{
  "semanticAddOnDisabled": boolean,
  "kpiPersonalizationAddOnDisabled": boolean,
  "generativeAnswerAddOnDisabled": boolean
}
필드
semanticAddOnDisabled

boolean

선택사항입니다. true인 경우 시맨틱 부가기능이 사용 중지됩니다. 시맨틱 부가기능에는 임베딩과 Jetstream이 포함됩니다.
kpiPersonalizationAddOnDisabled

boolean

선택사항입니다. true인 경우 KPI를 최적화하고 결과를 맞춤설정하기 위해 이벤트 재순위 지정 및 맞춤설정을 사용 중지합니다.
generativeAnswerAddOnDisabled

boolean

선택사항입니다. true인 경우 생성형 답변 부가기능이 사용 중지됩니다. 생성형 답변 부가기능에는 필터링을 위한 자연어와 간단한 답변이 포함됩니다.

AccessSettings

위젯 액세스 설정을 설명합니다.

JSON 표현 
{
  "allowPublicAccess": boolean,
  "allowlistedDomains": [
    string
  ],
  "enableWebApp": boolean,
  "workforceIdentityPoolProvider": string,
  "languageCode": string
}
필드
allowPublicAccess

boolean

인증되지 않은 공개 액세스가 허용되는지 여부입니다.
allowlistedDomains[]

string

검색 위젯을 통합할 수 있는 도메인 목록입니다.
enableWebApp

boolean

웹 앱 액세스 사용 설정 여부입니다.
workforceIdentityPoolProvider

string

선택사항입니다. 위젯에 액세스하는 데 사용되는 직원 ID 풀 제공업체입니다.
languageCode

string

선택사항입니다. 사용자 인터페이스의 언어 코드입니다. BCP47에 정의된 언어 태그를 사용합니다. 설정하지 않으면 기본 언어 코드는 'en-US'입니다.

UiBrandingSettings

위젯 UI 브랜딩 설정을 설명합니다.

JSON 표현 
{
  "logo": {
    object (Image)
  }
}
필드

이미지

이미지를 저장하는 옵션입니다.

JSON 표현 
{

  // Union field storage_method can be only one of the following:
  "url": string
  // End of list of possible types for union field storage_method.
}
필드
통합 필드 storage_method. 이미지를 저장하는 다양한 방법(예: URL 또는 base64 인코딩 문자열) storage_method은 다음 중 하나여야 합니다.
url

string

이미지 URL입니다.

HomepageSetting

위젯의 홈페이지 설정을 설명합니다. 여기에는 바로가기와 같은 모든 홈페이지 관련 설정 및 구성이 포함됩니다.

JSON 표현 
{
  "shortcuts": [
    {
      object (Shortcut)
    }
  ]
}
필드
shortcuts[]

object (Shortcut)

선택사항입니다. 홈페이지에 표시할 바로가기입니다.

단축키

홈페이지의 바로가기 (고정된 콘텐츠) 항목을 설명합니다. 홈페이지는 API가 반환하는 순서와 동일한 순서로 이러한 바로가기를 렌더링합니다. 고객이 바로가기를 재정렬하거나 삭제하려는 경우 UI는 항상 새로운 전체 바로가기 목록을 제공해야 합니다.

JSON 표현 
{
  "title": string,
  "icon": {
    object (Image)
  },
  "destinationUri": string
}
필드
title

string

선택사항입니다. 바로가기의 제목입니다.
icon

object (Image)

선택사항입니다. 바로가기의 아이콘 URL입니다.
destinationUri

string

선택사항입니다. 바로가기의 도착 URL입니다.

AssistantSettings

위젯의 어시스턴트 설정을 설명합니다.

JSON 표현 
{
  "googleSearchGroundingEnabled": boolean,
  "webGroundingType": enum (WebGroundingType),
  "defaultWebGroundingToggleOff": boolean,
  "disableLocationContext": boolean
}
필드
googleSearchGroundingEnabled
(deprecated)

boolean

Google 검색 그라운딩 전환 버튼이 표시되는지 여부입니다. 지원 중단되었습니다. 대신 webGroundingType를 사용하세요.
webGroundingType

enum (WebGroundingType)

선택사항입니다. 사용할 웹 그라운딩 유형입니다.
defaultWebGroundingToggleOff

boolean

출력 전용입니다. 이 필드는 webGroundingType이 WEB_GROUNDING_TYPE_GOOGLE_SEARCH 또는 WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH로 설정된 경우 최종 사용자의 기본 웹 그라운딩 전환 버튼을 제어합니다. 기본적으로 이 필드는 false로 설정되어 있습니다. webGroundingType이 WEB_GROUNDING_TYPE_GOOGLE_SEARCH 또는 WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH인 경우 최종 사용자의 UI에서 웹 그라운딩이 기본적으로 사용 설정됩니다. true인 경우 그라운딩 전환 버튼이 UI에서 기본적으로 사용 중지됩니다. 웹 그라운딩이 사용 설정된 경우 최종 사용자는 UI에서 웹 그라운딩을 사용 설정할 수 있습니다.
disableLocationContext

boolean

선택사항입니다. 출력 전용입니다. 사용자 위치 컨텍스트를 사용 중지할지 여부입니다.

WebGroundingType

사용할 웹 그라운딩 유형입니다.

열거형
WEB_GROUNDING_TYPE_UNSPECIFIED 기본값, 지정되지 않은 설정입니다. 사용 중지된 것과 같습니다.
WEB_GROUNDING_TYPE_DISABLED 웹 그라운딩이 사용 중지되었습니다.

CustomerProvidedConfig

고객이 제공한 구성입니다.

JSON 표현 
{
  "customerType": enum (CustomerType)
}
필드
customerType

enum (CustomerType)

고객 유형입니다.

CustomerType

고객 유형입니다.

열거형
DEFAULT_CUSTOMER 기본 고객 유형입니다.
GOVERNMENT_CUSTOMER 정부 고객 유형입니다. 법적 요구사항으로 인해 정부 고객에게는 일부 기능이 사용 중지됩니다.

노드

재사용 가능한 단일 컴퓨팅 또는 논리 단위를 나타냅니다.

JSON 표현 
{
  "displayName": string,
  "iconUrl": string,
  "description": string,
  "parameterSchema": {
    object
  },
  "outputSchema": {
    object
  },
  "type": enum (Type)
}
필드
displayName

string

출력 전용입니다. 노드의 사람이 읽을 수 있는 이름입니다.
iconUrl

string

출력 전용입니다. 이 노드 유형을 나타내는 아이콘을 가리키는 식별자 또는 URL입니다.
description

string

출력 전용입니다. 노드의 기능에 대한 자세한 설명입니다.
parameterSchema

object (Struct format)

출력 전용입니다. 도구의 매개변수 스키마입니다.

이 스키마는 OpenAPI 스키마 표준 (https://spec.openapis.org/oas/v3.0.3.html 및 AIP-146 참고)을 준수해야 합니다. 이 노드가 허용하는 매개변수의 예상 구조를 설명합니다.
outputSchema

object (Struct format)

출력 전용입니다. 도구의 출력 스키마입니다.

이 스키마는 OpenAPI 스키마 표준 (https://spec.openapis.org/oas/v3.0.3.html/ 및 AIP-146 참고)을 준수해야 합니다. 이 노드에서 생성된 출력의 구조를 설명합니다.
type

enum (Type)

출력 전용입니다. 노드 유형입니다.

유형

에이전트 흐름의 노드 유형을 식별합니다.

열거형
TYPE_UNSPECIFIED 알 수 없는 유형.
TRIGGER 트리거 유형입니다.
FLOW 흐름 유형입니다.
CONNECTOR 커넥터 유형입니다.

메서드

get

 WidgetConfig를 가져옵니다.

patch

 WidgetConfig를 업데이트합니다.