Obtiene una plantilla de prompt basada en el ID de plantilla.
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.
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 Resourcesen 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:GetPromptTemplate | get | *Todos los recursos * |
| none |
Sintaxis de la solicitud
GET /{workspaceId}/promptTemplates/{promptTemplateId} 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 |
| promptTemplateId | string | Sí | El ID de la plantilla. | 6e49109bfeb94a39bb268f4e483ccxxx |
Parámetros de respuesta
| Parámetro | Tipo | Descripción | Ejemplo |
|---|---|---|---|
| object | Esquema de la respuesta | ||
| content | string | El contenido de la plantilla. | |
| name | string | El nombre de la plantilla. | |
| promptTemplateId | string | El ID de la plantilla. | 6e49109bfeb94a39bb268f4e483ccxxx |
| requestId | string | El ID de la solicitud. | 8C56C7AF-6573-19CE-B018-E05E1EDCF4C5 |
| workspaceId | string | El ID del espacio de trabajo. | llm-us9hjmt32nysdxxx |
| variables | array | Las variables de la plantilla. | |
| Variables | string | La variable de la plantilla. | theme |
Ejemplos
Respuestas de éxito de ejemplo
Formato JSON
{
"content": "",
"name": "",
"promptTemplateId": "6e49109bfeb94a39bb268f4e483ccxxx",
"requestId": "8C56C7AF-6573-19CE-B018-E05E1EDCF4C5\n",
"workspaceId": "llm-us9hjmt32nysdxxx\n",
"variables": [
"theme"
]
}
Códigos de error
| Código de estado HTTP | Código de error | Mensaje de error | Descripción |
|---|---|---|---|
| 404 | PromptTemplate.TemplateNotFound | Plantilla de prompt no encontrada. | Plantilla de prompt no encontrada |
| 500 | PromptTemplate.InternalError | Excepción interna del servicio de plantillas de prompt. | excepción interna del servicio de plantillas de prompt |