- 리소스: Engine
- SimilarDocumentsEngineConfig
- ChatEngineConfig
- AgentCreationConfig
- SearchEngineConfig
- SearchTier
- SearchAddOn
- MediaRecommendationEngineConfig
- OptimizationObjectiveConfig
- TrainingState
- EngineFeaturesConfig
- RecommendedForYouFeatureConfig
- MostPopularFeatureConfig
- RecommendationMetadata
- ServingState
- DataState
- ChatEngineMetadata
- CommonConfig
- KnowledgeGraphConfig
- FeatureConfig
- AppType
- FeatureState
- ConfigurableBillingApproach
- ModelState
- 메서드
리소스: Engine
Engine의 학습 및 서빙 파라미터를 설명하는 메타데이터입니다.
| JSON 표현 |
|---|
{ "name": string, "displayName": string, "createTime": string, "updateTime": string, "dataStoreIds": [ string ], "solutionType": enum ( |
| 필드 | |
|---|---|
name |
변경할 수 없습니다. 식별자. 엔진의 정규화된 리소스 이름을 나타냅니다. 이 필드는 길이 제한이 1,024자(영문 기준)인 UTF-8로 인코딩된 문자열이어야 합니다. 형식: |
displayName |
필수 항목. 엔진의 표시 이름입니다. 인간이 읽을 수 있는 형태여야 합니다. 길이 제한이 1,024자(영문 기준)인 UTF-8로 인코딩된 문자열입니다. |
createTime |
출력 전용입니다. 추천 엔진이 생성된 시각의 타임스탬프를 나타냅니다. 생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 |
updateTime |
출력 전용입니다. 추천 엔진이 마지막으로 업데이트된 시각의 타임스탬프입니다. 생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 |
dataStoreIds[] |
선택사항. 이 엔진과 연결된 데이터 스토어입니다.
|
solutionType |
필수 항목. 엔진의 솔루션입니다. |
industryVertical |
선택사항. 엔진이 등록되는 업종 카테고리입니다. 엔진 업종 카테고리는 연결된 |
commonConfig |
엔진의 메타데이터를 지정하는 공통 구성 사양입니다. |
knowledgeGraphConfig |
선택사항입니다. 지식 그래프의 구성입니다. |
appType |
선택사항입니다. 변경할 수 없습니다. 이 엔진 리소스가 나타내는 애플리케이션 유형입니다. 참고: 이는 기존 업종 카테고리 또는 솔루션 유형과 무관한 새로운 개념입니다. |
disableAnalytics |
선택사항. 이 엔진에서 수행되는 검색에 대해 분석을 사용 중지할지 여부입니다. |
features |
선택사항. 엔진이 특정 기능을 사용하거나 사용하지 않도록 설정하는 기능 구성입니다. 지원되는 키는 다음과 같습니다.
|
cmekConfig |
출력 전용입니다. 엔진에 대한 CMEK 관련 정보를 포함합니다. |
configurableBillingApproach |
선택사항. 구성 가능한 결제 방식에 대한 설정입니다. |
modelConfigs |
선택사항. 모델 이름을 이 엔진에 대한 해당 모델의 개별 구성에 매핑합니다. 이를 통해 관리자 사용자는 개별 모델을 사용 설정하거나 사용 중지할 수 있습니다. 여기에는 관리자가 상태를 재정의한 모델만 저장됩니다. 상태가 지정되지 않았거나, 특정 모델에 대해 modelConfigs가 비어 있는 경우, 해당 모델을 사용할 수 있을지 여부는 시스템이 기본 구성에 따라 결정합니다. 예를 들어 미리보기 모델은 관리자가 사용하도록 설정하지 않았다면 기본적으로 사용 중지되어야 합니다. |
통합 필드 engine_config. 엔진의 동작을 정의하는 추가 구성 사양입니다. engine_config은 다음 중 하나여야 합니다. |
|
similarDocumentsConfig |
|
chatEngineConfig |
Chat Engine에 대한 구성입니다. |
searchEngineConfig |
검색 엔진에 대한 구성입니다. |
mediaRecommendationEngineConfig |
미디어 엔진에 대한 구성입니다. |
통합 필드 engine_metadata. 엔진 상태를 모니터링하기 위한 엔진 메타데이터입니다. engine_metadata는 다음 중 하나여야 합니다. |
|
recommendationMetadata |
출력 전용입니다. 추천 엔진에 대한 추가 정보입니다. |
chatEngineMetadata |
출력 전용입니다. 채팅 엔진에 대한 추가 정보를 제공합니다. |
SimilarDocumentsEngineConfig
이 유형에는 필드가 없습니다.
similar-items 엔진을 위한 추가 구성 사양입니다.
ChatEngineConfig
채팅 엔진에 대한 구성입니다.
| JSON 표현 |
|---|
{
"agentCreationConfig": {
object ( |
| 필드 | |
|---|---|
agentCreationConfig |
이 엔진과 연결되는 Dialogflow 에이전트를 생성하기 위한 구성입니다. 이 구성은 엔진 생성 시 한 번만 Dialogflow 서비스로 전달되어 사용됩니다. 즉, 엔진 생성 이후에는 |
dialogflowAgentToLink |
이 채팅 엔진에 연결할 기존 Dialogflow 에이전트의 리소스 이름입니다. 고객은 형식:
|
allowCrossRegion |
선택사항. 이 플래그를 true로 설정하면 에이전트와 엔진이 서로 다른 위치에 존재하는 것을 허용합니다. 그렇지 않으면 에이전트와 엔진은 반드시 동일한 위치에 있어야 합니다. 이 플래그는 기본적으로 false로 설정됩니다.
|
AgentCreationConfig
Dialogflow 에이전트를 생성하기 위한 구성입니다.
이 구성은 엔진 생성 시 한 번만 Dialogflow 서비스로 전달되어 사용됩니다. 즉, 엔진 생성 이후에는 EngineService.GetEngine 또는 EngineService.ListEngines API를 사용하여 조회할 수 없습니다.
| JSON 표현 |
|---|
{ "business": string, "defaultLanguageCode": string, "timeZone": string, "location": string } |
| 필드 | |
|---|---|
business |
에이전트가 대표하는 회사, 조직 또는 기타 항목의 이름입니다. 이 값은 지식 커넥터 LLM 프롬프트 및 지식 검색에 사용됩니다. |
defaultLanguageCode |
필수 항목. 에이전트 기본 언어로, 언어 태그로 사용됩니다. 현재 지원되는 언어 코드 목록은 언어 지원을 참조하세요. |
timeZone |
필수 항목. 시간대 데이터베이스의 에이전트 시간대입니다(예: America/New_York, Europe/Paris). |
location |
에이전트 생성 시 사용할 에이전트 위치입니다. 지원되는 값은 global/us/eu입니다. 이 값을 지정하지 않으면, us 리전의 엔진은 기본적으로 us-central-1에, eu 리전의 엔진은 기본적으로 eu-west-1에 에이전트를 생성합니다. |
SearchEngineConfig
검색 엔진에 대한 구성입니다.
| JSON 표현 |
|---|
{ "searchTier": enum ( |
| 필드 | |
|---|---|
searchTier |
이 엔진이 사용하는 검색 기능 등급입니다. 등급에 따라 가격 책정이 달라질 수 있습니다. 자세한 내용은 가격 책정 문서를 참조하세요. 지정하지 않을 경우 기본값은 |
requiredSubscriptionTier |
선택사항입니다. 이 엔진의 필수 구독 등급입니다. 엔진 생성 후에는 수정할 수 없습니다. 필요한 구독 등급이 검색인 경우 지원과 같은 더 높은 라이선스 등급의 사용자는 이 엔진과 연결된 독립형 앱에 계속 액세스할 수 있습니다. |
searchAddOns[] |
이 검색 엔진에서 사용 설정하는 부가기능입니다. |
SearchTier
검색 기능의 등급입니다. 등급에 따라 가격 책정이 달라질 수 있습니다. 자세한 내용은 가격 책정 문서를 참조하세요.
| 열거형 | |
|---|---|
SEARCH_TIER_UNSPECIFIED |
열거형이 지정되지 않은 경우의 기본값입니다. 유효하지 않은 값입니다. |
SEARCH_TIER_STANDARD |
표준 등급입니다. |
SEARCH_TIER_ENTERPRISE |
엔터프라이즈 등급입니다. |
SearchAddOn
검색에 추가 기능을 제공하는 부가기능입니다.
| 열거형 | |
|---|---|
SEARCH_ADD_ON_UNSPECIFIED |
열거형이 지정되지 않은 경우의 기본값입니다. 유효하지 않은 값입니다. |
SEARCH_ADD_ON_LLM |
대규모 언어 모델 부가기능입니다. |
MediaRecommendationEngineConfig
미디어 추천 엔진을 위한 추가 구성 사양입니다.
| JSON 표현 |
|---|
{ "type": string, "optimizationObjective": string, "optimizationObjectiveConfig": { object ( |
| 필드 | |
|---|---|
type |
필수 항목. 엔진 유형입니다. 예: 이 필드는 현재 지원되는 값: |
optimizationObjective |
최적화 목표입니다. 예: 이 필드는 현재 지원되는 값: 지정하지 않으면 엔진 유형에 따라 기본값을 선택합니다. 기본값은 추천 유형에 따라 달라집니다.
|
optimizationObjectiveConfig |
cvr 최적화 목표를 위한 커스텀 기준점의 이름과 값입니다. targetField가 |
trainingState |
엔진의 현재 학습 상태입니다(예: 서비스 실행 비용의 일부는 학습 빈도에 의해 결정되므로, 이 필드를 통해 엔진 학습 시점을 조절하여 비용을 관리할 수 있습니다. 지정하지 않은 경우: |
engineFeaturesConfig |
선택사항. 엔진 기능에 대한 추가 구성입니다. |
OptimizationObjectiveConfig
cvr 최적화 목표를 위한 커스텀 기준점입니다.
| JSON 표현 |
|---|
{ "targetField": string, "targetFieldValueFloat": number } |
| 필드 | |
|---|---|
targetField |
필수 항목. 최적화할 대상 필드의 이름입니다. 현재 지원되는 값: |
targetFieldValueFloat |
필수 항목. 대상 필드에 적용할 기준점입니다(예: 0.5). |
TrainingState
엔진의 학습 상태입니다.
| 열거형 | |
|---|---|
TRAINING_STATE_UNSPECIFIED |
지정되지 않은 학습 상태입니다. |
PAUSED |
엔진 학습이 일시 중지된 상태입니다. |
TRAINING |
엔진이 학습 중입니다. |
EngineFeaturesConfig
선택한 엔진 유형에 대한 추가 기능 구성입니다.
| JSON 표현 |
|---|
{ // Union field |
| 필드 | |
|---|---|
통합 필드 type_dedicated_config. 특정 미디어 추천 엔진 유형에 적용되는 기능 관련 구성입니다. type_dedicated_config는 다음 중 하나여야 합니다. |
|
recommendedForYouConfig |
추천 서비스 엔진 기능 구성입니다. |
mostPopularConfig |
최고 인기 엔진 기능 구성입니다. |
RecommendedForYouFeatureConfig
recommended-for-you 엔진을 만들기 위한 추가 기능 구성입니다.
| JSON 표현 |
|---|
{ "contextEventType": string } |
| 필드 | |
|---|---|
contextEventType |
예측 시 엔진을 쿼리할 때 사용되는 이벤트 유형입니다. 값을 |
MostPopularFeatureConfig
최고 인기 엔진을 만드는 데 필요한 기능 구성입니다.
| JSON 표현 |
|---|
{ "timeWindowDays": string } |
| 필드 | |
|---|---|
timeWindowDays |
학습 및 예측 시 엔진을 쿼리하는 기간입니다. 양의 정수만 허용됩니다. 이 값은 지난 X일 동안의 이벤트를 의미합니다. 현재 |
RecommendationMetadata
추천 엔진에 대한 추가 정보입니다.
| JSON 표현 |
|---|
{ "servingState": enum ( |
| 필드 | |
|---|---|
servingState |
출력 전용입니다. 엔진의 제공 상태입니다( |
dataState |
출력 전용입니다. 이 엔진의 데이터 요구사항 상태입니다( 데이터가 |
lastTuneTime |
출력 전용입니다. 최근에 성공한 조정이 완료된 타임스탬프입니다. 미디어 추천 엔진에만 적용됩니다. 생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 |
lastTrainTime |
출력 전용입니다. 최근에 성공한 학습이 완료된 타임스탬프입니다. 미디어 추천 엔진에만 적용됩니다. 생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 |
tuningOperation |
출력 전용입니다. 엔진과 연결된 최신 조정 작업 ID입니다. 미디어 추천 엔진에만 적용됩니다. 있는 경우 이 작업 ID를 사용하여 이 엔진의 진행 중인 조정이 있는지 확인할 수 있습니다. 작업 상태를 확인하려면 엔진 리소스 형식으로 이 작업 ID와 함께 operations.get 요청을 전송합니다. 이 엔진에 대해 튜닝이 발생하지 않은 경우 문자열은 비어 있습니다. |
ServingState
추천 엔진의 제공 상태입니다.
| 열거형 | |
|---|---|
SERVING_STATE_UNSPECIFIED |
지정되지 않은 게재 상태입니다. |
INACTIVE |
엔진이 게재되지 않습니다. |
ACTIVE |
엔진이 제공 중이며 쿼리할 수 있습니다. |
TUNED |
엔진은 조정된 초매개변수를 기반으로 학습되며 쿼리할 수 있습니다. |
DataState
이 엔진이 지속적으로 학습할 수 있는 충분한 학습 데이터가 있는지 설명합니다.
| 열거형 | |
|---|---|
DATA_STATE_UNSPECIFIED |
지정되지 않은 기본값으로, 명시적으로 설정해서는 안 됩니다. |
DATA_OK |
엔진에 충분한 학습 데이터가 있습니다. |
DATA_ERROR |
엔진에 충분한 학습 데이터가 없습니다. 오류 메시지는 Stackdriver를 통해 쿼리할 수 있습니다. |
ChatEngineMetadata
채팅 엔진에 대한 추가 정보입니다. 이 메시지의 필드는 출력 전용입니다.
| JSON 표현 |
|---|
{ "dialogflowAgent": string } |
| 필드 | |
|---|---|
dialogflowAgent |
이 채팅 엔진이 참조하는 Dialogflow 에이전트의 리소스 이름입니다. 형식: |
CommonConfig
엔진에 대한 공통 구성입니다.
| JSON 표현 |
|---|
{ "companyName": string } |
| 필드 | |
|---|---|
companyName |
엔진과 연관된 회사, 비즈니스 또는 조직의 이름입니다. 이 값을 설정하면 LLM 관련 기능이 향상될 수 있습니다. |
KnowledgeGraphConfig
지식 그래프의 구성 메시지입니다.
| JSON 표현 |
|---|
{
"enableCloudKnowledgeGraph": boolean,
"cloudKnowledgeGraphTypes": [
string
],
"enablePrivateKnowledgeGraph": boolean,
"privateKnowledgeGraphTypes": [
string
],
"featureConfig": {
object ( |
| 필드 | |
|---|---|
enableCloudKnowledgeGraph |
엔진에 Cloud Knowledge Graph를 사용 설정할지 여부입니다. 지정하지 않으면 기본값은 false입니다. |
cloudKnowledgeGraphTypes[] |
지원할 항목 유형을 지정합니다. |
enablePrivateKnowledgeGraph |
엔진에 비공개 지식 그래프를 사용 설정할지 여부입니다. 지정하지 않으면 기본값은 false입니다. |
privateKnowledgeGraphTypes[] |
지원할 항목 유형을 지정합니다. |
featureConfig |
선택사항입니다. 지식 그래프의 기능 구성입니다. |
FeatureConfig
지식 그래프의 기능 구성입니다.
| JSON 표현 |
|---|
{ "disablePrivateKgQueryUnderstanding": boolean, "disablePrivateKgEnrichment": boolean, "disablePrivateKgAutoComplete": boolean, "disablePrivateKgQueryUiChips": boolean } |
| 필드 | |
|---|---|
disablePrivateKgQueryUnderstanding |
엔진의 비공개 KG 쿼리 이해를 사용 중지할지 여부입니다. 지정하지 않으면 기본값은 false입니다. |
disablePrivateKgEnrichment |
엔진의 비공개 KG 보강을 사용 중지할지 여부입니다. 지정하지 않으면 기본값은 false입니다. |
disablePrivateKgAutoComplete |
엔진의 비공개 KG 자동 완성을 사용 중지할지 여부입니다. 지정하지 않으면 기본값은 false입니다. |
disablePrivateKgQueryUiChips |
쿼리 UI 칩의 비공개 KG를 사용 중지할지 여부입니다. 지정하지 않으면 기본값은 false입니다. |
AppType
엔진의 앱 유형입니다.
| 열거형 | |
|---|---|
APP_TYPE_UNSPECIFIED |
지정되지 않은 모든 앱 유형입니다. |
APP_TYPE_INTRANET |
인트라넷 검색 및 Agentspace용 앱 유형입니다. |
FeatureState
엔진 기능의 상태입니다.
| 열거형 | |
|---|---|
FEATURE_STATE_UNSPECIFIED |
기능 상태가 지정되지 않았습니다. |
FEATURE_STATE_ON |
기능이 사용 설정되어 사용할 수 있습니다. |
FEATURE_STATE_OFF |
기능이 사용 중지되어 사용할 수 없습니다. |
ConfigurableBillingApproach
구성 가능한 결제 방식에 대한 설정입니다.
| 열거형 | |
|---|---|
CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED |
기본값 Spark 및 비Spark 환경에서 결제 방식을 구성할 수 없는 경우에 사용되는 일반 가격 책정 모델입니다. |
CONFIGURABLE_BILLING_APPROACH_ENABLED |
고객이 지정한 구성에 따라 결제 방식이 적용됩니다. |
ModelState
엔진에서 모델의 상태를 나타냅니다.
| 열거형 | |
|---|---|
MODEL_STATE_UNSPECIFIED |
모델 상태가 지정되지 않았습니다. |
MODEL_ENABLED |
관리자가 모델을 사용 설정했습니다. |
MODEL_DISABLED |
관리자가 모델을 사용 중지했습니다. |
메서드 |
|
|---|---|
|
Engine를 만듭니다. |
|
Engine를 삭제합니다. |
|
Engine를 가져옵니다. |
|
CompletionConfig를 가져옵니다. |
|
최종 사용자의 Workspace 설정을 가져옵니다. |
|
프로젝트와 연결된 모든 Engine를 나열합니다. |
|
Engine을 업데이트합니다. |
|
기존 엔진의 학습을 일시중지합니다. |
|
기존 엔진의 학습을 재개합니다. |
|
기존 엔진을 조정합니다. |
|
CompletionConfig를 업데이트합니다. |