Method: googleapis.aiplatform.v1.projects.locations.endpoints.explain

Perform an online explanation. If deployed_model_id is specified, the corresponding DeployModel must have explanation_spec populated. If deployed_model_id is not specified, all DeployedModels must have explanation_spec populated.

Arguments

Parameters
endpoint

string

Required. The name of the Endpoint requested to serve the explanation. Format: projects/{project}/locations/{location}/endpoints/{endpoint}
region

string

Required. Region of the HTTP endpoint. For example, if region is set to us-central1, the endpoint https://us-central1-integrations.googleapis.com will be used. See service endpoints.
body

object (GoogleCloudAiplatformV1ExplainRequest)

Required.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of GoogleCloudAiplatformV1ExplainResponse.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- explain:
    call: googleapis.aiplatform.v1.projects.locations.endpoints.explain
    args:
        endpoint: ...
        region: ...
        body:
            deployedModelId: ...
            explanationSpecOverride:
                examplesOverride:
                    crowdingCount: ...
                    dataFormat: ...
                    neighborCount: ...
                    restrictions: ...
                    returnEmbeddings: ...
                metadata:
                    inputs: ...
                parameters:
                    examples:
                        exampleGcsSource:
                            dataFormat: ...
                            gcsSource:
                                uris: ...
                        nearestNeighborSearchConfig: ...
                        neighborCount: ...
                        presets:
                            modality: ...
                            query: ...
                    integratedGradientsAttribution:
                        blurBaselineConfig:
                            maxBlurSigma: ...
                        smoothGradConfig:
                            featureNoiseSigma:
                                noiseSigma: ...
                            noiseSigma: ...
                            noisySampleCount: ...
                        stepCount: ...
                    outputIndices: ...
                    sampledShapleyAttribution:
                        pathCount: ...
                    topK: ...
                    xraiAttribution:
                        blurBaselineConfig: ...
                        smoothGradConfig: ...
                        stepCount: ...
            instances: ...
            parameters: ...
    result: explainResult

JSON

[
  {
    "explain": {
      "call": "googleapis.aiplatform.v1.projects.locations.endpoints.explain",
      "args": {
        "endpoint": "...",
        "region": "...",
        "body": {
          "deployedModelId": "...",
          "explanationSpecOverride": {
            "examplesOverride": {
              "crowdingCount": "...",
              "dataFormat": "...",
              "neighborCount": "...",
              "restrictions": "...",
              "returnEmbeddings": "..."
            },
            "metadata": {
              "inputs": "..."
            },
            "parameters": {
              "examples": {
                "exampleGcsSource": {
                  "dataFormat": "...",
                  "gcsSource": {
                    "uris": "..."
                  }
                },
                "nearestNeighborSearchConfig": "...",
                "neighborCount": "...",
                "presets": {
                  "modality": "...",
                  "query": "..."
                }
              },
              "integratedGradientsAttribution": {
                "blurBaselineConfig": {
                  "maxBlurSigma": "..."
                },
                "smoothGradConfig": {
                  "featureNoiseSigma": {
                    "noiseSigma": "..."
                  },
                  "noiseSigma": "...",
                  "noisySampleCount": "..."
                },
                "stepCount": "..."
              },
              "outputIndices": "...",
              "sampledShapleyAttribution": {
                "pathCount": "..."
              },
              "topK": "...",
              "xraiAttribution": {
                "blurBaselineConfig": "...",
                "smoothGradConfig": "...",
                "stepCount": "..."
              }
            }
          },
          "instances": "...",
          "parameters": "..."
        }
      },
      "result": "explainResult"
    }
  }
]