REST Resource: projects.locations.collections.engines.assistants

Resource: Assistant

Resource Asisten Discovery Engine.

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "generationConfig": {
    object (GenerationConfig)
  },
  "googleSearchGroundingEnabled": boolean,
  "webGroundingType": enum (WebGroundingType),
  "defaultWebGroundingToggleOff": boolean,
  "mapsGroundingType": enum (MapsGroundingType),
  "defaultMapsGroundingToggleOff": boolean,
  "vertexAiAgentConfigs": [
    {
      object (VertexAiAgentConfig)
    }
  ],
  "enabledActions": {
    string: {
      object (ActionList)
    },
    ...
  },
  "enabledTools": {
    string: {
      object (ToolList)
    },
    ...
  },
  "customerPolicy": {
    object (CustomerPolicy)
  },
  "vertexAiSearchToolConfig": {
    object (VertexAiSearchToolConfig)
  },
  "styleAndFormattingInstructions": string,
  "agentConfigs": [
    {
      object (AgentConfig)
    }
  ],
  "enableEndUserAgentCreation": boolean,
  "disableLocationContext": boolean,
  "createTime": string,
  "updateTime": string,
  "knowledgeCatalogEnabled": boolean
}
Kolom
name

string

Tidak dapat diubah. Nama resource asisten. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Harus berupa string berenkode UTF-8 dengan batas panjang 1.024 karakter.
displayName

string

Wajib. Nama tampilan asisten.

Harus berupa string berenkode UTF-8 dengan batas panjang 128 karakter.
description

string

Opsional. Deskripsi untuk informasi tambahan. Diharapkan ditampilkan di UI konfigurasi, bukan kepada pengguna asisten.
generationConfig

object (GenerationConfig)

Opsional. Konfigurasi untuk pembuatan respons asisten.
googleSearchGroundingEnabled
(deprecated)

boolean

Opsional. Tidak digunakan lagi: Gunakan webGroundingType sebagai gantinya.
webGroundingType

enum (WebGroundingType)

Opsional. Jenis perujukan web yang akan digunakan.
defaultWebGroundingToggleOff

boolean

Opsional. Kolom ini mengontrol tombol perujukan web default untuk pengguna akhir jika webGroundingType disetel ke WEB_GROUNDING_TYPE_GOOGLE_SEARCH atau WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. Secara default, kolom ini disetel ke false. Jika webGroundingType adalah WEB_GROUNDING_TYPE_GOOGLE_SEARCH atau WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH, pengguna akhir akan mengaktifkan perujukan web secara default di UI. Jika benar, tombol perujukan akan dinonaktifkan secara default di UI. Pengguna akhir tetap dapat mengaktifkan perujukan web di UI jika perujukan web diaktifkan.
mapsGroundingType

enum (MapsGroundingType)

Opsional. Jenis perujukan Google Maps yang akan digunakan.
defaultMapsGroundingToggleOff

boolean

Opsional. Kolom ini mengontrol tombol perujukan peta default untuk pengguna akhir jika mapsGroundingType disetel ke MAPS_GROUNDING_TYPE_GOOGLE_MAPS. Secara default, kolom ini disetel ke false. Jika mapsGroundingType adalah MAPS_GROUNDING_TYPE_GOOGLE_MAPS, pengguna akhir akan mengaktifkan perujukan peta secara default di UI. Jika benar (true), tombol perataan akan disetel ke posisi NONAKTIF secara default di UI. Pengguna akhir tetap dapat mengaktifkan perujukan peta di UI jika perujukan peta diaktifkan.
vertexAiAgentConfigs[]
(deprecated)

object (VertexAiAgentConfig)

Opsional. Tidak digunakan lagi: Akan digantikan oleh agen Dialogflow di AgentService. Daftar Agen Vertex AI yang dapat dijangkau melalui asisten.
enabledActions
(deprecated)

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

