Alibaba Cloud Model Studio:ListPromptTemplates

Obtiene una lista de plantillas de prompts.

Depuración

Puede ejecutar esta interfaz directamente en OpenAPI Explorer, ahorrándole la molestia de calcular firmas. Después de ejecutarse con éxito, OpenAPI Explorer puede generar automáticamente muestras de código SDK.

Depurar

Información de autorización

La siguiente tabla muestra la información de autorización correspondiente a la API. La información de autorización se puede utilizar en el elemento de política Action para otorgar a un usuario de RAM o a un rol de RAM los permisos para llamar a esta operación de API. Descripción:

• Operación: el valor que puede utilizar en el elemento Action para especificar la operación sobre un recurso.

• Nivel de acceso: el nivel de acceso de cada operación. Los niveles son lectura, escritura y lista.

• Tipo de recurso: el tipo de recurso sobre el cual puede autorizar al usuario de RAM o al rol de RAM para realizar la operación. Tenga en cuenta los siguientes puntos:

  • Para los tipos de recursos obligatorios, indíquelo con un prefijo * .
  • Si los permisos no se pueden otorgar a nivel de recurso, se utiliza All Resources en la columna Tipo de recurso de la operación.

• Clave de condición: la clave de condición definida por el servicio en la nube.

• Operación asociada: otras operaciones para las cuales el usuario de RAM o el rol de RAM deben tener permisos para completar la operación. Para completar la operación, el usuario de RAM o el rol de RAM deben tener los permisos para realizar las operaciones asociadas.

Operación	Nivel de acceso	Tipo de recurso	Clave de condición	Operación asociada
sfm:ListPromptTemplates	list	*Todos los recursos *	none	none

Sintaxis de la solicitud

GET /{workspaceId}/promptTemplates HTTP/1.1

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
workspaceId	string	Sí	El ID del espacio de trabajo.	llm-us9hjmt32nysdxxx
name	string	No	La palabra clave que se utiliza para buscar plantillas.
type	string	No	El tipo de la plantilla. Valores válidos: · System · Custom	System
maxResults	integer	No	El número máximo de entradas devueltas.	10
nextToken	string	No	El token que determina la posición de inicio de la consulta. Establezca este parámetro en el valor del parámetro NextToken devuelto en la última llamada.	dc270401186b433f975d7e1faaa34e0e

Parámetros de respuesta

Parámetro	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta
maxResults	integer	El número máximo de entradas devueltas.	10
nextToken	string	El token que determina la posición de inicio de la siguiente consulta.	dc270401186b433f975d7e1faaa34e0e
promptTemplates	array<object>	Las plantillas.
PromptTemplates	object
content	string	El contenido de la plantilla
name	string	El nombre de la plantilla.
promptTemplateId	string	El ID de la plantilla.	d6935b7efbe34d11b13df9307151cf8c
type	string	El tipo de plantilla.	"System"
variables	array	Las variables de la plantilla.
Variables	string	La variable de la plantilla.	"theme"
requestId	string	El ID de la solicitud.	FE9B6CBF-47E6-5D76-9C5D-B814DD5AB071
totalCount	integer	El número total de entradas devueltas.	15
workspaceId	string	El ID del espacio de trabajo.	llm-us9hjmt32nysdxxx

Ejemplos

Respuestas de éxito de ejemplo

Formato JSON

{
  "maxResults": 10,
  "nextToken": "dc270401186b433f975d7e1faaa34e0e",
  "promptTemplates": [
    {
      "content": "",
      "name": "",
      "promptTemplateId": "d6935b7efbe34d11b13df9307151cf8c",
      "type": "System",
      "variables": [
        "theme"
      ]
    }
  ],
  "requestId": "FE9B6CBF-47E6-5D76-9C5D-B814DD5AB071",
  "totalCount": 15,
  "workspaceId": "llm-us9hjmt32nysdxxx\n"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	PromptTemplate.MaxResultsInvalid	El parámetro de entrada MaxResults no es válido.	El formato del parámetro de entrada maxResults no es válido.
400	PromptTemplate.NameInvalid	El parámetro de entrada Name no es válido.	El formato del parámetro de entrada Name no es válido.
400	PromptTemplate.NextTokenInvalid	El parámetro de entrada NextToken no es válido.	El nextToken de entrada no es válido.
400	PromptTemplate.TypeInvalid	El tipo del parámetro de entrada no es válido.	el formato del tipo de entrada no es válido
500	PromptTemplate.InternalError	Excepción interna del servicio de plantillas de prompt.	excepción interna del servicio de plantillas de prompt