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,
  "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
}
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. Sebagai gantinya, gunakan webGroundingType.
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.
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 salah satu 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 mereka buat 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 [addtional_system_instructions][GenerationConfig.SystemInstruction.additional_system_instructions]. Cuplikan petunjuk sistem umum untuk menyetel gaya, intonasi, dan pemformatan percakapan. Ditambahkan ke semua perintah LLM melalui placeholder [STYLE_AND_FORMATTING_INSTRUCTIONS].
agentConfigs[]

object (AgentConfig)

Opsional. Daftar Agen yang dapat dihubungi melalui asisten.
enableEndUserAgentCreation

boolean

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

boolean

Opsional. Menunjukkan apakah konteks lokasi pengguna harus dinonaktifkan. Secara default, konteks lokasi pengguna diaktifkan.

GenerationConfig

Konfigurasi untuk pembuatan respons asisten.

Representasi JSON 
{
  "systemInstruction": {
    object (SystemInstruction)
  },
  "defaultLanguage": string
}
Kolom
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 otomatis terdeteksi.

SystemInstruction

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

Representasi JSON 
{
  "additionalSystemInstruction": string
}
Kolom
additionalSystemInstruction

string

Opsional. Instruksi sistem tambahan yang akan ditambahkan ke instruksi 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.

VertexAiAgentConfig

Tidak digunakan lagi: Gunakan agen Dialogflow di AgentService. Mewakili 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 pada 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 seperti yang 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)
  }
}
Kolom
bannedPhrases[]

object (BannedPhrase)

Opsional. Daftar frasa yang dilarang.
modelArmorConfig

object (ModelArmorConfig)

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

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, "cafe" akan cocok dengan "café".

BannedPhraseMatchType

Metode pencocokan untuk frasa terlarang.

Enum
BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED Default-nya adalah SIMPLE_STRING_MATCH.
SIMPLE_STRING_MATCH Frasa yang dilarang cocok jika ditemukan di mana saja dalam teks sebagai sub-string persis.
WORD_BOUNDARY_STRING_MATCH Frasa terlarang 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 yang ditentukan pelanggan 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 menyaring 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 pembersihan Model Armor.

FailureMode

Menentukan perilaku saat Model Armor gagal memproses permintaan.

Enum
FAILURE_MODE_UNSPECIFIED Mode kegagalan tidak ditentukan, perilaku default adalah FAIL_CLOSED.
FAIL_OPEN Jika terjadi kegagalan pemrosesan Model Armor, permintaan diizinkan untuk dilanjutkan tanpa perubahan apa pun.
FAIL_CLOSED Jika pemrosesan Model Armor gagal, 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. Petunjuk 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

Opsi konfigurasi untuk agen yang dapat dipanggil asisten saat memproses kueri.

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

  // Union field connection_info can be only one of the following:
  "vertexAiSdkAgentConnectionInfo": {
    object (VertexAiSdkAgentConnectionInfo)
  },
  "httpAgentConnectionInfo": {
    object (HttpAgentConnectionInfo)
  }
  // End of list of possible types for union field connection_info.
}
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 sebagai 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 kembali kueri, dan otorisasi akan diteruskan ke agen.

Format: projects/{project}/locations/{location}/authorizations/{authorization}
Kolom union connection_info. Konfigurasi koneksi agen. connection_info hanya ada berupa salah satu diantara berikut:
vertexAiSdkAgentConnectionInfo

object (VertexAiSdkAgentConnectionInfo)

Wajib. Informasi koneksi untuk agen Vertex AI SDK
httpAgentConnectionInfo

object (HttpAgentConnectionInfo)

Wajib. Info koneksi untuk agen HTTP.

VertexAiSdkAgentConnectionInfo

Informasi koneksi untuk agen Vertex AI SDK - saat ini hanya agen yang diekspos melalui Reasoning Engine 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 
{

  // Union field storage_method can be only one of the following:
  "uri": string,
  "content": string
  // End of list of possible types for union field storage_method.
}
Kolom
Kolom union storage_method. Dapat berupa URI atau konten yang dienkode sebagai string base64. storage_method hanya ada berupa salah satu diantara berikut:
uri

string

Wajib. URI gambar.
content

string

Wajib. Isi file gambar berenkode base64.

Metode

assist

 Membantu pengguna dengan kueri.

create

 Membuat Assistant.

delete

 Menghapus Assistant.

get

 Mendapatkan Assistant.

list

 Mencantumkan semua Assistant dalam Engine.

listAvailableAgentViews

 Mencantumkan data untuk menampilkan Agen di bawah Assistant yang tersedia untuk pemanggil.

patch

 Memperbarui Assistant

streamAssist

 Membantu pengguna dengan kueri secara streaming.