Opsional. Tidak digunakan lagi: akan diganti dengan enabledTools. Tindakan yang diaktifkan di asisten ini. Kuncinya adalah nama konektor, misalnya "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector. Nilainya terdiri dari tindakan yang diaktifkan admin terhadap instance konektor. Admin dapat mengaktifkan beberapa tindakan secara selektif pada instance konektor yang dibuatnya di project. Misalnya, {"jira1ConnectorName": [(actionId1, "createTicket"), (actionId2, "transferTicket")], "gmail1ConnectorName": [(actionId3, "sendEmail"),..] }
enabledTools

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

Opsional. Catatan: belum diterapkan. Sebagai gantinya, gunakan enabledActions. Alat yang diaktifkan di asisten ini. Kuncinya adalah nama konektor, misalnya "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector". Nilainya terdiri dari alat yang diaktifkan admin untuk instance konektor. Admin dapat mengaktifkan beberapa alat secara selektif di salah satu instance konektor yang dibuatnya dalam project. Misalnya, {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
customerPolicy

object (CustomerPolicy)

Opsional. Kebijakan pelanggan untuk asisten.
vertexAiSearchToolConfig

object (VertexAiSearchToolConfig)

Opsional. Opsi konfigurasi untuk alat Vertex AI Search.
styleAndFormattingInstructions
(deprecated)

string

Opsional. Tidak digunakan lagi: Sebagai gantinya, gunakan additionalSystemInstruction. Cuplikan petunjuk sistem umum untuk menyetel gaya, intonasi, dan pemformatan percakapan. Ditambahkan ke semua perintah LLM melalui placeholder [STYLE_AND_FORMATTING_INSTRUCTIONS].
agentConfigs[]
(deprecated)

object (AgentConfig)

Opsional. Tidak digunakan lagi: Harap gunakan AgentService sebagai gantinya. Daftar Agen yang dapat dihubungi melalui asisten.
enableEndUserAgentCreation

boolean

Opsional. Menunjukkan apakah pengguna akhir diizinkan membuat agen di Agentspace.
disableLocationContext

boolean

Opsional. Menunjukkan apakah akan menonaktifkan konteks lokasi pengguna. Secara default, konteks lokasi pengguna diaktifkan.
createTime

string (Timestamp format)

Hanya output. Menunjukkan waktu saat Asisten ini 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. Menunjukkan waktu saat Asisten ini 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".
knowledgeCatalogEnabled

boolean

Opsional. Menunjukkan apakah Knowledge Catalog diaktifkan untuk asisten tertentu ini. Jika diaktifkan, fitur ini akan mendukung konteks penemuan menggunakan data organisasi. Jika tidak ditentukan, nilai defaultnya adalah benar.

GenerationConfig

Konfigurasi untuk pembuatan respons asisten.

Representasi JSON 
{
  "defaultModelId": string,
  "allowedModelIds": [
    string
  ],
  "systemInstruction": {
    object (SystemInstruction)
  },
  "defaultLanguage": string
}
Kolom
defaultModelId

string

Opsional. Model default yang akan digunakan untuk asisten.
allowedModelIds[]

string

Opsional. Daftar model yang diizinkan untuk digunakan oleh asisten.
systemInstruction

object (SystemInstruction)

Instruksi sistem, juga dikenal sebagai preamble perintah untuk panggilan LLM. Lihat juga https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions
defaultLanguage

string

Bahasa default yang akan digunakan untuk pembuatan respons asisten. Gunakan kode bahasa ISO 639-1 seperti en. Jika tidak ditentukan, bahasa akan dideteksi secara otomatis.

SystemInstruction

Instruksi sistem, juga dikenal sebagai preamble perintah untuk panggilan LLM.

Representasi JSON 
{
  "additionalSystemInstruction": string
}
Kolom
additionalSystemInstruction

string

Opsional. Petunjuk sistem tambahan yang akan ditambahkan ke petunjuk sistem default.

WebGroundingType

Jenis perujukan web yang akan digunakan.

Enum
WEB_GROUNDING_TYPE_UNSPECIFIED Setelan default, tidak ditentukan. Ini sama dengan dinonaktifkan.
WEB_GROUNDING_TYPE_DISABLED Grounding web dinonaktifkan.

MapsGroundingType

Jenis perujukan Google Maps yang akan digunakan.

Enum
MAPS_GROUNDING_TYPE_UNSPECIFIED Setelan default, tidak ditentukan. Ini sama dengan dinonaktifkan.
MAPS_GROUNDING_TYPE_DISABLED Perujukan Maps dinonaktifkan.
MAPS_GROUNDING_TYPE_GOOGLE_MAPS Grounding dengan Google Maps diaktifkan.

VertexAiAgentConfig

Tidak digunakan lagi: Gunakan agen Dialogflow di AgentService. Merepresentasikan Agen Vertex AI eksternal yang dapat dijangkau melalui asisten.

Representasi JSON 
{
  "displayName": string,
  "name": string,
  "toolDescription": string
}
Kolom
displayName

string

Wajib. Nama tampilan Agen Vertex AI yang digunakan sebagai referensi di asisten.
name

string

Wajib. Nama resource Agen Vertex AI. Format: projects/{project}/locations/{location}/agents/{agent}
toolDescription

string

Wajib. Deskripsi alat Agen Vertex AI. Deskripsi ini akan digunakan oleh LLM untuk memutuskan apakah agen relevan dengan pertanyaan pengguna dan apakah pertanyaan tersebut harus diarahkan ke agen.

ActionList

Tidak digunakan lagi: Akan diganti dengan ToolList. Tindakan yang diaktifkan di konektor

Representasi JSON 
{
  "actionInfo": [
    {
      object (ActionInfo)
    }
  ]
}
Kolom
actionInfo[]

object (ActionInfo)

Daftar tindakan dengan informasi tindakan yang sesuai.

ActionInfo

Tidak digunakan lagi: Akan diganti dengan ToolInfo. Informasi untuk mengidentifikasi tindakan.

Representasi JSON 
{
  "actionName": string,
  "actionDisplayName": string
}
Kolom
actionName

string

Nama tindakan sebagaimana ditentukan oleh DataConnectorService.QueryAvailableActions.
actionDisplayName

string

Nama tampilan tindakan.

ToolList

Alat yang diaktifkan di konektor

Representasi JSON 
{
  "toolInfo": [
    {
      object (ToolInfo)
    }
  ]
}
Kolom
toolInfo[]

object (ToolInfo)

Daftar alat dengan informasi alat yang sesuai.

ToolInfo

Informasi untuk mengidentifikasi alat.

Representasi JSON 
{
  "toolName": string,
  "toolDisplayName": string
}
Kolom
toolName

string

Nama alat sebagaimana ditentukan oleh DataConnectorService.QueryAvailableActions. Catatan: menggunakan action di API DataConnectorService, tetapi sama dengan tool di sini.
toolDisplayName

string

Nama tampilan alat.

CustomerPolicy

Kebijakan yang ditentukan pelanggan untuk asisten.

Representasi JSON 
{
  "bannedPhrases": [
    {
      object (BannedPhrase)
    }
  ],
  "modelArmorConfig": {
    object (ModelArmorConfig)
  },
  "dataProtectionPolicy": {
    object (DataProtectionPolicy)
  }
}
Kolom
bannedPhrases[]

object (BannedPhrase)

Opsional. Daftar frasa yang dilarang.
modelArmorConfig

object (ModelArmorConfig)

Opsional. Konfigurasi Model Armor yang akan digunakan untuk membersihkan perintah pengguna dan respons asisten.
dataProtectionPolicy

object (DataProtectionPolicy)

Opsional. Kebijakan perlindungan data yang akan digunakan untuk membersihkan upload file.

BannedPhrase

Definisi frasa terlarang yang ditentukan pelanggan. Frasa yang dilarang tidak boleh muncul dalam kueri pengguna atau respons LLM, atau jawaban akan ditolak.

Representasi JSON 
{
  "phrase": string,
  "matchType": enum (BannedPhraseMatchType),
  "ignoreDiacritics": boolean
}
Kolom
phrase

string

Wajib. Konten string mentah yang akan dilarang.
matchType

enum (BannedPhraseMatchType)

Opsional. Jenis pencocokan untuk frasa yang dilarang.
ignoreDiacritics

boolean

Opsional. Jika benar (true), tanda diakritik (misalnya, aksen, umlaut) akan diabaikan saat mencocokkan frasa yang dilarang. Misalnya, "kafe" akan cocok dengan "café".

BannedPhraseMatchType

Metode pencocokan untuk frasa terlarang.

Enum
BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED Defaultnya adalah SIMPLE_STRING_MATCH.
SIMPLE_STRING_MATCH Frasa yang dilarang cocok jika ditemukan di mana pun dalam teks sebagai substring persis.
WORD_BOUNDARY_STRING_MATCH Frasa yang dilarang hanya cocok jika pola yang ditemukan dalam teks diapit oleh pembatas kata. Frasa itu sendiri mungkin masih berisi pembatas kata.

ModelArmorConfig

Konfigurasi untuk template Model Armor definisi kustom yang akan digunakan untuk membersihkan perintah pengguna dan respons asisten.

Representasi JSON 
{
  "userPromptTemplate": string,
  "responseTemplate": string,
  "failureMode": enum (FailureMode)
}
Kolom
userPromptTemplate

string

Opsional. Nama resource template Model Armor untuk membersihkan perintah pengguna. Format: projects/{project}/locations/{location}/templates/{templateId}

Jika tidak ditentukan, tidak ada pembersihan yang akan diterapkan pada perintah pengguna.
responseTemplate

string

Opsional. Nama resource template Model Armor untuk menyanitasi respons asisten. Format: projects/{project}/locations/{location}/templates/{templateId}

Jika tidak ditentukan, tidak ada pembersihan yang akan diterapkan pada respons asisten.
failureMode

enum (FailureMode)

Opsional. Menentukan mode kegagalan untuk sanitasi Model Armor.

FailureMode

Menentukan perilaku saat Model Armor gagal memproses permintaan.

Enum
FAILURE_MODE_UNSPECIFIED Mode kegagalan yang tidak ditentukan, perilaku default adalah FAIL_CLOSED.
FAIL_OPEN Jika terjadi kegagalan pemrosesan Model Armor, permintaan akan diizinkan untuk dilanjutkan tanpa perubahan apa pun.
FAIL_CLOSED Jika terjadi kegagalan pemrosesan Model Armor, permintaan akan ditolak.

VertexAiSearchToolConfig

Opsi konfigurasi untuk alat Vertex AI Search yang dapat digunakan asisten saat memproses kueri.

Representasi JSON 
{
  "llmSystemInstructions": string
}
Kolom
llmSystemInstructions
(deprecated)

string

Tidak digunakan lagi: Jangan gunakan kolom ini. Petunjuk sistem untuk menjawab berdasarkan hasil penelusuran Vertex AI Search. Perhatikan bahwa jawaban yang dihasilkan oleh alat penelusuran mungkin berbeda dengan jawaban akhir asisten.

Secara umum, petunjuk sistem adalah serangkaian petunjuk bahasa alami yang diproses oleh model sebelum memproses perintah. Hal ini memberi tahu model cara berperilaku dan merespons perintah. Lihat https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions

Contoh: "Gunakan informasi hanya dari sumber untuk menjawab. Selain itu, pastikan untuk memformat jawaban dengan baik menggunakan Markdown."

Jika tidak ditentukan, default internal akan digunakan.

AgentConfig

Tidak digunakan lagi: Harap gunakan AgentService sebagai gantinya. Opsi konfigurasi untuk agen yang dapat dipanggil asisten saat memproses kueri.

Representasi JSON 
{
  "id": string,
  "displayName": string,
  "toolDescription": string,
  "icon": {
    object (Image)
  },
  "authorizations": [
    string
  ],

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "vertexAiSdkAgentConnectionInfo": {
    object (VertexAiSdkAgentConnectionInfo)
  },
  "httpAgentConnectionInfo": {
    object (HttpAgentConnectionInfo)
  }
  // End of mutually exclusive fields.
}
Kolom
id

string

Wajib. ID unik yang dapat dibaca manusia untuk agen. Harus cocok dengan ekspresi reguler berikut: [a-z][a-zA-Z0-9_-]*.
displayName

string

Wajib. Nama tampilan agen yang digunakan untuk referensi di asisten.
toolDescription

string

Wajib. Deskripsi alat agen. Deskripsi ini akan digunakan oleh LLM untuk memutuskan apakah agen relevan dengan pertanyaan pengguna dan apakah pertanyaan tersebut harus diarahkan ke agen.
icon

object (Image)

Wajib. Ikon yang merepresentasikan agen di UI.
authorizations[]

string

Opsional. Nama resource otorisasi yang diperlukan. Jika pengguna tidak diberi otorisasi, layanan akan menampilkan sejumlah URI otorisasi yang harus dibuka dan diberi otorisasi oleh pengguna di browser. Setelah semua otorisasi diberikan, pengguna dapat mencoba lagi kueri, dan otorisasi akan diteruskan ke agen.

Format: projects/{project}/locations/{location}/authorizations/{authorization}
Konfigurasi koneksi agen. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
vertexAiSdkAgentConnectionInfo

object (VertexAiSdkAgentConnectionInfo)

Wajib. Informasi koneksi untuk agen Vertex AI SDK
httpAgentConnectionInfo

object (HttpAgentConnectionInfo)

Wajib. Info koneksi untuk agen HTTP.
Akhir kolom yang saling eksklusif.

VertexAiSdkAgentConnectionInfo

Informasi koneksi untuk agen Vertex AI SDK - saat ini hanya agen yang diekspos melalui Mesin Penalaran yang didukung.

Representasi JSON 
{
  "reasoningEngine": string
}
Kolom
reasoningEngine

string

Nama resource mesin penalaran yang mengekspos agen. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoningEngine}

