Google Cloud Ces V1 Client - Class FileSearchTool (0.1.0)

Reference documentation and code samples for the Google Cloud Ces V1 Client class FileSearchTool.

The file search tool allows the agent to search across the files uploaded by the app/agent developer. It has presets to give relatively good quality search over the uploaded files and summarization of the retrieved results.

Generated from protobuf message google.cloud.ces.v1.FileSearchTool

Namespace

Google \ Cloud \ Ces \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ corpus_type`	`int` Optional. The type of the corpus. Default is FULLY_MANAGED.
`↳ name`	`string` Required. The tool name.
`↳ description`	`string` Optional. The tool description.
`↳ file_corpus`	`string` Optional. The corpus where files are stored. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

getCorpusType

Optional. The type of the corpus. Default is FULLY_MANAGED.

Returns
Type	Description
`int`	Enum of type CorpusType.

setCorpusType

Optional. The type of the corpus. Default is FULLY_MANAGED.

Parameter
Name	Description
`var`	`int` Enum of type CorpusType.

Returns
Type	Description
`$this`

getName

Required. The tool name.

Returns
Type	Description
`string`

setName

Required. The tool name.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

Optional. The tool description.

Returns
Type	Description
`string`

setDescription