REST Resource: projects.locations.collections.engines

Resource: Engine

Metadata yang menjelaskan parameter pelatihan dan penayangan Engine.

Representasi 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.
}
Kolom
name

string

Tidak dapat diubah. ID. Nama resource mesin yang sepenuhnya memenuhi syarat.

Kolom ini harus berupa string berenkode UTF-8 dengan batas panjang 1.024 karakter.

Format: Mesin projects/{project}/locations/{location}/collections/{collection}/engines/{engine} harus terdiri dari 1-63 karakter, dan karakter yang valid adalah /[a-z0-9][a-z0-9-_]*/. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.
displayName

string

Wajib. Nama tampilan mesin. Harus dapat dibaca manusia. String berenkode UTF-8 dengan batas 1024 karakter.
createTime

string (Timestamp format)

Hanya output. Stempel waktu saat Recommendation Engine dibuat.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Hanya output. Stempel waktu saat Recommendation Engine terakhir diperbarui.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
dataStoreIds[]

string

Opsional. Penyimpanan data yang terkait dengan mesin ini.

Untuk jenis mesin SOLUTION_TYPE_SEARCH dan SOLUTION_TYPE_RECOMMENDATION, mesin hanya dapat dikaitkan dengan maksimal satu penyimpanan data.

Jika solutionType adalah SOLUTION_TYPE_CHAT, beberapa DataStore dalam Collection yang sama dapat dikaitkan di sini.

Perhatikan bahwa saat digunakan di CreateEngineRequest, satu ID DataStore harus diberikan karena sistem akan menggunakannya untuk inisialisasi yang diperlukan.
solutionType

enum (SolutionType)

Wajib. Solusi mesin.
industryVertical

enum (IndustryVertical)

Opsional. Vertical industri yang didaftarkan mesin. Pembatasan vertical industri Engine didasarkan pada DataStore: Vertical di Engine harus cocok dengan vertical DataStore yang ditautkan ke engine.
commonConfig

object (CommonConfig)

Spesifikasi konfigurasi umum yang menentukan metadata mesin.
appType

enum (AppType)

Opsional. Tidak dapat diubah. Jenis aplikasi yang diwakili oleh resource mesin ini. CATATAN: ini adalah konsep baru yang terlepas dari jenis solusi atau vertikal industri yang ada.
disableAnalytics

boolean

Opsional. Apakah akan menonaktifkan analisis untuk penelusuran yang dilakukan di mesin telusur ini.
features

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

Opsional. Konfigurasi fitur untuk mesin agar dapat mengaktifkan atau menonaktifkan fitur. Kunci yang didukung:

  • *: semua fitur, jika ada, semua setelan status fitur lainnya akan diabaikan.
  • 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)

Opsional. Konfigurasi untuk pendekatan penagihan yang dapat dikonfigurasi.
Kolom union engine_config. Spesifikasi konfigurasi tambahan yang menentukan perilaku mesin. engine_config hanya ada berupa salah satu diantara berikut:
chatEngineConfig

object (ChatEngineConfig)

Konfigurasi untuk Chat Engine. Hanya berlaku jika solutionType adalah SOLUTION_TYPE_CHAT.
searchEngineConfig

object (SearchEngineConfig)

Konfigurasi untuk Mesin Telusur. Hanya berlaku jika solutionType adalah SOLUTION_TYPE_SEARCH.
mediaRecommendationEngineConfig

object (MediaRecommendationEngineConfig)

Konfigurasi untuk Media Engine. Hanya berlaku di penyimpanan data dengan vertikal solutionType SOLUTION_TYPE_RECOMMENDATION dan IndustryVertical.MEDIA.
Kolom union engine_metadata. Metadata mesin untuk memantau status mesin. engine_metadata hanya ada berupa salah satu diantara berikut:
chatEngineMetadata

object (ChatEngineMetadata)

Hanya output. Informasi tambahan tentang Chat Engine. Hanya berlaku jika solutionType adalah SOLUTION_TYPE_CHAT.

ChatEngineConfig

Konfigurasi untuk Chat Engine.

Representasi JSON 
{
  "agentCreationConfig": {
    object (AgentCreationConfig)
  },
  "dialogflowAgentToLink": string,
  "allowCrossRegion": boolean
}
Kolom
agentCreationConfig

object (AgentCreationConfig)

Konfigurasi ini akan menghasilkan agen Dialogflow yang terkait dengan Engine ini.

Perhatikan bahwa konfigurasi ini hanya digunakan satu kali oleh dan diteruskan ke layanan Dialogflow. Artinya, item tersebut tidak dapat diambil menggunakan API EngineService.GetEngine atau EngineService.ListEngines setelah pembuatan mesin.
allowCrossRegion

boolean

Opsional. Jika tanda ditetapkan ke benar (true), kami mengizinkan agen dan mesin berada di lokasi yang berbeda. Jika tidak, agen dan mesin harus berada di lokasi yang sama. Flag ini ditetapkan ke false secara default.

