reasoning_engines

Creates, updates, deletes, gets or lists a reasoning_engines resource.

Overview

Name	reasoning_engines
Type	Resource
Id	google.aiplatform.reasoning_engines

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The resource name of the ReasoningEngine. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}
contextSpec	object	Optional. Configuration for how Agent Engine sub-resources should manage context. (id: GoogleCloudAiplatformV1ReasoningEngineContextSpec)
createTime	string (google-datetime)	Output only. Timestamp when this ReasoningEngine was created.
description	string	Optional. The description of the ReasoningEngine.
displayName	string	Required. The display name of the ReasoningEngine.
encryptionSpec	object	Customer-managed encryption key spec for a ReasoningEngine. If set, this ReasoningEngine and all sub-resources of this ReasoningEngine will be secured by this key. (id: GoogleCloudAiplatformV1EncryptionSpec)
etag	string	Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels	object	Labels for the ReasoningEngine.
spec	object	Optional. Configurations of the ReasoningEngine (id: GoogleCloudAiplatformV1ReasoningEngineSpec)
updateTime	string (google-datetime)	Output only. Timestamp when this ReasoningEngine was most recently updated.

list

Name	Datatype	Description
name	string	Identifier. The resource name of the ReasoningEngine. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}
contextSpec	object	Optional. Configuration for how Agent Engine sub-resources should manage context. (id: GoogleCloudAiplatformV1ReasoningEngineContextSpec)
createTime	string (google-datetime)	Output only. Timestamp when this ReasoningEngine was created.
description	string	Optional. The description of the ReasoningEngine.
displayName	string	Required. The display name of the ReasoningEngine.
encryptionSpec	object	Customer-managed encryption key spec for a ReasoningEngine. If set, this ReasoningEngine and all sub-resources of this ReasoningEngine will be secured by this key. (id: GoogleCloudAiplatformV1EncryptionSpec)
etag	string	Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels	object	Labels for the ReasoningEngine.
spec	object	Optional. Configurations of the ReasoningEngine (id: GoogleCloudAiplatformV1ReasoningEngineSpec)
updateTime	string (google-datetime)	Output only. Timestamp when this ReasoningEngine was most recently updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	reasoningEnginesId		Gets a reasoning engine.
list	select		pageToken, pageSize, filter, parent	Lists reasoning engines in a location.
create	insert		parent	Creates a reasoning engine.
patch	update	reasoningEnginesId	updateMask	Updates a reasoning engine.
delete	delete	reasoningEnginesId	force	Deletes a reasoning engine.
query	exec	reasoningEnginesId		Queries using a reasoning engine.
stream_query	exec	reasoningEnginesId		Streams queries using a reasoning engine.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
reasoningEnginesId	string
filter	string
force	boolean
pageSize	integer (int32)
pageToken	string
parent	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets a reasoning engine.

SELECT
name,
contextSpec,
createTime,
description,
displayName,
encryptionSpec,
etag,
labels,
spec,
updateTime
FROM google.aiplatform.reasoning_engines
WHERE reasoningEnginesId = '{{ reasoningEnginesId }}' -- required
;

list

Lists reasoning engines in a location.

SELECT
name,
contextSpec,
createTime,
description,
displayName,
encryptionSpec,
etag,
labels,
spec,
updateTime
FROM google.aiplatform.reasoning_engines
WHERE pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND filter = '{{ filter }}'
AND parent = '{{ parent }}'
;

INSERT examples

create

Creates a reasoning engine.

INSERT INTO google.aiplatform.reasoning_engines (
data__contextSpec,
data__description,
data__labels,
data__encryptionSpec,
data__name,
data__displayName,
data__etag,
data__spec,
parent
)
SELECT 
'{{ contextSpec }}',
'{{ description }}',
'{{ labels }}',
'{{ encryptionSpec }}',
'{{ name }}',
'{{ displayName }}',
'{{ etag }}',
'{{ spec }}',
'{{ parent }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: reasoning_engines
  props:
    - name: contextSpec
      value: object
      description: >
        Optional. Configuration for how Agent Engine sub-resources should manage context.
        
    - name: description
      value: string
      description: >
        Optional. The description of the ReasoningEngine.
        
    - name: labels
      value: object
      description: >
        Labels for the ReasoningEngine.
        
    - name: encryptionSpec
      value: object
      description: >
        Customer-managed encryption key spec for a ReasoningEngine. If set, this ReasoningEngine and all sub-resources of this ReasoningEngine will be secured by this key.
        
    - name: name
      value: string
      description: >
        Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
        
    - name: displayName
      value: string
      description: >
        Required. The display name of the ReasoningEngine.
        
    - name: etag
      value: string
      description: >
        Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
        
    - name: spec
      value: object
      description: >
        Optional. Configurations of the ReasoningEngine
        
    - name: parent
      value: string

UPDATE examples

patch

Updates a reasoning engine.

UPDATE google.aiplatform.reasoning_engines
SET 
data__contextSpec = '{{ contextSpec }}',
data__description = '{{ description }}',
data__labels = '{{ labels }}',
data__encryptionSpec = '{{ encryptionSpec }}',
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__etag = '{{ etag }}',
data__spec = '{{ spec }}'
WHERE 
reasoningEnginesId = '{{ reasoningEnginesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a reasoning engine.

DELETE FROM google.aiplatform.reasoning_engines
WHERE reasoningEnginesId = '{{ reasoningEnginesId }}' --required
AND force = '{{ force }}'
;

Lifecycle Methods

query

Queries using a reasoning engine.

EXEC google.aiplatform.reasoning_engines.query 
@reasoningEnginesId='{{ reasoningEnginesId }}' --required 
@@json=
'{
"classMethod": "{{ classMethod }}", 
"input": "{{ input }}"
}'
;

stream_query

Streams queries using a reasoning engine.

EXEC google.aiplatform.reasoning_engines.stream_query 
@reasoningEnginesId='{{ reasoningEnginesId }}' --required 
@@json=
'{
"input": "{{ input }}", 
"classMethod": "{{ classMethod }}"
}'
;