CreateAgent - DataWorks - Centro de documentación de Alibaba Cloud

Crea un agente.

Descripción de la operación

Descripción de la solicitud

Nombre del agente: Debe ser único dentro de la cuenta actual.
Configuración del modelo: Opcional. Especifica el modelo que utiliza el agente y sus ajustes relacionados.
Nivel de visibilidad: Define quién puede acceder al agente. Los valores admitidos incluyen visibilidad para toda la cuenta, para un proyecto específico o para un usuario específico.
Alcance de visibilidad: Cuando se selecciona PROJECT o USER como nivel de visibilidad, debe especificar los ID de proyecto o los ID de usuario específicos.
Otros parámetros: Parámetros como el nombre para mostrar y la descripción son opcionales. Complételos según sea necesario.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dataworks:CreateAgent

create

*All resources.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Name	string	Sí	El nombre del agente. El nombre debe ser único dentro de la cuenta actual.	my-agent
DisplayName	string	No	El nombre para mostrar del agente.	My Assistant
Description	string	No	La descripción del agente.	Data analytics assistant
Model	object	No	La configuración del modelo.	{ "modelName": "dataworks-public-bailian/qwen-max" }
SystemPrompt	string	No	El prompt del sistema.	You are a data analytics assistant
Tools	array<object>	No	La lista de herramientas.	-
	object	No	La información de la herramienta.	-
Name	string	No	El nombre del McpServer.	server-1
Skills	array<object>	No	La lista de habilidades.	-
	object	No	La configuración de la habilidad.	["my-skill"]
Name	string	No	El nombre de la habilidad.	skill-1
CallableAgents	array<object>	No	La lista de agentes secundarios que este agente puede invocar.	-
	object	No	El nombre del agente.	["agent-name"]
Name	string	No	El nombre del agente.	agent-1
Metadata	object	No	Los metadatos extendidos en pares clave-valor.	{}
Visibility	string	No	El nivel de visibilidad. `TENANT`: Visible dentro de la cuenta. `PROJECT`: Visible para los proyectos especificados. `USER`: Visible para los usuarios especificados. Valores válidos: PROJECT : Proyecto. USER : Usuario. TENANT : Tenant.	TENANT
VisibilityScope	object	No	El alcance de visibilidad. Se utiliza el campo correspondiente según el nivel de visibilidad.
ProjectIds	array	No	La lista de ID de proyectos visibles. Este parámetro surte efecto cuando Visibility se establece en `PROJECT`.
	string	No	El ID del espacio de trabajo.	[21791]
UserIds	array	No	La lista de ID de usuarios visibles. Este parámetro surte efecto cuando Visibility se establece en `USER`.
	string	No	El ID de usuario visible. Este parámetro surte efecto cuando Visibility se establece en `USER`.	[]

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	824F80BA-1778-5D8A-BAFF-668A4D9C4CC7
Agent	object	Los detalles del agente creado.
Name	string	El nombre del agente.	my-agent
GmtCreateTime	string	La hora de creación. El valor es una marca de tiempo UNIX en milisegundos.	1780555634000
GmtModifiedTime	string	La hora de la última modificación. El valor es una marca de tiempo UNIX en milisegundos.	1780555634000

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "824F80BA-1778-5D8A-BAFF-668A4D9C4CC7",
  "Agent": {
    "Name": "my-agent",
    "GmtCreateTime": "1780555634000",
    "GmtModifiedTime": "1780555634000"
  }
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.