Get Prompt

bedrockagent_get_prompt

R Documentation

Retrieves information about the working draft (DRAFT version) of a prompt or a version of it, depending on whether you include the promptVersion field or not

Description

Retrieves information about the working draft (DRAFT version) of a prompt or a version of it, depending on whether you include the promptVersion field or not. For more information, see View information about prompts using Prompt management and View information about a version of your prompt in the Amazon Bedrock User Guide.

Usage

bedrockagent_get_prompt(promptIdentifier, promptVersion)

Arguments

promptIdentifier

[required] The unique identifier of the prompt.

promptVersion

The version of the prompt about which you want to retrieve information. Omit this field to return information about the working draft of the prompt.

Value

A list with the following syntax:

list(
  arn = "string",
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  customerEncryptionKeyArn = "string",
  defaultVariant = "string",
  description = "string",
  id = "string",
  name = "string",
  updatedAt = as.POSIXct(
    "2015-01-01"
  ),
  variants = list(
    list(
      additionalModelRequestFields = list(),
      genAiResource = list(
        agent = list(
          agentIdentifier = "string"
        )
      ),
      inferenceConfiguration = list(
        text = list(
          maxTokens = 123,
          stopSequences = list(
            "string"
          ),
          temperature = 123.0,
          topP = 123.0
        )
      ),
      metadata = list(
        list(
          key = "string",
          value = "string"
        )
      ),
      modelId = "string",
      name = "string",
      templateConfiguration = list(
        chat = list(
          inputVariables = list(
            list(
              name = "string"
            )
          ),
          messages = list(
            list(
              content = list(
                list(
                  text = "string"
                )
              ),
              role = "user"|"assistant"
            )
          ),
          system = list(
            list(
              text = "string"
            )
          ),
          toolConfiguration = list(
            toolChoice = list(
              any = list(),
              auto = list(),
              tool = list(
                name = "string"
              )
            ),
            tools = list(
              list(
                toolSpec = list(
                  description = "string",
                  inputSchema = list(
                    json = list()
                  ),
                  name = "string"
                )
              )
            )
          )
        ),
        text = list(
          inputVariables = list(
            list(
              name = "string"
            )
          ),
          text = "string"
        )
      ),
      templateType = "TEXT"|"CHAT"
    )
  ),
  version = "string"
)

Request syntax

svc$get_prompt(
  promptIdentifier = "string",
  promptVersion = "string"
)