REST Resource: projects.locations.collections.engines

리소스: 엔진

Engine의 학습 및 서빙 매개변수를 설명하는 메타데이터입니다.

JSON 표현 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "dataStoreIds": [
    string
  ],
  "solutionType": enum (SolutionType),
  "industryVertical": enum (IndustryVertical),
  "commonConfig": {
    object (CommonConfig)
  },
  "appType": enum (AppType),
  "disableAnalytics": boolean,
  "features": {
    string: enum (FeatureState),
    ...
  },
  "configurableBillingApproach": enum (ConfigurableBillingApproach),

  // Union field engine_config can be only one of the following:
  "chatEngineConfig": {
    object (ChatEngineConfig)
  },
  "searchEngineConfig": {
    object (SearchEngineConfig)
  },
  "mediaRecommendationEngineConfig": {
    object (MediaRecommendationEngineConfig)
  }
  // End of list of possible types for union field engine_config.

  // Union field engine_metadata can be only one of the following:
  "chatEngineMetadata": {
    object (ChatEngineMetadata)
  }
  // End of list of possible types for union field engine_metadata.
}
필드
name

string

변경할 수 없습니다. 식별자. 엔진의 정규화된 리소스 이름입니다.

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

형식: projects/{project}/locations/{location}/collections/{collection}/engines/{engine} 엔진은 1~63자(영문 기준)여야 하며 유효한 문자는 /[a-z0-9][a-z0-9-_]*/입니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다.
displayName

string

필수 항목입니다. 엔진의 표시 이름입니다. 사람이 읽을 수 있어야 합니다. 길이 제한이 1,024자인 UTF-8로 인코딩된 문자열입니다.
createTime

string (Timestamp format)

출력 전용입니다. 추천 엔진이 생성된 타임스탬프입니다.

생성된 출력은 항상 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)

출력 전용입니다. 추천 엔진이 마지막으로 업데이트된 타임스탬프입니다.

생성된 출력은 항상 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"입니다.
dataStoreIds[]

string

(선택사항) 이 엔진과 연결된 데이터 스토어입니다.

SOLUTION_TYPE_SEARCH 및 SOLUTION_TYPE_RECOMMENDATION 유형의 엔진은 최대 하나의 데이터 스토어와만 연결할 수 있습니다.

solutionType이 SOLUTION_TYPE_CHAT인 경우 동일한 Collection의 여러 DataStore를 여기에 연결할 수 있습니다.

CreateEngineRequest에서 사용되는 경우 시스템에서 필요한 초기화에 사용하므로 하나의 DataStore ID를 제공해야 합니다.
solutionType

enum (SolutionType)

필수 항목입니다. 엔진의 솔루션입니다.
industryVertical

enum (IndustryVertical)

(선택사항) 엔진이 등록하는 업종 카테고리입니다. 엔진 업종 카테고리 제한은 DataStore에 기반합니다. 엔진의 업종 카테고리는 엔진에 연결된 데이터 스토어의 업종 카테고리와 일치해야 합니다.
commonConfig

object (CommonConfig)

엔진의 메타데이터를 지정하는 일반 구성 사양입니다.
appType

enum (AppType)

(선택사항) 변경할 수 없습니다. 이 엔진 리소스가 나타내는 애플리케이션 유형입니다. 참고: 이는 기존 업종 카테고리 또는 솔루션 유형과 별개의 새로운 개념입니다.
disableAnalytics

boolean

(선택사항) 이 엔진에서 실행된 검색의 분석을 사용 중지할지 여부입니다.
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
  • disable-agent-sharing
  • disable-image-generation
  • disable-video-generation
  • disable-onedrive-upload
  • disable-talk-to-content
  • disable-google-drive-upload
configurableBillingApproach

enum (ConfigurableBillingApproach)

(선택사항) 구성 가능한 결제 접근 방식의 구성입니다.
통합 필드 engine_config. 엔진의 동작을 정의하는 추가 구성 사양입니다. engine_config은 다음 중 하나여야 합니다.
chatEngineConfig

object (ChatEngineConfig)

Chat Engine 구성입니다. solutionType이 SOLUTION_TYPE_CHAT인 경우에만 적용됩니다.
searchEngineConfig

object (SearchEngineConfig)

검색 엔진의 구성입니다. solutionType이 SOLUTION_TYPE_SEARCH인 경우에만 적용됩니다.
mediaRecommendationEngineConfig

object (MediaRecommendationEngineConfig)

미디어 엔진 구성입니다. solutionType SOLUTION_TYPE_RECOMMENDATION 및 IndustryVertical.MEDIA 업종이 있는 데이터 스토어에만 적용됩니다.
통합 필드 engine_metadata. 엔진 상태를 모니터링하는 엔진 메타데이터입니다. engine_metadata은 다음 중 하나여야 합니다.
chatEngineMetadata

