- INFORMATION
- 
gcloud ai endpoints explainis supported in universe domainuniverse; however, some of the values used in the help text may not be available. Command examples may not work as-is and may requires changes before execution.
- NAME
- 
- gcloud ai endpoints explain - request an online explanation from an Vertex AI endpoint
 
- SYNOPSIS
- 
- 
gcloud ai endpoints explain(ENDPOINT:--region=REGION)--json-request=JSON_REQUEST[--deployed-model-id=DEPLOYED_MODEL_ID] [GCLOUD_WIDE_FLAG …]
 
- 
- DESCRIPTION
- 
gcloud ai endpoints explainsends an explanation request to the Vertex AI endpoint for the given instances. This command reads up to 100 instances, though the service itself accepts instances up to the payload limit size (currently, 1.5MB).
- EXAMPLES
- 
To send an explanation request to the endpoint for the json file, input.json,
run:
gcloud ai endpoints explain ENDPOINT_ID --region=us-central1 --json-request=input.json
- POSITIONAL ARGUMENTS
- 
- 
Endpoint resource - The endpoint to request an online explanation. The arguments
in this group can be used to specify the attributes of this resource. (NOTE)
Some attributes are not given arguments in this group but can be set in other
ways.
To set the projectattribute:- 
provide the argument endpointon the command line with a fully specified name;
- 
provide the argument --projecton the command line;
- 
set the property core/project.
 This must be specified. - ENDPOINT
- 
ID of the endpoint or fully qualified identifier for the endpoint.
To set the nameattribute:- 
provide the argument endpointon the command line.
 This positional argument must be specified if any of the other arguments in this group are specified. 
- 
provide the argument 
- --region=- REGION
- 
Cloud region for the endpoint.
To set the regionattribute:- 
provide the argument endpointon the command line with a fully specified name;
- 
provide the argument --regionon the command line;
- 
set the property ai/region;
- choose one from the prompted list of available regions.
 
- 
provide the argument 
 
- 
provide the argument 
 
- 
Endpoint resource - The endpoint to request an online explanation. The arguments
in this group can be used to specify the attributes of this resource. (NOTE)
Some attributes are not given arguments in this group but can be set in other
ways.
- REQUIRED FLAGS
- 
- --json-request=- JSON_REQUEST
- 
Path to a local file containing the body of a JSON request.
An example of a JSON request: { "instances": [ {"x": [1, 2], "y": [3, 4]}, {"x": [-1, -2], "y": [-3, -4]} ] } This flag accepts "-" for stdin. 
 
- OPTIONAL FLAGS
- 
- --deployed-model-id=- DEPLOYED_MODEL_ID
- Id of the deployed model.
 
- GCLOUD WIDE FLAGS
- 
These flags are available to all commands: --access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run $ gcloud helpfor details.
- NOTES
- 
These variants are also available:
gcloud alpha ai endpoints explaingcloud beta ai endpoints explain
      gcloud ai endpoints explain
  
  
  Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-16 UTC.
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-16 UTC."],[],[]]