Class CreateAgentActionGroupRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateAgentActionGroupRequest.Builder,
CreateAgentActionGroupRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal ActionGroupExecutor
The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.final String
The name to give the action group.final ActionGroupState
Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.final String
Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.final String
agentId()
The unique identifier of the agent for which to create the action group.final String
The version of the agent for which to create the action group.final APISchema
Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.builder()
final String
A unique, case-sensitive identifier to ensure that the API request completes no more than one time.final String
A description of the action group.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final FunctionSchema
Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final ActionGroupSignature
To allow your agent to request the user for additional information when trying to complete a task, set this field toAMAZON.UserInput
.final String
To allow your agent to request the user for additional information when trying to complete a task, set this field toAMAZON.UserInput
.static Class
<? extends CreateAgentActionGroupRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
actionGroupExecutor
The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
- Returns:
- The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
-
actionGroupName
The name to give the action group.
- Returns:
- The name to give the action group.
-
actionGroupState
Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
If the service returns an enum value that is not available in the current SDK version,
actionGroupState
will returnActionGroupState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionGroupStateAsString()
.- Returns:
- Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
- See Also:
-
actionGroupStateAsString
Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
If the service returns an enum value that is not available in the current SDK version,
actionGroupState
will returnActionGroupState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionGroupStateAsString()
.- Returns:
- Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
- See Also:
-
agentId
The unique identifier of the agent for which to create the action group.
- Returns:
- The unique identifier of the agent for which to create the action group.
-
agentVersion
The version of the agent for which to create the action group.
- Returns:
- The version of the agent for which to create the action group.
-
apiSchema
Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
- Returns:
- Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
-
clientToken
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
- Returns:
- A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
-
description
A description of the action group.
- Returns:
- A description of the action group.
-
functionSchema
Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
- Returns:
- Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
-
parentActionGroupSignature
To allow your agent to request the user for additional information when trying to complete a task, set this field to
AMAZON.UserInput
. You must leave thedescription
,apiSchema
, andactionGroupExecutor
fields blank for this action group.During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
If the service returns an enum value that is not available in the current SDK version,
parentActionGroupSignature
will returnActionGroupSignature.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromparentActionGroupSignatureAsString()
.- Returns:
- To allow your agent to request the user for additional information when trying to complete a task, set
this field to
AMAZON.UserInput
. You must leave thedescription
,apiSchema
, andactionGroupExecutor
fields blank for this action group.During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
- See Also:
-
parentActionGroupSignatureAsString
To allow your agent to request the user for additional information when trying to complete a task, set this field to
AMAZON.UserInput
. You must leave thedescription
,apiSchema
, andactionGroupExecutor
fields blank for this action group.During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
If the service returns an enum value that is not available in the current SDK version,
parentActionGroupSignature
will returnActionGroupSignature.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromparentActionGroupSignatureAsString()
.- Returns:
- To allow your agent to request the user for additional information when trying to complete a task, set
this field to
AMAZON.UserInput
. You must leave thedescription
,apiSchema
, andactionGroupExecutor
fields blank for this action group.During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateAgentActionGroupRequest.Builder,
CreateAgentActionGroupRequest> - Specified by:
toBuilder
in classBedrockAgentRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-