object (ChatEngineMetadata)

출력 전용입니다. Chat Engine의 추가 정보입니다. solutionType이 SOLUTION_TYPE_CHAT인 경우에만 적용됩니다.

ChatEngineConfig

Chat Engine의 구성입니다.

JSON 표현 
{
  "agentCreationConfig": {
    object (AgentCreationConfig)
  },
  "dialogflowAgentToLink": string,
  "allowCrossRegion": boolean
}
필드
agentCreationConfig

object (AgentCreationConfig)

이 엔진과 연결된 Dialogflow 에이전트를 생성하는 구성입니다.

이러한 구성은 Dialogflow 서비스에서 한 번 사용되고 전달됩니다. 즉, 엔진을 만든 후에는 EngineService.GetEngine 또는 EngineService.ListEngines API를 사용하여 검색할 수 없습니다.
allowCrossRegion

boolean

(선택사항) 플래그가 true로 설정된 경우 에이전트와 엔진이 서로 다른 위치에 있을 수 있습니다. 그렇지 않으면 에이전트와 엔진이 동일한 위치에 있어야 합니다. 플래그는 기본적으로 false로 설정됩니다.

allowCrossRegion는 EngineService.CreateEngine에 의해 일회성으로 사용되고 전달됩니다. 즉, 엔진을 만든 후에는 EngineService.GetEngine 또는 EngineService.ListEngines API를 사용하여 검색할 수 없습니다.

AgentCreationConfig

Dialogflow 에이전트 생성 구성입니다.

이러한 구성은 Dialogflow 서비스에서 한 번 사용되고 전달됩니다. 즉, 엔진을 만든 후에는 EngineService.GetEngine 또는 EngineService.ListEngines API를 사용하여 검색할 수 없습니다.

JSON 표현 
{
  "business": string,
  "defaultLanguageCode": string,
  "timeZone": string,
  "location": string
}
필드
business

string

대리인이 대표하는 회사, 조직 또는 기타 법인의 이름입니다. 지식 커넥터 LLM 프롬프트 및 지식 검색에 사용됩니다.
defaultLanguageCode

string

필수 항목입니다. 에이전트 기본 언어로, 언어 태그로 사용됩니다. 현재 지원되는 언어 코드 목록은 언어 지원을 참조하세요.
timeZone

string

필수 항목입니다. 시간대 데이터베이스의 에이전트 시간대입니다(예: America/New_York, Europe/Paris).
location

string

에이전트 생성의 에이전트 위치입니다. 지원되는 값은 global/us/eu입니다. 제공되지 않으면 미국 엔진은 기본적으로 us-central-1을 사용하여 에이전트를 생성하고, EU 엔진은 기본적으로 eu-west-1을 사용하여 에이전트를 생성합니다.

SearchEngineConfig

검색 엔진의 구성입니다.

JSON 표현 
{
  "searchTier": enum (SearchTier),
  "searchAddOns": [
    enum (SearchAddOn)
  ]
}
필드
searchTier

enum (SearchTier)

이 엔진의 검색 기능 등급입니다.

요금제마다 가격이 다를 수 있습니다. 자세한 내용은 가격 책정 문서를 참고하세요.

지정하지 않을 경우 기본값은 SearchTier.SEARCH_TIER_STANDARD입니다.
searchAddOns[]

enum (SearchAddOn)

이 검색엔진이 사용 설정하는 부가기능입니다.

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 (OptimizationObjectiveConfig)
  },
  "trainingState": enum (TrainingState),
  "engineFeaturesConfig": {
    object (EngineFeaturesConfig)
  }
}
필드
type

string

필수 항목입니다. 엔진 유형입니다. 예를 들면 recommended-for-you개

이 필드는 optimizationObjective와 함께 엔진 학습 및 제공을 제어하는 데 사용할 엔진 메타데이터를 설명합니다.

현재 지원되는 값: recommended-for-you, others-you-may-like, more-like-this, most-popular-items
optimizationObjective

string

최적화 목표입니다. 예: cvr개

이 필드는 optimizationObjective와 함께 엔진 학습 및 제공을 제어하는 데 사용할 엔진 메타데이터를 설명합니다.

현재 지원되는 값은 ctr, cvr입니다.

지정하지 않으면 엔진 유형에 따라 기본값이 선택됩니다. 기본값은 추천 유형에 따라 다릅니다.

recommended-for-you => ctr

others-you-may-like => ctr
optimizationObjectiveConfig

object (OptimizationObjectiveConfig)