Perhatikan bahwa allowCrossRegion digunakan satu kali oleh dan diteruskan ke EngineService.CreateEngine. Artinya, item tersebut tidak dapat diambil menggunakan API EngineService.GetEngine atau EngineService.ListEngines setelah pembuatan mesin.

AgentCreationConfig

Konfigurasi untuk membuat agen Dialogflow.

Perhatikan bahwa konfigurasi ini hanya digunakan satu kali oleh dan diteruskan ke layanan Dialogflow. Artinya, item tersebut tidak dapat diambil menggunakan API EngineService.GetEngine atau EngineService.ListEngines setelah pembuatan mesin.

Representasi JSON 
{
  "business": string,
  "defaultLanguageCode": string,
  "timeZone": string,
  "location": string
}
Kolom
business

string

Nama perusahaan, organisasi, atau entitas lain yang diwakili agen. Digunakan untuk perintah LLM konektor pengetahuan dan untuk penelusuran pengetahuan.
defaultLanguageCode

string

Wajib. Bahasa default agen sebagai tag bahasa. Lihat Dukungan Bahasa untuk mengetahui daftar kode bahasa yang saat ini didukung.
timeZone

string

Wajib. Zona waktu agen dari database zona waktu, misalnya, America/New_York, Europe/Paris.
location

string

Lokasi agen untuk pembuatan Agen, nilai yang didukung: global/us/eu. Jika tidak diberikan, Engine AS akan membuat Agen menggunakan us-central-1 secara default; Engine Uni Eropa akan membuat Agen menggunakan eu-west-1 secara default.

SearchEngineConfig

Konfigurasi untuk Mesin Telusur.

Representasi JSON 
{
  "searchTier": enum (SearchTier),
  "searchAddOns": [
    enum (SearchAddOn)
  ]
}
Kolom
searchTier

enum (SearchTier)

Tingkat fitur penelusuran mesin telusur ini.

Tingkatan yang berbeda mungkin memiliki harga yang berbeda. Untuk mempelajari lebih lanjut, lihat dokumentasi harga.

Jika tidak ditentukan, nilai defaultnya adalah SearchTier.SEARCH_TIER_STANDARD.
searchAddOns[]

enum (SearchAddOn)

Add-on yang diaktifkan oleh mesin telusur ini.

SearchTier

Tingkatan fitur penelusuran. Tingkatan yang berbeda mungkin memiliki harga yang berbeda. Untuk mempelajari lebih lanjut, lihat dokumentasi harga.

Enum
SEARCH_TIER_UNSPECIFIED Nilai default saat enum tidak ditentukan. Tidak valid untuk digunakan.
SEARCH_TIER_STANDARD Tingkat standar.
SEARCH_TIER_ENTERPRISE Paket Enterprise.

SearchAddOn

Add-on yang menyediakan fungsi tambahan untuk penelusuran.

Enum
SEARCH_ADD_ON_UNSPECIFIED Nilai default saat enum tidak ditentukan. Tidak valid untuk digunakan.
SEARCH_ADD_ON_LLM Add-on model bahasa besar.

MediaRecommendationEngineConfig

Spesifikasi konfigurasi tambahan untuk mesin Rekomendasi Media.

Representasi JSON 
{
  "type": string,
  "optimizationObjective": string,
  "optimizationObjectiveConfig": {
    object (OptimizationObjectiveConfig)
  },
  "trainingState": enum (TrainingState),
  "engineFeaturesConfig": {
    object (EngineFeaturesConfig)
  }
}
Kolom
type

string

Wajib. Jenis mesin. misalnya, recommended-for-you.

Kolom ini bersama dengan optimizationObjective menjelaskan metadata mesin yang akan digunakan untuk mengontrol pelatihan dan penayangan mesin.

Nilai yang didukung saat ini: recommended-for-you, others-you-may-like, more-like-this, most-popular-items.
optimizationObjective

string

Tujuan pengoptimalan. Misalnya, cvr.

Kolom ini bersama dengan optimizationObjective menjelaskan metadata mesin yang akan digunakan untuk mengontrol pelatihan dan penayangan mesin.

Nilai yang didukung saat ini: ctr, cvr.

Jika tidak ditentukan, kami akan memilih default berdasarkan jenis mesin. Default bergantung pada jenis rekomendasi:

recommended-for-you => ctr

others-you-may-like => ctr
optimizationObjectiveConfig

object (OptimizationObjectiveConfig)

Nama dan nilai nilai minimum kustom untuk Tujuan pengoptimalan cvr. Untuk targetField watch-time, target_field_value harus berupa nilai bilangan bulat yang menunjukkan waktu progres media dalam detik antara (0, 86400] (tidak termasuk 0, termasuk 86400) (misalnya, 90). Untuk targetField watch-percentage, target_field_value harus berupa nilai float yang valid antara (0, 1.0] (tidak termasuk 0, termasuk 1.0) (misalnya, 0,5).
trainingState

