Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ToolsSpec.
Specification of tools that are used to serve the request.
Generated from protobuf message google.cloud.discoveryengine.v1.StreamAssistRequest.ToolsSpec
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ StreamAssistRequestMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ vertex_ai_search_spec |
ToolsSpec\VertexAiSearchSpec
Optional. Specification of the Vertex AI Search tool. |
↳ web_grounding_spec |
ToolsSpec\WebGroundingSpec
Optional. Specification of the web grounding tool. If field is present, enables grounding with web search. Works only if Assistant.web_grounding_type is WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. |
↳ image_generation_spec |
ToolsSpec\ImageGenerationSpec
Optional. Specification of the image generation tool. |
↳ video_generation_spec |
ToolsSpec\VideoGenerationSpec
Optional. Specification of the video generation tool. |
getVertexAiSearchSpec
Optional. Specification of the Vertex AI Search tool.
| Returns | |
|---|---|
| Type | Description |
ToolsSpec\VertexAiSearchSpec|null |
|
hasVertexAiSearchSpec
clearVertexAiSearchSpec
setVertexAiSearchSpec
Optional. Specification of the Vertex AI Search tool.
| Parameter | |
|---|---|
| Name | Description |
var |
ToolsSpec\VertexAiSearchSpec
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWebGroundingSpec
Optional. Specification of the web grounding tool.
If field is present, enables grounding with web search. Works only if Assistant.web_grounding_type is WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH.
| Returns | |
|---|---|
| Type | Description |
ToolsSpec\WebGroundingSpec|null |
|
hasWebGroundingSpec
clearWebGroundingSpec
setWebGroundingSpec
Optional. Specification of the web grounding tool.
If field is present, enables grounding with web search. Works only if Assistant.web_grounding_type is WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH.
| Parameter | |
|---|---|
| Name | Description |
var |
ToolsSpec\WebGroundingSpec
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getImageGenerationSpec
Optional. Specification of the image generation tool.
| Returns | |
|---|---|
| Type | Description |
ToolsSpec\ImageGenerationSpec|null |
|
hasImageGenerationSpec
clearImageGenerationSpec
setImageGenerationSpec
Optional. Specification of the image generation tool.
| Parameter | |
|---|---|
| Name | Description |
var |
ToolsSpec\ImageGenerationSpec
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVideoGenerationSpec
Optional. Specification of the video generation tool.
| Returns | |
|---|---|
| Type | Description |
ToolsSpec\VideoGenerationSpec|null |
|
hasVideoGenerationSpec
clearVideoGenerationSpec
setVideoGenerationSpec
Optional. Specification of the video generation tool.
| Parameter | |
|---|---|
| Name | Description |
var |
ToolsSpec\VideoGenerationSpec
|
| Returns | |
|---|---|
| Type | Description |
$this |
|