전환율 최적화 목표의 맞춤 기준점의 이름과 값입니다. targetField watch-time의 경우 target_field_value는 [0, 86400] (0은 제외, 86400은 포함) 사이의 미디어 진행 시간을 초 단위로 나타내는 정수 값이어야 합니다(예: 90). targetField watch-percentage의 경우 target_field_value는 (0, 1.0] (0은 제외, 1.0은 포함) 사이의 유효한 부동 소수점 값이어야 합니다(예: 0.5).
trainingState

enum (TrainingState)

엔진의 학습 상태입니다 (예: TRAINING 또는 PAUSED).

서비스 실행 비용의 일부는 학습 빈도이므로 이를 사용하여 비용을 관리하기 위해 엔진을 학습할 시기를 결정할 수 있습니다. 지정되지 않은 경우: engines.create 메서드의 기본값은 TRAINING입니다. engines.patch 메서드의 기본값은 이전과 동일한 상태를 유지하는 것입니다.
engineFeaturesConfig

object (EngineFeaturesConfig)

(선택사항) 추가 엔진 기능 구성입니다.

OptimizationObjectiveConfig

cvr optimizationObjective의 맞춤 기준입니다.

JSON 표현 
{
  "targetField": string,
  "targetFieldValueFloat": number
}
필드
targetField

string

필수 항목입니다. 타겟팅할 필드의 이름입니다. 현재 지원되는 값은 watch-percentage, watch-time입니다.
targetFieldValueFloat

number

필수 항목입니다. 타겟에 적용할 기준점입니다 (예: 0.5).

TrainingState

엔진의 학습 상태입니다.

열거형
TRAINING_STATE_UNSPECIFIED 지정되지 않은 학습 상태입니다.
PAUSED 엔진 학습이 일시중지되었습니다.
TRAINING 엔진이 학습 중입니다.

EngineFeaturesConfig

선택한 엔진 유형의 추가 기능 구성입니다.

JSON 표현 
{

  // Union field type_dedicated_config can be only one of the following:
  "recommendedForYouConfig": {
    object (RecommendedForYouFeatureConfig)
  },
  "mostPopularConfig": {
    object (MostPopularFeatureConfig)
  }
  // End of list of possible types for union field type_dedicated_config.
}
필드
통합 필드 type_dedicated_config. 특정 유형의 미디어 추천 엔진에 적용되는 기능 관련 구성입니다. type_dedicated_config은 다음 중 하나여야 합니다.
recommendedForYouConfig

object (RecommendedForYouFeatureConfig)

엔진 기능 구성에 권장됩니다.

RecommendedForYouFeatureConfig

recommended-for-you 엔진을 만들기 위한 추가 기능 구성입니다.

JSON 표현 
{
  "contextEventType": string
}
필드
contextEventType

string

예측 시간에 엔진이 쿼리되는 이벤트 유형입니다. generic로 설정하면 엔진 학습에서 view-item, media-play, media-complete만 context-event로 사용됩니다. view-home-page로 설정된 경우 view-home-page는 view-item, media-play, media-complete 외에 context-events로도 사용됩니다. 현재 recommended-for-you 엔진에서 지원됩니다. 현재 지원되는 값은 view-home-page, generic입니다.

MostPopularFeatureConfig

최고 인기 엔진을 만드는 데 필요한 기능 구성입니다.

JSON 표현 
{
  "timeWindowDays": string
}
필드
timeWindowDays

string (int64 format)

학습 및 예측 시간에 엔진이 쿼리되는 시간 창입니다. 양의 정수만 허용됩니다. 이 값은 지난 X일 동안의 이벤트로 변환됩니다. 현재 most-popular-items 엔진에 필요합니다.

ChatEngineMetadata

Chat Engine의 추가 정보입니다. 이 메시지의 필드는 출력 전용입니다.

JSON 표현 
{
  "dialogflowAgent": string
}
필드
dialogflowAgent

string

이 Chat Engine이 참조하는 Dialogflow 에이전트의 리소스 이름입니다.

형식은 projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>입니다.

CommonConfig

엔진의 일반 구성

JSON 표현 
{
  "companyName": string
}
필드
companyName

string

엔진과 연결된 회사, 비즈니스 또는 법인의 이름입니다. 이 설정을 사용하면 LLM 관련 기능을 개선하는 데 도움이 될 수 있습니다.

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 청구 접근 방식은 고객이 지정한 구성을 따릅니다.

메서드

create

 Engine를 만듭니다.

delete

 Engine를 삭제합니다.

get

 Engine을 가져옵니다.

list

 프로젝트와 연결된 모든 Engine를 나열합니다.

patch

 Engine 업데이트