Class protos.google.cloud.dialogflow.cx.v3.GenerativeSettings (4.6.0)

Represents a GenerativeSettings.

Package

@google-cloud/dialogflow-cx

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dialogflow.cx.v3.IGenerativeSettings);

Constructs a new GenerativeSettings.

Parameter
Name Description
properties IGenerativeSettings

Properties to set

Properties

fallbackSettings

public fallbackSettings?: (google.cloud.dialogflow.cx.v3.GenerativeSettings.IFallbackSettings|null);

GenerativeSettings fallbackSettings.

generativeSafetySettings

public generativeSafetySettings?: (google.cloud.dialogflow.cx.v3.ISafetySettings|null);

GenerativeSettings generativeSafetySettings.

knowledgeConnectorSettings

public knowledgeConnectorSettings?: (google.cloud.dialogflow.cx.v3.GenerativeSettings.IKnowledgeConnectorSettings|null);

GenerativeSettings knowledgeConnectorSettings.

languageCode

public languageCode: string;

GenerativeSettings languageCode.

name

public name: string;

GenerativeSettings name.

Methods

create(properties)

public static create(properties?: google.cloud.dialogflow.cx.v3.IGenerativeSettings): google.cloud.dialogflow.cx.v3.GenerativeSettings;

Creates a new GenerativeSettings instance using the specified properties.

Parameter
Name Description
properties IGenerativeSettings

Properties to set

Returns
Type Description
GenerativeSettings

GenerativeSettings instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dialogflow.cx.v3.GenerativeSettings;

Decodes a GenerativeSettings 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
GenerativeSettings

GenerativeSettings

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dialogflow.cx.v3.GenerativeSettings;

Decodes a GenerativeSettings message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
GenerativeSettings

GenerativeSettings

encode(message, writer)

public static encode(message: google.cloud.dialogflow.cx.v3.IGenerativeSettings, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified GenerativeSettings message. Does not implicitly messages.

Parameters
Name Description
message IGenerativeSettings

GenerativeSettings 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.dialogflow.cx.v3.IGenerativeSettings, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified GenerativeSettings message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IGenerativeSettings

GenerativeSettings 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.dialogflow.cx.v3.GenerativeSettings;

Creates a GenerativeSettings 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
GenerativeSettings

GenerativeSettings

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for GenerativeSettings

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 GenerativeSettings to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.dialogflow.cx.v3.GenerativeSettings, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a GenerativeSettings message. Also converts values to other types if specified.

Parameters
Name Description
message GenerativeSettings

GenerativeSettings

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 a GenerativeSettings message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not