- 리소스: WidgetConfig
- JSON 표현
- UIComponentField
- DeviceVisibility
- FacetField
- DataStoreType
- ResultDisplayType
- DataStoreUiConfig
- CollectionComponent
- DataStoreComponent
- DataStoreConfigType
- ConnectorAuthState
- AuthState
- ConnectorMetadata
- UiSettings
- InteractionType
- GenerativeAnswerConfig
- ImageSource
- FeatureState
- ModelState
- SearchAddonSpec
- ModelConfigInfo
- ResolvedModel
- AdminView
- AccessSettings
- UiBrandingSettings
- 이미지
- HomepageSetting
- 바로가기
- AssistantSettings
- WebGroundingType
- CustomerProvidedConfig
- CustomerType
- ComplianceLevel
- BatchAuthStatus
- 노드
- 유형
- 메서드
리소스: WidgetConfig
WidgetConfig는 위젯 수준에서 적용되는 구성을 정의합니다.
| JSON 표현 |
|---|
{ "name": string, "displayName": string, "createTime": string, "updateTime": string, "enableAutocomplete": boolean, "fieldsUiComponentsMap": { string: { object ( |
| 필드 | |
|---|---|
name |
변경할 수 없습니다. 위젯 구성의 전체 리소스 이름입니다. 형식은 이 필드는 UTF-8로 인코딩된 문자열이어야 하며 길이 제한은 1024자(영문 기준)입니다. |
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 구성요소입니다. Mock. 현재 지원되는 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에서 필터링에 사용할 수 있으며, 사용자는 선택된 데이터 소스에서 가져온 결과를 반환할 수 있습니다. SaaS / 비즈니스 엔진의 경우 |
enableSearchAsYouType |
검색 위젯에서 입력 즉시 검색 기능을 사용 설정할지 여부입니다. |
defaultSearchRequestOrderBy |
지정된 경우 검색 결과의 기본 정렬 방식입니다. 이는 해당 요청에서 SearchRequest#orderBy 값을 설정하는 데 사용됩니다. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body |
uiSettings |
클라우드 콘솔의 위젯 구성 페이지에 표시되는 일반적인 위젯 검색 설정을 설명합니다. 상위 레벨에서 지원 중단된 속성들을 대체합니다. |
accessSettings |
Cloud 콘솔 통합 페이지에서 표시되는 모든 위젯 액세스 설정에 사용됩니다. 상위 레벨에서 지원 중단된 속성들을 대체합니다. |
uiBranding |
위젯 제목, 로고, 파비콘, 색상 등 검색 위젯의 UI 브랜딩 설정을 설명합니다. |
homepageSetting |
(선택사항) 위젯의 홈페이지 설정을 설명합니다. |
assistantSettings |
(선택사항) 출력 전용입니다. 위젯의 어시스턴트 설정을 설명합니다. |
customerProvidedConfig |
(선택사항) 출력 전용입니다. 고객 관련 구성을 설명하며, 현재는 정부 고객에게만 사용됩니다. 프로젝트 온보딩 후에는 이 필드를 수정할 수 없습니다. |
enablePrivateKnowledgeGraph |
(선택사항) 출력 전용입니다. 비공개 지식 그래프를 사용 설정할지 여부입니다. |
geminiBundle |
출력 전용입니다. 사용 중인 구독이 Gemini 번들인지 여부입니다. |
batchAuthStatuses[] |
출력 전용입니다. 위젯 커넥터의 일괄 승인 상태입니다. |
nodes[] |
출력 전용입니다. 위젯 설정과 관련된 노드입니다. |
UIComponentField
UI 구성요소에 매핑되는 패싯 필드입니다.
| JSON 표현 |
|---|
{
"field": string,
"deviceVisibility": [
enum ( |
| 필드 | |
|---|---|
field |
필수 항목입니다. 등록된 필드 이름입니다. 형식은 |
deviceVisibility[] |
다양한 기기 유형에서의 필드 가시성. |
displayTemplate |
필드가 표시되는 방식을 맞춤설정하는 템플릿입니다. 예시 값은 "가격: {값}"과 같은 문자열입니다. |
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 구성요소입니다. Mock. 현재 지원되는 UI 구성요소는 값은 필드 이름과, 해당 필드의 기기별 공개 상태 정보를 함께 나타냅니다. 3개의 커스텀 필드는 선택사항이며 필요에 따라 추가하거나 삭제할 수 있습니다. 반면, |
CollectionComponent
필터링에 사용할 수 있는 데이터 스토어 컬렉션 필드가 포함된 읽기 전용 컬렉션 구성요소입니다.
SaaS / 비즈니스 엔진의 경우 view = WITH_AVAILABLE_CONNECTORS와 함께 LookupWidgetConfig가 호출되면 이 메시지의 인스턴스는 호출자가 연결할 수 있지만 아직 연결하지 않은 커넥터의 합성 자리표시자 항목을 나타내는 데도 사용됩니다. 자리표시자 항목에는 connectorAuthState.auth_state == AUTH_STATE_UNSPECIFIED (또는 NO_AUTH), 빈 connectorAuthState.authorization_uri (위젯이 사용자의 '연결' 클릭 시 WidgetBuildAuthorizationUrl 호출), name / id의 합성 자리표시자 값이 있습니다 (필드 주석 참고). 구체화된 커넥터 (dataStoreComponents, tenant, actionConnector)에만 의미가 있는 필드는 자리표시자 항목에 대해 설정되지 않은 상태로 유지됩니다.
| JSON 표현 |
|---|
{ "name": string, "id": string, "displayName": string, "dataStoreComponents": [ { object ( |
| 필드 | |
|---|---|
name |
컬렉션의 이름입니다. 컬렉션 리소스 이름이어야 합니다. 형식은 가상 자리 표시자 항목 (메시지 수준 주석 참조)의 경우 실제 컬렉션에 해당하지 않는 가상 자리 표시자 컬렉션 ID가 포함됩니다. 호출자는 사용자가 커넥터를 승인할 때까지 이 리소스를 확인하거나 가져오려고 시도해서는 안 됩니다. |
id |
출력 전용입니다. 위젯 서비스에 사용되는 컬렉션 식별자입니다. 현재는 collectionId를 참조하지만 향후에는 필드가 암호화된 컬렉션 이름 UUID로 이전됩니다. 합성 자리표시자 항목 (메시지 수준 주석 참고)의 경우 실제 collectionId가 아닌 합성 자리표시자 ID입니다. |
displayName |
컬렉션의 표시 이름입니다. |
dataStoreComponents[] |
데이터 스토어 컬렉션의 경우 하위 데이터 스토어 목록입니다. |
dataSource |
|
dataSourceVersion |
출력 전용입니다. 이 컬렉션을 지원하는 커넥터 정의 버전으로, |
dataSourceDisplayName |
출력 전용입니다. 데이터 소스의 표시 이름입니다. |
dataSourceEndUserDisplayName |
출력 전용입니다. |
connectorIconLink |
출력 전용입니다. 커넥터 소스의 아이콘 링크입니다. |
connectorAuthState |
출력 전용입니다. 커넥터 소스의 인증 URI입니다. |
metadata |
출력 전용입니다. 레지스트리 |
isFirstParty |
출력 전용입니다. 서드 파티 커넥터가 아닌 퍼스트 파티 (Google 소유) 커넥터인지 여부입니다. 프런트엔드에서 퍼스트 파티 커넥터와 서드 파티 커넥터를 그룹화하는 데 사용됩니다. |
DataStoreComponent
필터링에 사용될 수 있는 데이터 스토어 필드를 포함하는 읽기 전용 데이터 스토어 구성 요소이며, CollectionComponent의 자식입니다.
| JSON 표현 |
|---|
{
"name": string,
"id": string,
"displayName": string,
"entityName": string,
"dataStoreConfigType": enum ( |
| 필드 | |
|---|---|
name |
데이터 스토어의 이름입니다. 데이터 스토어 리소스 이름 형식이어야 합니다( |
id |
출력 전용입니다. 위젯 서비스에 사용되는 데이터 스토어의 식별자입니다. 현재는 dataStoreId를 참조하지만 향후 필드를 암호화된 데이터 스토어 이름 UUID로 이전할 예정입니다. |
displayName |
데이터 스토어의 표시 이름입니다. |
entityName |
|
dataStoreConfigType |
출력 전용입니다. 데이터 스토어 구성의 유형입니다. |
DataStoreConfigType
데이터 스토어 구성의 유형입니다.
| 열거형 | |
|---|---|
DATA_STORE_CONFIG_TYPE_UNSPECIFIED |
기본값 이 값은 사용되지 않습니다. |
ALLOW_DB_CONFIG |
데이터 스토어가 AlloyDB에 연결되어 있습니다. |
THIRD_PARTY_OAUTH_CONFIG |
데이터 스토어가 서드 파티 데이터 소스에 연결되어 있습니다. |
NOTEBOOKLM_CONFIG |
데이터 스토어는 NotebookLM Enterprise에 연결되어 있습니다. |
ConnectorAuthState
CollectionComponent 인증 상태의 읽기 전용 커넥터입니다.
| JSON 표현 |
|---|
{
"authState": enum ( |
| 필드 | |
|---|---|
authState |
출력 전용입니다. 데이터 커넥터의 승인 상태입니다. |
authorizationUri |
출력 전용입니다. 데이터 커넥터의 승인 URI입니다. 합성 자리표시자 |
updateTime |
출력 전용입니다. 승인 상태 업데이트 타임스탬프입니다. 생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 |
AuthState
데이터 커넥터의 승인 상태입니다.
| 열거형 | |
|---|---|
AUTH_STATE_UNSPECIFIED |
기본값 또한 LookupWidgetConfig과 view = WITH_AVAILABLE_CONNECTORS (SaaS / 비즈니스 전용)에 의해 표시된 합성 자리 표시자 CollectionComponent 항목에 대해서도 반환됩니다. 이러한 항목은 호출자가 연결할 수 있지만 아직 연결하지 않은 커넥터를 나타냅니다. |
AUTHORIZED |
사용자가 데이터 커넥터를 승인했습니다. |
EXPIRED |
데이터 커넥터에 대한 사용자 권한이 만료되었습니다. |
ACTIONS_DISABLED |
사용자는 검색 요청을 할 수 있지만 작업을 사용 설정해야 합니다. |
NO_AUTH |
데이터 커넥터에는 승인이 필요하지 않습니다. 기본 커넥터에 사용자 OAuth가 필요하지 않은 자리표시자 항목에도 사용됩니다. |
ConnectorMetadata
커넥터 세부정보 페이지에 표시되는 커넥터의 사용자 대상 메타데이터 (제목, 설명, shortDescription, author, note)입니다.
| JSON 표현 |
|---|
{ "title": string, "description": string, "shortDescription": string, "author": string, "note": string } |
| 필드 | |
|---|---|
title |
선택사항입니다. 커넥터의 제목을 표시합니다. |
description |
선택사항입니다. 커넥터 상세 페이지에 표시되는 커넥터에 대한 사람이 읽기 쉬운 설명입니다. 커넥터 하나에는 설명이 하나 있습니다. |
shortDescription |
선택사항입니다. 커넥터에 대한 간략한 설명 (예: 목록 보기 및 상세 보기에서 커넥터 이름 아래에 표시됨)은 자막 길이 정도입니다. |
author |
선택사항입니다. 커넥터를 제작한 주체(예: "Google" 또는 제3자 제공업체 이름)입니다. 최종 사용자가 커넥터를 작성한 사람을 확인할 수 있도록 합니다 (향후: 타사에서 작성한 커넥터 확인). |
note |
선택사항입니다. 커넥터의 기능에 대한 자유 형식의 여러 줄 메모 또는 커넥터에 설정할 수 있는 사용자 지정 메모입니다. |
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 |
출력 전용입니다. 엔진이 특정 기능을 사용하거나 사용하지 않도록 설정하는 기능 구성입니다. 지원되는 키는 다음과 같습니다.
|
modelConfigs |
출력 전용입니다. 모델 이름을 이 엔진에 대한 해당 모델의 개별 구성에 매핑합니다. 이를 통해 관리자 사용자는 개별 모델을 사용 설정하거나 사용 중지할 수 있습니다. 여기에는 관리자가 상태를 재정의한 모델만 저장됩니다. 상태가 지정되지 않았거나, 특정 모델에 대해 modelConfigs가 비어 있는 경우, 해당 모델을 사용할 수 있을지 여부는 시스템이 기본 구성에 따라 결정합니다. 예를 들어 미리보기 모델은 관리자가 사용하도록 설정하지 않았다면 기본적으로 사용 중지되어야 합니다. |
searchAddonSpec |
선택사항입니다. SearchAddonSpec은 검색 부가기능을 사용 중지하는 데 사용됩니다. 이 필드는 검색 요청에만 지원됩니다. |
modelConfigInfo |
출력 전용입니다. 해결된 서버 측 모델 선택기 구성입니다. 모델 선택 드롭다운 메뉴에 표시될 모델의 정렬된 목록과 기본적으로 선택될 모델을 모두 포함합니다. 클라이언트는 자체 필터링, 정렬 또는 현지화를 적용하지 않고 이를 직접 렌더링해야 합니다. 위의 기존 |
sourceAdminDisplayNameEnabled |
선택사항입니다. 위젯 소스 UI에 데이터 커넥터의 관리자 구성 표시 이름을 표시할지 여부 (커넥터 종류 대신) 선택; 기본값은 false입니다. |
onedrivePickerEnabled |
출력 전용입니다. OneDrive 파일 선택 도구가 최종 사용자에게 제공되는지 여부입니다. 관리자 커넥터 사용 설정 (Business 에디션) 또는 연결된 OneDrive 커넥터 (Enterprise 버전)에서 백엔드에 의해 계산되며 기존
|
googleDrivePickerEnabled |
출력 전용입니다. 구글 드라이브 파일 선택기가 최종 사용자에게 제공되는지 여부. 위의 |
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 |
기능이 사용 중지되어 사용할 수 없습니다. |
ModelState
엔진 모델의 상태.
| 열거형 | |
|---|---|
MODEL_STATE_UNSPECIFIED |
모델 상태가 지정되지 않았습니다. |
MODEL_ENABLED |
관리자가 모델을 사용 설정했습니다. |
MODEL_DISABLED |
관리자가 모델을 사용 중지했습니다. |
SearchAddonSpec
SearchAddonSpec은 검색 부가기능을 사용 중지하는 데 사용됩니다. 기본적으로 이 필드를 지정하지 않으면 해당하는 모든 위치에서 부가기능이 사용 설정됩니다.
| JSON 표현 |
|---|
{ "semanticAddOnDisabled": boolean, "kpiPersonalizationAddOnDisabled": boolean, "generativeAnswerAddOnDisabled": boolean } |
| 필드 | |
|---|---|
semanticAddOnDisabled |
선택사항입니다. true인 경우 시맨틱 부가기능이 사용 중지됩니다. 시맨틱 부가기능에는 임베딩과 Jetstream이 포함됩니다. |
kpiPersonalizationAddOnDisabled |
선택사항입니다. true인 경우 KPI를 최적화하고 결과를 개인화하기 위해 이벤트 재정렬 및 맞춤설정을 사용 중지합니다. |
generativeAnswerAddOnDisabled |
선택사항입니다. true인 경우 생성형 답변 부가기능이 사용 중지됩니다. 생성형 답변 부가기능에는 필터링 및 간단한 답변을 위한 자연어가 포함됩니다. |
ModelConfigInfo
최종 사용자를 위한 모델 선택기 구성의 서버 측 최종 보기입니다. 백엔드는 Mendel 플래그 평가, 엔진 위치를 기반으로 한 지역 가용성 규칙, modelConfigs의 관리자 패널 재정의를 순서대로 적용하여 요청별로 이를 계산합니다.
백엔드는 이 구성의 단일 소스입니다. 클라이언트는 자체 필터링, 순서 지정 또는 현지화를 적용하지 않고 제공된 순서대로 모델 선택기 드롭다운에 resolvedModels를 직접 렌더링해야 합니다.
| JSON 표현 |
|---|
{
"resolvedModels": [
{
object ( |
| 필드 | |
|---|---|
resolvedModels[] |
출력 전용입니다. 모델 선택기에서 최종 사용자가 사용할 수 있는 모델 목록입니다. 표시되어야 하는 순서대로 나열됩니다. |
defaultModelId |
출력 전용입니다. 엔드 사용자가 명시적으로 선택하지 않은 경우 모델 선택기에서 기본적으로 선택해야 하는 모델의 |
ResolvedModel
모델 선택기에서 최종 사용자가 사용할 수 있도록 확인된 단일 모델로, 모든 현지화된 디스플레이 메타데이터가 포함됩니다.
| JSON 표현 |
|---|
{
"modelId": string,
"displayName": string,
"icon": string,
"description": string,
"isPreview": boolean,
"label": string,
"adminView": {
object ( |
| 필드 | |
|---|---|
modelId |
출력 전용입니다. 모델의 고유 식별자입니다 (예: 이는 클라이언트가 이 모델을 선택하기 위해 어시스턴트 서비스에 다시 전달하는 것과 동일한 식별자입니다. 가상 / '의사' 모델 (예: |
displayName |
출력 전용입니다. 모델의 현지화된 표시 이름 (예: |
icon |
출력 전용입니다. 모델과 연결된 GM3 호환 아이콘 토큰입니다 (예: |
description |
출력 전용입니다. 현지화된 설명 텍스트 (예: |
isPreview |
출력 전용입니다. 모델이 현재 미리보기 상태인지 여부입니다. 클라이언트는 선택기 UI의 '미리보기' 배지를 통해 이를 표시해야 합니다. |
label |
출력 전용입니다. 컴팩트 선택 막대 칩에 표시되는 짧은 레이블 (예: |
adminView |
출력 전용입니다. 관리자 표시 메타데이터입니다. 콘솔 관리자 기능 제어 페이지에만 채워집니다 ( |
promoted |
출력 전용입니다. 이 모델을 GE 채팅 홈페이지 배너에서 홍보할지 여부입니다. |
AdminView
관리자 표시 경로 메타데이터입니다. 요청이 클라우드 콘솔 관리자 "기능 제어" 페이지에서 시작된 경우에만 입력되며, 최종 사용자 화면 (웹, 모바일)에서는 설정되지 않은 상태로 유지됩니다. 관리 페이지가 하드코딩된 클라이언트 측 레지스트리 대신 백엔드에서 직접 전환 테이블을 렌더링하도록 허용
| JSON 표현 |
|---|
{ "adminOverridable": boolean, "enabledByDefault": boolean, "regions": [ string ] } |
| 필드 | |
|---|---|
adminOverridable |
출력 전용입니다. 관리자가 |
enabledByDefault |
출력 전용입니다. 관리자가 |
regions[] |
출력 전용입니다. 이 모델이 출시된 지역입니다. |
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 표현 |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "url": string // End of mutually exclusive fields. } |
| 필드 | |
|---|---|
| 이미지를 저장하는 다양한 방법(예: URL 또는 base64 인코딩 문자열) 다음은 상호 배타적인 필드 목록입니다. 응답에는 다음 필드 중 최대 하나가 설정됩니다. | |
url |
이미지 URL입니다. |
| 상호 배타적 필드의 끝입니다. | |
HomepageSetting
위젯의 홈페이지 설정을 설명합니다. 여기에는 바로가기와 같은 모든 홈페이지 관련 설정과 구성이 포함됩니다.
| JSON 표현 |
|---|
{
"shortcuts": [
{
object ( |
| 필드 | |
|---|---|
shortcuts[] |
선택사항입니다. 홈페이지에 표시할 바로가기입니다. |
단축키
홈페이지의 바로가기 (고정된 콘텐츠) 항목을 설명합니다. 홈페이지는 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 |
고객 유형입니다. |
complianceLevel |
출력 전용입니다. 고객의 Assured Workloads 규정 준수 수준입니다.
|
CustomerType
고객 유형입니다.
| 열거형 | |
|---|---|
DEFAULT_CUSTOMER |
기본 고객 유형입니다. |
GOVERNMENT_CUSTOMER |
정부 고객 유형입니다. 현지 법규로 인해 정부 고객에게는 일부 기능이 사용 중지됩니다. |
ComplianceLevel
고객 프로젝트의 Assured Workloads 준수 수준.
고정되지 않음: 더 많은 규정 준수 체계가 지원됨에 따라 추가 수준이 추가될 수 있으므로 클라이언트는 인식할 수 없는 값을 무제한이 아닌 정부 제한으로 취급해야 합니다.
| 열거형 | |
|---|---|
COMPLIANCE_LEVEL_UNSPECIFIED |
프로젝트에 Assured Workloads 규정 준수 수준이 없거나 이 API 버전에서 모델링하지 않는 수준을 보고합니다. |
COMPLIANCE_LEVEL_FEDRAMP_HIGH |
FedRAMP 높은 수준의 규정 준수. |
COMPLIANCE_LEVEL_IL4 |
영향 수준 4 (IL4) 규정 준수 수준 |
COMPLIANCE_LEVEL_IL5 |
영향 수준 5 (IL5) 규정 준수 수준 |
BatchAuthStatus
batchAuthorizationGroup의 일괄 승인 상태를 설명합니다.
| JSON 표현 |
|---|
{
"placeholder": string,
"batchAuthorizationGroup": string,
"connectorAuthState": {
object ( |
| 필드 | |
|---|---|
placeholder |
출력 전용입니다. 이는 배치 권한 그룹의 자리 표시자 전체 리소스 이름입니다. 이것은 실제 데이터 커넥터가 아닙니다 (스패너의 DataConnector 테이블에 존재하지 않습니다). 사용자 테이블의 connector_authorization에만 있는 리소스 이름입니다. 예: projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector |
batchAuthorizationGroup |
출력 전용입니다. 자리표시자가 속한 일괄 승인 그룹입니다. |
connectorAuthState |
출력 전용입니다. 이 커넥터의 현재 승인 상태입니다. |
노드
재사용 가능한 단일 계산 또는 논리 단위를 나타냅니다.
| JSON 표현 |
|---|
{
"displayName": string,
"iconUrl": string,
"description": string,
"parameterSchema": {
object
},
"outputSchema": {
object
},
"type": enum ( |
| 필드 | |
|---|---|
displayName |
출력 전용입니다. 노드에 대한 사람이 읽기 쉬운 이름입니다. |
iconUrl |
출력 전용입니다. 이 노드 유형을 나타내는 아이콘을 가리키는 식별자 또는 URL입니다. |
description |
출력 전용입니다. 노드의 기능에 대한 자세한 설명입니다. |
parameterSchema |
출력 전용입니다. 해당 도구의 매개변수 스키마입니다. 이 스키마는 OpenAPI 스키마 표준 (https://spec.openapis.org/oas/v3.0.3.html 및 AIP-146 참고)을 준수해야 합니다. 이 노드가 허용하는 매개변수의 예상 구조를 설명합니다. |
outputSchema |
출력 전용입니다. 도구의 출력 스키마입니다. 이 스키마는 OpenAPI 스키마 표준을 준수해야 합니다 (참조 https://spec.openapis.org/oas/v3.0.3.html/ 및 AIP-146). 이 노드에서 생성된 출력의 구조를 설명합니다. |
type |
출력 전용입니다. 노드 유형입니다. |
유형
에이전트 흐름의 노드 유형을 식별합니다.
| 열거형 | |
|---|---|
TYPE_UNSPECIFIED |
알 수 없는 유형. |
TRIGGER |
트리거 유형입니다. |
FLOW |
흐름 유형. |
CONNECTOR |
커넥터 유형입니다. |
메서드 |
|
|---|---|
|
WidgetConfig를 가져옵니다. |
|
WidgetConfig를 업데이트합니다. |