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	projectsId, locationsId, reasoningEnginesId		Gets a reasoning engine.
list	select	projectsId, locationsId	filter, pageSize, pageToken	Lists reasoning engines in a location.
create	insert	projectsId, locationsId		Creates a reasoning engine.
patch	update	projectsId, locationsId, reasoningEnginesId	updateMask	Updates a reasoning engine.
delete	delete	projectsId, locationsId, reasoningEnginesId	force	Deletes a reasoning engine.
async_query	exec	projectsId, locationsId, reasoningEnginesId		Async query using a reasoning engine.
cancel_async_query	exec	projectsId, locationsId, reasoningEnginesId		Cancels an AsyncQueryReasoningEngine operation.
execute_code	exec	projectsId, locationsId, reasoningEnginesId		Executes code statelessly.
query	exec	projectsId, locationsId, reasoningEnginesId		Queries using a reasoning engine.
stream_query	exec	projectsId, locationsId, 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
locationsId	string
projectsId	string
reasoningEnginesId	string
filter	string
force	boolean
pageSize	integer (int32)
pageToken	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 projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND 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 projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Creates a reasoning engine.

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

Manifest

# Description fields are for documentation purposes
- name: reasoning_engines
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the reasoning_engines resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the reasoning_engines resource.
  - name: contextSpec
    description: |
      Optional. Configuration for how Agent Engine sub-resources should manage context.
    value:
      memoryBankConfig:
        customizationConfigs:
          - consolidationConfig:
              revisionsPerCandidateCount: {{ revisionsPerCandidateCount }}
            disableNaturalLanguageMemories: {{ disableNaturalLanguageMemories }}
            enableThirdPersonMemories: {{ enableThirdPersonMemories }}
            generateMemoriesExamples: "{{ generateMemoriesExamples }}"
            memoryTopics: "{{ memoryTopics }}"
            scopeKeys: "{{ scopeKeys }}"
        disableMemoryRevisions: {{ disableMemoryRevisions }}
        generationConfig:
          generationTriggerConfig:
            generationRule:
              eventCount: {{ eventCount }}
              fixedInterval: "{{ fixedInterval }}"
              idleDuration: "{{ idleDuration }}"
              overlapEventCount: {{ overlapEventCount }}
          model: "{{ model }}"
        similaritySearchConfig:
          embeddingModel: "{{ embeddingModel }}"
        ttlConfig:
          defaultTtl: "{{ defaultTtl }}"
          granularTtlConfig:
            createTtl: "{{ createTtl }}"
            generateCreatedTtl: "{{ generateCreatedTtl }}"
            generateUpdatedTtl: "{{ generateUpdatedTtl }}"
          memoryRevisionDefaultTtl: "{{ memoryRevisionDefaultTtl }}"
  - name: description
    value: "{{ description }}"
    description: |
      Optional. The description of the ReasoningEngine.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Required. The display name of the ReasoningEngine.
  - name: encryptionSpec
    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.
    value:
      kmsKeyName: "{{ kmsKeyName }}"
  - name: etag
    value: "{{ etag }}"
    description: |
      Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
  - name: labels
    value: "{{ labels }}"
    description: |
      Labels for the ReasoningEngine.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
  - name: spec
    description: |
      Optional. Configurations of the ReasoningEngine
    value:
      agentFramework: "{{ agentFramework }}"
      buildSpec:
        serviceAccount: "{{ serviceAccount }}"
        workerPool: "{{ workerPool }}"
      classMethods: "{{ classMethods }}"
      containerSpec:
        imageUri: "{{ imageUri }}"
        port: {{ port }}
      deploymentSpec:
        agentGatewayConfig:
          agentToAnywhereConfig:
            agentGateway: "{{ agentGateway }}"
          clientToAgentConfig:
            agentGateway: "{{ agentGateway }}"
        containerConcurrency: {{ containerConcurrency }}
        env:
          - name: "{{ name }}"
            value: "{{ value }}"
        keepAliveProbe:
          httpGet:
            path: "{{ path }}"
            port: {{ port }}
          maxSeconds: {{ maxSeconds }}
        maxInstances: {{ maxInstances }}
        minInstances: {{ minInstances }}
        pscInterfaceConfig:
          dnsPeeringConfigs:
            - domain: "{{ domain }}"
              targetNetwork: "{{ targetNetwork }}"
              targetProject: "{{ targetProject }}"
          networkAttachment: "{{ networkAttachment }}"
        resourceLimits: "{{ resourceLimits }}"
        secretEnv:
          - name: "{{ name }}"
            secretRef:
              secret: "{{ secret }}"
              version: "{{ version }}"
      effectiveIdentity: "{{ effectiveIdentity }}"
      identityType: "{{ identityType }}"
      packageSpec:
        dependencyFilesGcsUri: "{{ dependencyFilesGcsUri }}"
        pickleObjectGcsUri: "{{ pickleObjectGcsUri }}"
        pythonVersion: "{{ pythonVersion }}"
        requirementsGcsUri: "{{ requirementsGcsUri }}"
      serviceAccount: "{{ serviceAccount }}"
      sourceCodeSpec:
        agentConfigSource:
          adkConfig:
            jsonConfig: "{{ jsonConfig }}"
          inlineSource:
            sourceArchive: "{{ sourceArchive }}"
        developerConnectSource:
          config:
            dir: "{{ dir }}"
            gitRepositoryLink: "{{ gitRepositoryLink }}"
            revision: "{{ revision }}"
        imageSpec:
          buildArgs: "{{ buildArgs }}"
        inlineSource:
          sourceArchive: "{{ sourceArchive }}"
        pythonSpec:
          entrypointModule: "{{ entrypointModule }}"
          entrypointObject: "{{ entrypointObject }}"
          requirementsFile: "{{ requirementsFile }}"
          version: "{{ version }}"

UPDATE examples

patch

Updates a reasoning engine.

UPDATE google.aiplatform.reasoning_engines
SET 
data__contextSpec = '{{ contextSpec }}',
data__description = '{{ description }}',
data__displayName = '{{ displayName }}',
data__encryptionSpec = '{{ encryptionSpec }}',
data__etag = '{{ etag }}',
data__labels = '{{ labels }}',
data__name = '{{ name }}',
data__spec = '{{ spec }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND 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 projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND reasoningEnginesId = '{{ reasoningEnginesId }}' --required
AND force = '{{ force }}'
;

Lifecycle Methods

async_query

Async query using a reasoning engine.

EXEC google.aiplatform.reasoning_engines.async_query 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@reasoningEnginesId='{{ reasoningEnginesId }}' --required 
@@json=
'{
"inputGcsUri": "{{ inputGcsUri }}", 
"outputGcsUri": "{{ outputGcsUri }}"
}'
;

cancel_async_query

Cancels an AsyncQueryReasoningEngine operation.

EXEC google.aiplatform.reasoning_engines.cancel_async_query 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@reasoningEnginesId='{{ reasoningEnginesId }}' --required 
@@json=
'{
"operationName": "{{ operationName }}"
}'
;

execute_code

Executes code statelessly.

EXEC google.aiplatform.reasoning_engines.execute_code 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@reasoningEnginesId='{{ reasoningEnginesId }}' --required 
@@json=
'{
"inputs": "{{ inputs }}"
}'
;

query

Queries using a reasoning engine.

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

stream_query

Streams queries using a reasoning engine.

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