Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ReasoningEngineSpec.
ReasoningEngine configurations
Generated from protobuf message google.cloud.aiplatform.v1.ReasoningEngineSpec
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ source_code_spec |
ReasoningEngineSpec\SourceCodeSpec
Deploy from source code files with a defined entrypoint. |
↳ service_account |
string
Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. |
↳ package_spec |
ReasoningEngineSpec\PackageSpec
Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through |
↳ deployment_spec |
ReasoningEngineSpec\DeploymentSpec
Optional. The specification of a Reasoning Engine deployment. |
↳ class_methods |
array<Google\Protobuf\Struct>
Optional. Declarations for object class methods in OpenAPI specification format. |
↳ agent_framework |
string
Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". |
getSourceCodeSpec
Deploy from source code files with a defined entrypoint.
| Returns | |
|---|---|
| Type | Description |
ReasoningEngineSpec\SourceCodeSpec|null |
|
hasSourceCodeSpec
setSourceCodeSpec
Deploy from source code files with a defined entrypoint.
| Parameter | |
|---|---|
| Name | Description |
var |
ReasoningEngineSpec\SourceCodeSpec
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getServiceAccount
Optional. The service account that the Reasoning Engine artifact runs as.
It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasServiceAccount
clearServiceAccount
setServiceAccount
Optional. The service account that the Reasoning Engine artifact runs as.
It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPackageSpec
Optional. User provided package spec of the ReasoningEngine.
Ignored when users directly specify a deployment image through
deployment_spec.first_party_image_override, but keeping the
field_behavior to avoid introducing breaking changes.
The deployment_source field should not be set if package_spec is
specified.
| Returns | |
|---|---|
| Type | Description |
ReasoningEngineSpec\PackageSpec|null |
|
hasPackageSpec
clearPackageSpec
setPackageSpec
Optional. User provided package spec of the ReasoningEngine.
Ignored when users directly specify a deployment image through
deployment_spec.first_party_image_override, but keeping the
field_behavior to avoid introducing breaking changes.
The deployment_source field should not be set if package_spec is
specified.
| Parameter | |
|---|---|
| Name | Description |
var |
ReasoningEngineSpec\PackageSpec
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeploymentSpec
Optional. The specification of a Reasoning Engine deployment.
| Returns | |
|---|---|
| Type | Description |
ReasoningEngineSpec\DeploymentSpec|null |
|
hasDeploymentSpec
clearDeploymentSpec
setDeploymentSpec
Optional. The specification of a Reasoning Engine deployment.
| Parameter | |
|---|---|
| Name | Description |
var |
ReasoningEngineSpec\DeploymentSpec
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getClassMethods
Optional. Declarations for object class methods in OpenAPI specification format.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<Google\Protobuf\Struct> |
|
setClassMethods
Optional. Declarations for object class methods in OpenAPI specification format.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Protobuf\Struct>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAgentFramework
Optional. The OSS agent framework used to develop the agent.
Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom".
| Returns | |
|---|---|
| Type | Description |
string |
|
setAgentFramework
Optional. The OSS agent framework used to develop the agent.
Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeploymentSource
| Returns | |
|---|---|
| Type | Description |
string |
|