enum (TrainingState)

Status pelatihan yang sedang dijalankan mesin (misalnya, TRAINING atau PAUSED).

Karena sebagian biaya untuk menjalankan layanan adalah frekuensi pelatihan, hal ini dapat digunakan untuk menentukan kapan harus melatih mesin guna mengontrol biaya. Jika tidak ditentukan: nilai default untuk metode engines.create adalah TRAINING. Nilai default untuk metode engines.patch adalah mempertahankan status yang sama seperti sebelumnya.
engineFeaturesConfig

object (EngineFeaturesConfig)

Opsional. Konfigurasi fitur mesin tambahan.

OptimizationObjectiveConfig

Batas kustom untuk optimizationObjective cvr.

Representasi JSON 
{
  "targetField": string,
  "targetFieldValueFloat": number
}
Kolom
targetField

string

Wajib. Nama kolom yang akan ditargetkan. Nilai yang didukung saat ini: watch-percentage, watch-time.
targetFieldValueFloat

number

Wajib. Nilai minimum yang akan diterapkan ke target (misalnya, 0,5).

TrainingState

Status pelatihan mesin.

Enum
TRAINING_STATE_UNSPECIFIED Status pelatihan tidak ditentukan.
PAUSED Pelatihan mesin dijeda.
TRAINING Mesin sedang dilatih.

EngineFeaturesConfig

Konfigurasi fitur lainnya dari jenis mesin yang dipilih.

Representasi 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.
}
Kolom
Kolom union type_dedicated_config. Konfigurasi terkait fitur yang diterapkan ke jenis mesin rekomendasi media tertentu. type_dedicated_config hanya ada berupa salah satu diantara berikut:
recommendedForYouConfig

object (RecommendedForYouFeatureConfig)

Konfigurasi fitur mesin rekomendasi untuk Anda.

RecommendedForYouFeatureConfig

Konfigurasi fitur tambahan untuk membuat mesin recommended-for-you.

Representasi JSON 
{
  "contextEventType": string
}
Kolom
contextEventType

string

Jenis peristiwa yang digunakan untuk membuat kueri mesin pada waktu prediksi. Jika disetel ke generic, hanya view-item, media-play,dan media-complete yang akan digunakan sebagai context-event dalam pelatihan mesin. Jika ditetapkan ke view-home-page, view-home-page juga akan digunakan sebagai context-events selain view-item, media-play, dan media-complete. Saat ini didukung untuk mesin recommended-for-you. Nilai yang didukung saat ini: view-home-page, generic.

MostPopularFeatureConfig

Konfigurasi fitur yang diperlukan untuk membuat mesin Paling Populer.

Representasi JSON 
{
  "timeWindowDays": string
}
Kolom
timeWindowDays

string (int64 format)

Rentang waktu saat mesin dikueri pada waktu pelatihan dan prediksi. Hanya bilangan bulat positif. Nilai ini diterjemahkan ke peristiwa X hari terakhir. Saat ini diperlukan untuk mesin most-popular-items.

ChatEngineMetadata

Informasi tambahan tentang Chat Engine. Kolom dalam pesan ini hanya berupa output.

Representasi JSON 
{
  "dialogflowAgent": string
}
Kolom
dialogflowAgent

string

Nama resource agen Dialogflow yang dirujuk oleh Chat Engine ini.

Format projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

CommonConfig

Konfigurasi umum untuk Engine.

Representasi JSON 
{
  "companyName": string
}
Kolom
companyName

string

Nama perusahaan, bisnis, atau entitas yang terkait dengan mesin telusur. Menyetel ini dapat membantu meningkatkan kualitas fitur terkait LLM.

AppType

Aplikasi mesin.

Enum
APP_TYPE_UNSPECIFIED Semua aplikasi yang tidak ditentukan.
APP_TYPE_INTRANET Jenis aplikasi untuk penelusuran intranet dan Agentspace.

FeatureState

Status fitur untuk mesin telusur.

Enum
FEATURE_STATE_UNSPECIFIED Status fitur tidak ditentukan.
FEATURE_STATE_ON Fitur diaktifkan agar dapat diakses.
FEATURE_STATE_OFF Fitur ini dinonaktifkan agar tidak dapat diakses.

ConfigurableBillingApproach

Konfigurasi untuk pendekatan penagihan yang dapat dikonfigurasi.

Enum
CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED Nilai default. Untuk pendekatan penagihan yang tidak dapat dikonfigurasi Spark dan non-Spark. Model harga umum.
CONFIGURABLE_BILLING_APPROACH_ENABLED Pendekatan penagihan mengikuti konfigurasi yang ditentukan oleh pelanggan.

Metode

create

 Membuat Engine.

delete

 Menghapus Engine.

get

 Mendapatkan Engine.

list

 Mencantumkan semua Engine yang terkait dengan project.

patch

 Memperbarui Engine