Represents an Assistant.
Implements
Package
@google-cloud/discoveryengineConstructors
(constructor)(properties)
constructor(properties?: google.cloud.discoveryengine.v1.IAssistant);Constructs a new Assistant.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAssistant
Properties to set |
Properties
createTime
public createTime?: (google.protobuf.ITimestamp|null);Assistant createTime.
customerPolicy
public customerPolicy?: (google.cloud.discoveryengine.v1.Assistant.ICustomerPolicy|null);Assistant customerPolicy.
defaultWebGroundingToggleOff
public defaultWebGroundingToggleOff: boolean;Assistant defaultWebGroundingToggleOff.
description
public description: string;Assistant description.
displayName
public displayName: string;Assistant displayName.
enabledTools
public enabledTools: { [k: string]: google.cloud.discoveryengine.v1.Assistant.IToolList };Assistant enabledTools.
generationConfig
public generationConfig?: (google.cloud.discoveryengine.v1.Assistant.IGenerationConfig|null);Assistant generationConfig.
name
public name: string;Assistant name.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);Assistant updateTime.
webGroundingType
public webGroundingType: (google.cloud.discoveryengine.v1.Assistant.WebGroundingType|keyof typeof google.cloud.discoveryengine.v1.Assistant.WebGroundingType);Assistant webGroundingType.
Methods
create(properties)
public static create(properties?: google.cloud.discoveryengine.v1.IAssistant): google.cloud.discoveryengine.v1.Assistant;Creates a new Assistant instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAssistant
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Assistant |
Assistant instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1.Assistant;Decodes an Assistant message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Assistant |
Assistant |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1.Assistant;Decodes an Assistant message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Assistant |
Assistant |
encode(message, writer)
public static encode(message: google.cloud.discoveryengine.v1.IAssistant, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Assistant message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IAssistant
Assistant message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.discoveryengine.v1.IAssistant, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Assistant message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IAssistant
Assistant message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.discoveryengine.v1.Assistant;Creates an Assistant message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
Assistant |
Assistant |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Assistant
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Assistant to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.discoveryengine.v1.Assistant, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an Assistant message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Assistant
Assistant |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies an Assistant message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|