Call a plugin and retrieve its response.
Operation description
Prerequisites
- You have activated Alibaba Cloud Model Studio and Tongyi Dianjin services.
- Obtain the workspace ID. For more information, see Get the workspace ID.
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.
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
Actionelement 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
Resourceelement of the policy. - For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the
Resourceelement of the policy.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the
- 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 |
|---|---|---|---|---|
dianjin:InvokePlugin | none | *All Resource
| None | None |
Request syntax
Path Parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| workspaceId | string | Yes | Path parameter. The workspace ID. | llm-xxxxx |
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| body | object | No | Request body parameters. | |
| params | object | No | Request parameters. | { "query": "Introduce the precious metals business", "filters": [ { "libraryId": "9xznrxw" } ], "topK": 1 } |
| pluginId | string | No | The plugin ID. | 3mj87da7zr |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | Result code. | ||
| cost | integer | Response time in milliseconds. | null |
| data | object | Response data. | {'jobWaiting': [0, 0], 'timestamps': [1713383820, 1713383880], 'jobUsage': [0, 0], 'quotaUsage': [123, 32]} |
| dataType | string | Data type. | null |
| errCode | string | Error code. | 0 |
| message | string | Error message. | ok |
| requestId | string | The request ID. | 915AAAB9-4908-5224-9E53-9E9D7D0AA94B |
| success | boolean | Indicates whether the call succeeded. | true |
| time | string | Timestamp in YYYY-MM-DD HH:MM:SS format. | 2024-04-24 11:54:34 |
Examples
Success response
JSON format