HttpAgentConnectionInfo

Agen yang dapat dijangkau oleh asisten melalui HTTP.

Representasi JSON 
{
  "httpUri": string
}
Kolom
httpUri

string

Wajib. Alamat HTTP agen, misalnya "https://example.com/agent1".

Gambar

Mewakili gambar.

Representasi JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "uri": string,
  "content": string
  // End of mutually exclusive fields.
}
Kolom
Dapat berupa URI atau konten yang dienkode sebagai string base64. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
uri

string

Wajib. URI gambar.
content

string

Wajib. Isi file gambar berenkode base64.
Akhir kolom yang saling eksklusif.

Metode

assist

 Membantu pengguna dengan kueri.

create

 Membuat Assistant.

createCachedContent

 Membuat cache konteks eksplisit (Vertex CachedContent); name-nya diteruskan sebagai cachedContent pada permintaan GenerateContent berikutnya.

delete

 Menghapus Assistant.

deleteCachedContent

 Menghapus cache konteks yang dibuat oleh CreateCachedContent (melepaskan penyimpanan sebelum TTL).

generateContent

 Membuat konten dari model atas nama klien Gemini Enterprise pihak pertama (unary).

get

 Mendapatkan Assistant.

list

 Mencantumkan semua Assistant dalam Engine.

patch

 Memperbarui Assistant

predict

 Menayangkan prediksi unary dari model atas nama klien Gemini Enterprise pihak pertama.

streamAssist

 Membantu pengguna dengan kueri secara streaming.

streamGenerateContent

 Varian streaming server dari GenerateContent.

streamRawPredict

 Prediksi mentah streaming server, untuk model yang menggunakan protokol permintaan/respons mentah, bukan bentuk generateContent.