Method: projects.locations.reasoningEngines.query

Queries using a reasoning engine.

HTTP request

POST https://{service-endpoint}/v1beta1/{name}:query

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

Parameters
name

string

Required. The name of the ReasoningEngine resource to use. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoningEngine}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "input": {
    object
  }
}
Fields
input

object (Struct format)

Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.

Response body

Response message for [ReasoningEngineExecutionService.Query][]

If successful, the response body contains data with the following structure:

JSON representation 
{
  "output": value
}
Fields
output

value (Value format)

Response provided by users in JSON object format.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.reasoningEngines.query

For more information, see the IAM documentation.