DebugModel

Updated at:
Copy as MD

Invokes a specified model through a published model connection to verify whether the model invocation pipeline is available.

Operation description

Invokes a specified model through a published model connection to verify whether the model invocation pipeline is available.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

agentcore:DebugModel

none

*Model

acs:agentcore:{#regionId}:{#accountId}:workspace/{#workspaceId}/model/{#modelId}

None None

Request syntax

POST /workspaces/{workspaceId}/models/{modelId}/actions/debug HTTP/1.1

Path Parameters

Parameter

Type

Required

Description

Example

workspaceId

string

Yes

The workspace ID.

ws-1

modelId

string

Yes

The model ID.

model-1

Request parameters

Parameter

Type

Required

Description

Example

body

object

No

The request body.

prompt

string

Yes

The prompt used to verify the model invocation pipeline.

hello

Response elements

Element

Type

Description

Example

object

The text response returned by the model when the model test succeeds. This field is empty if the test fails.

requestId

string

The request ID.

request-1

message

string

The request processing result message.

success

httpStatusCode

integer

The HTTP status code. The value is 200 if the request is successful.

200

code

string

The business status code. The value is SUCCESS if the request is successful.

SUCCESS

success

boolean

Indicates whether the request is successful.

data

object

The model test result.

modelId

string

The model ID.

model-1

connectionId

string

The model connection ID.

mc-1

debugSuccess

boolean

Indicates whether the model test is successful.

status

string

The test result status.

NORMAL

latencyMs

integer

The duration of the model test call, in milliseconds.

12

inputTokens

integer

The number of input tokens consumed by the model test request.

3

outputTokens

integer

The number of output tokens consumed by the model test response.

2

response

string

The text response returned by the model when the model test succeeds. This field is empty if the test fails.

ok

errorCode

string

The error code for a test failure.

UPSTREAM_MODEL_ERROR

errorMessage

string

The error description for a test failure.

The model endpoint rejected the debug request.

Examples

Success response

JSON format

{
  "requestId": "request-1",
  "message": "success",
  "httpStatusCode": 200,
  "code": "SUCCESS",
  "success": false,
  "data": {
    "modelId": "model-1",
    "connectionId": "mc-1",
    "debugSuccess": false,
    "status": "NORMAL",
    "latencyMs": 12,
    "inputTokens": 3,
    "outputTokens": 2,
    "response": "ok",
    "errorCode": "UPSTREAM_MODEL_ERROR",
    "errorMessage": "The model endpoint rejected the debug request."
  }
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidParameter A model debugging parameter is invalid.
404 Resource.NotFound The specified AgentCore workspace does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.