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		pageSize, parent, filter, pageToken	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.
cancel_async_query	exec	reasoningEnginesId		Cancels an AsyncQueryReasoningEngine operation.
async_query	exec	reasoningEnginesId		Async query using a reasoning engine.
execute_code	exec	reasoningEnginesId		Executes code statelessly.
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 pageSize = '{{ pageSize }}'
AND parent = '{{ parent }}'
AND filter = '{{ filter }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Creates a reasoning engine.

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

Manifest

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

UPDATE examples

patch

Updates a reasoning engine.

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

cancel_async_query

Cancels an AsyncQueryReasoningEngine operation.

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

async_query

Async query using a reasoning engine.

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

execute_code

Executes code statelessly.

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

query

Queries using a reasoning engine.

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

stream_query

Streams queries using a reasoning engine.

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