Skip to content
v2.277.0

InstructionProperty Struct ​

The reviewed content this instruction serves — what AgenticRetrieveStream resolves while status is ACTIVE.

Absent until the first create review passes. Always present on a numbered version.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrock as bedrock } from 'aws-cdk-lib';
const instructionProperty: bedrock.CfnRetrievalInstruction.InstructionProperty = {
  answerFormat: 'answerFormat',
  answerPolicy: 'answerPolicy',
  persona: 'persona',
  retrievalGuidance: 'retrievalGuidance',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrock as bedrock

instruction_property = bedrock.CfnRetrievalInstruction.InstructionProperty(
    answer_format="answerFormat",
    answer_policy="answerPolicy",
    persona="persona",
    retrieval_guidance="retrievalGuidance"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.bedrock.*;

InstructionProperty instructionProperty = InstructionProperty.builder()
        .answerFormat("answerFormat")
        .answerPolicy("answerPolicy")
        .persona("persona")
        .retrievalGuidance("retrievalGuidance")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Bedrock;

var instructionProperty = new InstructionProperty {
    AnswerFormat = "answerFormat",
    AnswerPolicy = "answerPolicy",
    Persona = "persona",
    RetrievalGuidance = "retrievalGuidance"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

instructionProperty := &InstructionProperty{
	AnswerFormat: jsii.String("answerFormat"),
	AnswerPolicy: jsii.String("answerPolicy"),
	Persona: jsii.String("persona"),
	RetrievalGuidance: jsii.String("retrievalGuidance"),
}

Properties ​

answerFormatoptionalstringanswer_formatoptionalstranswerFormatoptionalStringAnswerFormatoptionalstringAnswerFormatoptional*string#
How the answer is structured, including how sources are cited.
answerPolicyoptionalstringanswer_policyoptionalstranswerPolicyoptionalStringAnswerPolicyoptionalstringAnswerPolicyoptional*string#
Whether and how to answer: how strongly an answer must be supported, and what to do with questions outside scope.
personaoptionalstringpersonaoptionalstrpersonaoptionalStringPersonaoptionalstringPersonaoptional*string#
Who the assistant is: identity, tone and language.
retrievalGuidanceoptionalstringretrieval_guidanceoptionalstrretrievalGuidanceoptionalStringRetrievalGuidanceoptionalstringRetrievalGuidanceoptional*string#
How to interpret and decompose the question, and what to prioritise when searching.