ListPromptTemplates - Alibaba Cloud Model Studio

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação	Nível de acesso	Tipo de recurso	Chave de condição	Ação dependente
sfm:ListPromptTemplates	list	All Resource ``	Nenhuma	Nenhuma

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

sfm:ListPromptTemplates

list

*All Resource

*

Nenhuma

Sintaxe da solicitação

GET /{workspaceId}/promptTemplates HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
workspaceId	string	Sim	O ID do workspace.	llm-us9hjmt32nysdxxx

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
name	string	Não	A palavra-chave usada para pesquisar modelos.	小红书
type	string	Não	O tipo do modelo. Valores válidos: · System · Custom.	System
maxResults	integer	Não	O número máximo de entradas retornadas.	10
nextToken	string	Não	O token que determina a posição inicial da consulta. Defina este parâmetro como o valor do parâmetro NextToken retornado na última chamada.	dc270401186b433f975d7e1faaa34e0e

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
maxResults	integer	O número máximo de entradas retornadas.	10
nextToken	string	O token que determina a posição inicial da próxima consulta.	dc270401186b433f975d7e1faaa34e0e
promptTemplates	array<object>	Os modelos.
	object
content	string	O conteúdo do modelo.	请写一篇小红书种草笔记，增加丰富的emoji元素，结尾作总结，并加上相关标签。主题为：${theme}
name	string	O nome do modelo.	小红书文案
promptTemplateId	string	O ID do modelo.	d6935b7efbe34d11b13df9307151cf8c
type	string	O tipo do modelo.	"System"
variables	array	As variáveis do modelo.
	string	A variável do modelo.	"theme"
requestId	string	O ID da solicitação.	FE9B6CBF-47E6-5D76-9C5D-B814DD5AB071
totalCount	integer	O número total de entradas retornadas.	15
workspaceId	string	O ID do workspace.	llm-us9hjmt32nysdxxx

Exemplos

Resposta de sucesso JSON formato

{
  "maxResults": 10,
  "nextToken": "dc270401186b433f975d7e1faaa34e0e",
  "promptTemplates": [
    {
      "content": "请写一篇小红书种草笔记，增加丰富的emoji元素，结尾作总结，并加上相关标签。主题为：${theme}",
      "name": "小红书文案\n",
      "promptTemplateId": "d6935b7efbe34d11b13df9307151cf8c",
      "type": "\"System\"",
      "variables": [
        "\"theme\""
      ]
    }
  ],
  "requestId": "FE9B6CBF-47E6-5D76-9C5D-B814DD5AB071",
  "totalCount": 15,
  "workspaceId": "llm-us9hjmt32nysdxxx\n"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	PromptTemplate.MaxResultsInvalid	Input parameter MaxResults is invalid.	The input parameter maxResults format is invalid.
400	PromptTemplate.NameInvalid	Input parameter Name is invalid.	The format of the input parameter Name is invalid.
400	PromptTemplate.NextTokenInvalid	Input parameter NextToken is invalid.	The input nextToken is invalid.
400	PromptTemplate.TypeInvalid	Input parameter type is invalid.	input type format is invalid
500	PromptTemplate.InternalError	Prompt template service inner exception.	prompt template service internal exception

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.

​Experimente agora

​Autorização RAM

​Sintaxe da solicitação

​Parâmetros de caminho

​Parâmetros da solicitação

​Elementos de resposta

​Exemplos

​Códigos de erro

​Notas de versão