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),
  "enabledActions": {
    string: {
      object (ActionList)
    },
    ...
  },
  "enabledTools": {
    string: {
      object (ToolList)
    },
    ...
  },
  "customerPolicy": {
    object (CustomerPolicy)
  }
}
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.
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.

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.

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.

Metode

assist

 Membantu pengguna dengan kueri.

create

 Membuat Assistant.

delete

 Menghapus Assistant.

get

 Mendapatkan Assistant.

list

 Mencantumkan semua Assistant dalam Engine.

patch

 Memperbarui Assistant

streamAssist

 Membantu pengguna dengan kueri secara streaming.