String actionGroupId
The unique identifier of the action group.
String actionGroupName
The name of the action group.
String actionGroupState
Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
String description
The description of the action group.
Date updatedAt
The time at which the action group was last updated.
String agentArn
The Amazon Resource Name (ARN) of the agent.
String agentId
The unique identifier of the agent.
String agentName
The name of the agent.
String agentResourceRoleArn
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
String agentStatus
The status of the agent and whether it is ready for use. The following statuses are possible:
CREATING – The agent is being created.
PREPARING – The agent is being prepared.
PREPARED – The agent is prepared and ready to be invoked.
NOT_PREPARED – The agent has been created but not yet prepared.
FAILED – The agent API operation failed.
UPDATING – The agent is being updated.
DELETING – The agent is being deleted.
String agentVersion
The version of the agent.
String 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.
Date createdAt
The time at which the agent was created.
String customerEncryptionKeyArn
The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
String description
The description of the agent.
List<E> failureReasons
Contains reasons that the agent-related API that you invoked failed.
String foundationModel
The foundation model used for orchestration by the agent.
GuardrailConfiguration guardrailConfiguration
The guardrails configuration assigned to the agent.
Integer idleSessionTTLInSeconds
The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
String instruction
Instructions that tell the agent what it should do and how it should interact with users.
Date preparedAt
The time at which the agent was last prepared.
PromptOverrideConfiguration promptOverrideConfiguration
Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
List<E> recommendedActions
Contains recommended actions to take for the agent-related API that you invoked to succeed.
Date updatedAt
The time at which the agent was last updated.
ActionGroupExecutor 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.
String actionGroupId
The unique identifier of the action group.
String actionGroupName
The name of the action group.
String actionGroupState
Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
String agentId
The unique identifier of the agent to which the action group belongs.
String agentVersion
The version of the agent to which the action group belongs.
APISchema 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.
String 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.
Date createdAt
The time at which the action group was created.
String description
The description of the action group.
FunctionSchema functionSchema
Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
String parentActionSignature
If this field is set as AMAZON.UserInput, the agent can request the user for additional information
when trying to complete a task. The description, apiSchema, and
actionGroupExecutor fields must be blank for this action group.
During orchestration, if the 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.
Date updatedAt
The time at which the action group was last updated.
String agentAliasArn
The Amazon Resource Name (ARN) of the alias of the agent.
List<E> agentAliasHistoryEvents
Contains details about the history of the alias.
String agentAliasId
The unique identifier of the alias of the agent.
String agentAliasName
The name of the alias of the agent.
String agentAliasStatus
The status of the alias of the agent and whether it is ready for use. The following statuses are possible:
CREATING – The agent alias is being created.
PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
FAILED – The agent alias API operation failed.
UPDATING – The agent alias is being updated.
DELETING – The agent alias is being deleted.
String agentId
The unique identifier of the agent.
String 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.
Date createdAt
The time at which the alias of the agent was created.
String description
The description of the alias of the agent.
List<E> failureReasons
Information on the failure of Provisioned Throughput assigned to an agent alias.
List<E> routingConfiguration
Contains details about the routing configuration of the alias.
Date updatedAt
The time at which the alias was last updated.
Date endDate
The date that the alias stopped being associated to the version in the routingConfiguration object
List<E> routingConfiguration
Contains details about the version of the agent with which the alias is associated.
Date startDate
The date that the alias began being associated to the version in the routingConfiguration object.
String agentAliasId
Contains details about
String agentAliasName
The name of the alias.
String agentAliasStatus
The status of the alias.
Date createdAt
The time at which the alias of the agent was created.
String description
The description of the alias.
List<E> routingConfiguration
Contains details about the version of the agent with which the alias is associated.
Date updatedAt
The time at which the alias was last updated.
String agentId
The unique identifier of the agent with which the knowledge base is associated.
String agentVersion
The version of the agent with which the knowledge base is associated.
Date createdAt
The time at which the association between the agent and the knowledge base was created.
String description
The description of the association between the agent and the knowledge base.
String knowledgeBaseId
The unique identifier of the association between the agent and the knowledge base.
String knowledgeBaseState
Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
Date updatedAt
The time at which the association between the agent and the knowledge base was last updated.
String description
The description of the knowledge base associated with an agent.
String knowledgeBaseId
The unique identifier of the knowledge base associated with an agent.
String knowledgeBaseState
Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
Date updatedAt
The time at which the knowledge base associated with an agent was last updated.
String agentId
The unique identifier of the agent.
String agentName
The name of the agent.
String agentStatus
The status of the agent.
String description
The description of the agent.
GuardrailConfiguration guardrailConfiguration
The details of the guardrails configuration in the agent summary.
String latestAgentVersion
The latest version of the agent.
Date updatedAt
The time at which the agent was last updated.
String agentArn
The Amazon Resource Name (ARN) of the agent that the version belongs to.
String agentId
The unique identifier of the agent that the version belongs to.
String agentName
The name of the agent that the version belongs to.
String agentResourceRoleArn
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
String agentStatus
The status of the agent that the version belongs to.
Date createdAt
The time at which the version was created.
String customerEncryptionKeyArn
The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
String description
The description of the version.
List<E> failureReasons
A list of reasons that the API operation on the version failed.
String foundationModel
The foundation model that the version invokes.
GuardrailConfiguration guardrailConfiguration
The guardrails configuration assigned to the agent version.
Integer idleSessionTTLInSeconds
The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
String instruction
The instructions provided to the agent.
PromptOverrideConfiguration promptOverrideConfiguration
Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
List<E> recommendedActions
A list of recommended actions to take for the failed API operation on the version to succeed.
Date updatedAt
The time at which the version was last updated.
String version
The version number.
String agentName
The name of the agent to which the version belongs.
String agentStatus
The status of the agent to which the version belongs.
String agentVersion
The version of the agent.
Date createdAt
The time at which the version was created.
String description
The description of the version of the agent.
GuardrailConfiguration guardrailConfiguration
The details of the guardrails configuration in the agent version summary.
Date updatedAt
The time at which the version was last updated.
String payload
The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
S3Identifier s3
Contains details about the S3 object containing the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
String agentId
The unique identifier of the agent with which you want to associate the knowledge base.
String agentVersion
The version of the agent with which you want to associate the knowledge base.
String description
A description of what the agent should use the knowledge base for.
String knowledgeBaseId
The unique identifier of the knowledge base to associate with the agent.
String knowledgeBaseState
Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
AgentKnowledgeBase agentKnowledgeBase
Contains details about the knowledge base that has been associated with the agent.
Integer dimensions
The dimensions details for the vector configuration used on the Bedrock embeddings model.
String chunkingStrategy
Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source
that is returned when the knowledge base that it belongs to is queried. You have the following options for
chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting
them up such that each file corresponds to a chunk.
FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set
in the fixedSizeChunkingConfiguration.
NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to
pre-process your documents by splitting them into separate files.
FixedSizeChunkingConfiguration fixedSizeChunkingConfiguration
Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as
NONE, exclude this field.
ActionGroupExecutor 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.
String actionGroupName
The name to give the action group.
String actionGroupState
Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
String agentId
The unique identifier of the agent for which to create the action group.
String agentVersion
The version of the agent for which to create the action group.
APISchema 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.
String 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.
String description
A description of the action group.
FunctionSchema functionSchema
Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
String 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 the description, apiSchema, and
actionGroupExecutor 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.
AgentActionGroup agentActionGroup
Contains details about the action group that was created.
String agentAliasName
The name of the alias.
String agentId
The unique identifier of the agent.
String 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.
String description
A description of the alias of the agent.
List<E> routingConfiguration
Contains details about the routing configuration of the alias.
Map<K,V> tags
Any tags that you want to attach to the alias of the agent.
AgentAlias agentAlias
Contains details about the alias that was created.
String agentName
A name for the agent that you create.
String agentResourceRoleArn
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
String 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.
String customerEncryptionKeyArn
The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
String description
A description of the agent.
String foundationModel
The foundation model to be used for orchestration by the agent you create.
GuardrailConfiguration guardrailConfiguration
The unique Guardrail configuration assigned to the agent when it is created.
Integer idleSessionTTLInSeconds
The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
String instruction
Instructions that tell the agent what it should do and how it should interact with users.
PromptOverrideConfiguration promptOverrideConfiguration
Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
Map<K,V> tags
Any tags that you want to attach to the agent.
Agent agent
Contains details about the agent created.
String 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.
String dataDeletionPolicy
The data deletion policy assigned to the data source.
DataSourceConfiguration dataSourceConfiguration
Contains metadata about where the data source is stored.
String description
A description of the data source.
String knowledgeBaseId
The unique identifier of the knowledge base to which to add the data source.
String name
The name of the data source.
ServerSideEncryptionConfiguration serverSideEncryptionConfiguration
Contains details about the server-side encryption for the data source.
VectorIngestionConfiguration vectorIngestionConfiguration
Contains details about how to ingest the documents in the data source.
DataSource dataSource
Contains details about the data source.
String 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.
String description
A description of the knowledge base.
KnowledgeBaseConfiguration knowledgeBaseConfiguration
Contains details about the embeddings model used for the knowledge base.
String name
A name for the knowledge base.
String roleArn
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
StorageConfiguration storageConfiguration
Contains details about the configuration of the vector database used for the knowledge base.
Map<K,V> tags
Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.
KnowledgeBase knowledgeBase
Contains details about the knowledge base.
Date createdAt
The time at which the data source was created.
String dataDeletionPolicy
The data deletion policy for a data source.
DataSourceConfiguration dataSourceConfiguration
Contains details about how the data source is stored.
String dataSourceId
The unique identifier of the data source.
String description
The description of the data source.
List<E> failureReasons
The detailed reasons on the failure to delete a data source.
String knowledgeBaseId
The unique identifier of the knowledge base to which the data source belongs.
String name
The name of the data source.
ServerSideEncryptionConfiguration serverSideEncryptionConfiguration
Contains details about the configuration of the server-side encryption.
String status
The status of the data source. The following statuses are possible:
Available – The data source has been created and is ready for ingestion into the knowledge base.
Deleting – The data source is being deleted.
Date updatedAt
The time at which the data source was last updated.
VectorIngestionConfiguration vectorIngestionConfiguration
Contains details about how to ingest the documents in the data source.
S3DataSourceConfiguration s3Configuration
Contains details about the configuration of the S3 object containing the data source.
String type
The type of storage for the data source.
String dataSourceId
The unique identifier of the data source.
String description
The description of the data source.
String knowledgeBaseId
The unique identifier of the knowledge base to which the data source belongs.
String name
The name of the data source.
String status
The status of the data source.
Date updatedAt
The time at which the data source was last updated.
String actionGroupId
The unique identifier of the action group to delete.
String agentId
The unique identifier of the agent that the action group belongs to.
String agentVersion
The version of the agent that the action group belongs to.
Boolean skipResourceInUseCheck
By default, this value is false and deletion is stopped if the resource is in use. If you set it to
true, the resource will be deleted even if the resource is in use.
String agentId
The unique identifier of the agent that the version belongs to.
String agentVersion
The version of the agent to delete.
Boolean skipResourceInUseCheck
By default, this value is false and deletion is stopped if the resource is in use. If you set it to
true, the resource will be deleted even if the resource is in use.
String knowledgeBaseId
The unique identifier of the knowledge base to delete.
String agentId
The unique identifier of the agent from which to disassociate the knowledge base.
String agentVersion
The version of the agent from which to disassociate the knowledge base.
String knowledgeBaseId
The unique identifier of the knowledge base to disassociate.
BedrockEmbeddingModelConfiguration bedrockEmbeddingModelConfiguration
The vector configuration details on the Bedrock embeddings model.
AgentActionGroup agentActionGroup
Contains details about the action group.
AgentAlias agentAlias
Contains information about the alias.
String agentId
The unique identifier of the agent with which the knowledge base is associated.
String agentVersion
The version of the agent with which the knowledge base is associated.
String knowledgeBaseId
The unique identifier of the knowledge base associated with the agent.
AgentKnowledgeBase agentKnowledgeBase
Contains details about a knowledge base attached to an agent.
String agentId
The unique identifier of the agent.
Agent agent
Contains details about the agent.
AgentVersion agentVersion
Contains details about the version of the agent.
DataSource dataSource
Contains details about the data source.
IngestionJob ingestionJob
Contains details about the ingestion job.
String knowledgeBaseId
The unique identifier of the knowledge base for which to get information.
KnowledgeBase knowledgeBase
Contains details about the knowledge base.
Integer maximumLength
The maximum number of tokens to allow in the generated response.
List<E> stopSequences
A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
Float temperature
The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
Integer topK
While generating a response, the model determines the probability of the following token at each point of
generation. The value that you set for topK is the number of most-likely candidates from which the
model chooses the next token in the sequence. For example, if you set topK to 50, the model selects
the next token from among the top 50 most likely choices.
Float topP
While generating a response, the model determines the probability of the following token at each point of
generation. The value that you set for Top P determines the number of most-likely candidates from
which the model chooses the next token in the sequence. For example, if you set topP to 80, the
model only selects the next token from the top 80% of the probability distribution of next tokens.
String dataSourceId
The unique identifier of the ingested data source.
String description
The description of the ingestion job.
List<E> failureReasons
A list of reasons that the ingestion job failed.
String ingestionJobId
The unique identifier of the ingestion job.
String knowledgeBaseId
The unique identifier of the knowledge base to which the data source is being added.
Date startedAt
The time at which the ingestion job started.
IngestionJobStatistics statistics
Contains statistics about the ingestion job.
String status
The status of the ingestion job.
Date updatedAt
The time at which the ingestion job was last updated.
Long numberOfDocumentsDeleted
The number of source documents that was deleted.
Long numberOfDocumentsFailed
The number of source documents that failed to be ingested.
Long numberOfDocumentsScanned
The total number of source documents that were scanned. Includes new, updated, and unchanged documents.
Long numberOfMetadataDocumentsModified
The number of metadata files that were updated or deleted.
Long numberOfMetadataDocumentsScanned
The total number of metadata files that were scanned. Includes new, updated, and unchanged files.
Long numberOfModifiedDocumentsIndexed
The number of modified source documents in the data source that were successfully indexed.
Long numberOfNewDocumentsIndexed
The number of new source documents in the data source that were successfully indexed.
String dataSourceId
The unique identifier of the data source in the ingestion job.
String description
The description of the ingestion job.
String ingestionJobId
The unique identifier of the ingestion job.
String knowledgeBaseId
The unique identifier of the knowledge base to which the data source is added.
Date startedAt
The time at which the ingestion job was started.
IngestionJobStatistics statistics
Contains statistics for the ingestion job.
String status
The status of the ingestion job.
Date updatedAt
The time at which the ingestion job was last updated.
Date createdAt
The time at which the knowledge base was created.
String description
The description of the knowledge base.
List<E> failureReasons
A list of reasons that the API operation on the knowledge base failed.
String knowledgeBaseArn
The Amazon Resource Name (ARN) of the knowledge base.
KnowledgeBaseConfiguration knowledgeBaseConfiguration
Contains details about the embeddings configuration of the knowledge base.
String knowledgeBaseId
The unique identifier of the knowledge base.
String name
The name of the knowledge base.
String roleArn
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
String status
The status of the knowledge base. The following statuses are possible:
CREATING – The knowledge base is being created.
ACTIVE – The knowledge base is ready to be queried.
DELETING – The knowledge base is being deleted.
UPDATING – The knowledge base is being updated.
FAILED – The knowledge base API operation failed.
StorageConfiguration storageConfiguration
Contains details about the storage configuration of the knowledge base.
Date updatedAt
The time at which the knowledge base was last updated.
String type
The type of data that the data source is converted into for the knowledge base.
VectorKnowledgeBaseConfiguration vectorKnowledgeBaseConfiguration
Contains details about the embeddings model that'sused to convert the data source.
String description
The description of the knowledge base.
String knowledgeBaseId
The unique identifier of the knowledge base.
String name
The name of the knowledge base.
String status
The status of the knowledge base.
Date updatedAt
The time at which the knowledge base was last updated.
String agentId
The unique identifier of the agent.
String agentVersion
The version of the agent.
Integer maxResults
The maximum number of results to return in the response. If the total number of results is greater than this
value, use the token returned in the response in the nextToken field when making another request to
return the next batch of results.
String nextToken
If the total number of results is greater than the maxResults value provided in the request, enter
the token returned in the nextToken field in the response in this field to return the next batch of
results.
List<E> actionGroupSummaries
A list of objects, each of which contains information about an action group.
String nextToken
If the total number of results is greater than the maxResults value provided in the request, use
this token when making another request in the nextToken field to return the next batch of results.
String agentId
The unique identifier of the agent.
Integer maxResults
The maximum number of results to return in the response. If the total number of results is greater than this
value, use the token returned in the response in the nextToken field when making another request to
return the next batch of results.
String nextToken
If the total number of results is greater than the maxResults value provided in the request, enter
the token returned in the nextToken field in the response in this field to return the next batch of
results.
List<E> agentAliasSummaries
A list of objects, each of which contains information about an alias of the agent.
String nextToken
If the total number of results is greater than the maxResults value provided in the request, use
this token when making another request in the nextToken field to return the next batch of results.
String agentId
The unique identifier of the agent for which to return information about knowledge bases associated with it.
String agentVersion
The version of the agent for which to return information about knowledge bases associated with it.
Integer maxResults
The maximum number of results to return in the response. If the total number of results is greater than this
value, use the token returned in the response in the nextToken field when making another request to
return the next batch of results.
String nextToken
If the total number of results is greater than the maxResults value provided in the request, enter
the token returned in the nextToken field in the response in this field to return the next batch of
results.
List<E> agentKnowledgeBaseSummaries
A list of objects, each of which contains information about a knowledge base associated with the agent.
String nextToken
If the total number of results is greater than the maxResults value provided in the request, use
this token when making another request in the nextToken field to return the next batch of results.
Integer maxResults
The maximum number of results to return in the response. If the total number of results is greater than this
value, use the token returned in the response in the nextToken field when making another request to
return the next batch of results.
String nextToken
If the total number of results is greater than the maxResults value provided in the request, enter
the token returned in the nextToken field in the response in this field to return the next batch of
results.
List<E> agentSummaries
A list of objects, each of which contains information about an agent.
String nextToken
If the total number of results is greater than the maxResults value provided in the request, use
this token when making another request in the nextToken field to return the next batch of results.
String agentId
The unique identifier of the agent.
Integer maxResults
The maximum number of results to return in the response. If the total number of results is greater than this
value, use the token returned in the response in the nextToken field when making another request to
return the next batch of results.
String nextToken
If the total number of results is greater than the maxResults value provided in the request, enter
the token returned in the nextToken field in the response in this field to return the next batch of
results.
List<E> agentVersionSummaries
A list of objects, each of which contains information about a version of the agent.
String nextToken
If the total number of results is greater than the maxResults value provided in the request, use
this token when making another request in the nextToken field to return the next batch of results.
String knowledgeBaseId
The unique identifier of the knowledge base for which to return a list of information.
Integer maxResults
The maximum number of results to return in the response. If the total number of results is greater than this
value, use the token returned in the response in the nextToken field when making another request to
return the next batch of results.
String nextToken
If the total number of results is greater than the maxResults value provided in the request, enter
the token returned in the nextToken field in the response in this field to return the next batch of
results.
List<E> dataSourceSummaries
A list of objects, each of which contains information about a data source.
String nextToken
If the total number of results is greater than the maxResults value provided in the request, use
this token when making another request in the nextToken field to return the next batch of results.
String dataSourceId
The unique identifier of the data source for which to return ingestion jobs.
List<E> filters
Contains a definition of a filter for which to filter the results.
String knowledgeBaseId
The unique identifier of the knowledge base for which to return ingestion jobs.
Integer maxResults
The maximum number of results to return in the response. If the total number of results is greater than this
value, use the token returned in the response in the nextToken field when making another request to
return the next batch of results.
String nextToken
If the total number of results is greater than the maxResults value provided in the request, enter
the token returned in the nextToken field in the response in this field to return the next batch of
results.
IngestionJobSortBy sortBy
Contains details about how to sort the results.
List<E> ingestionJobSummaries
A list of objects, each of which contains information about an ingestion job.
String nextToken
If the total number of results is greater than the maxResults value provided in the request, use
this token when making another request in the nextToken field to return the next batch of results.
Integer maxResults
The maximum number of results to return in the response. If the total number of results is greater than this
value, use the token returned in the response in the nextToken field when making another request to
return the next batch of results.
String nextToken
If the total number of results is greater than the maxResults value provided in the request, enter
the token returned in the nextToken field in the response in this field to return the next batch of
results.
List<E> knowledgeBaseSummaries
A list of objects, each of which contains information about a knowledge base.
String nextToken
If the total number of results is greater than the maxResults value provided in the request, use
this token when making another request in the nextToken field to return the next batch of results.
String resourceArn
The Amazon Resource Name (ARN) of the resource for which to list tags.
String collectionName
The collection name of the knowledge base in MongoDB Atlas.
String credentialsSecretArn
The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.
String databaseName
The database name in your MongoDB Atlas cluster for your knowledge base.
String endpoint
The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
String endpointServiceName
The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
MongoDbAtlasFieldMapping fieldMapping
Contains the names of the fields to which to map information about the vector store.
String vectorIndexName
The name of the MongoDB Atlas vector search index.
String metadataField
The name of the field in which Amazon Bedrock stores metadata about the vector store.
String textField
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
String vectorField
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
String collectionArn
The Amazon Resource Name (ARN) of the OpenSearch Service vector store.
OpenSearchServerlessFieldMapping fieldMapping
Contains the names of the fields to which to map information about the vector store.
String vectorIndexName
The name of the vector store.
String metadataField
The name of the field in which Amazon Bedrock stores metadata about the vector store.
String textField
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
String vectorField
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
String description
A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
Boolean required
Whether the parameter is required for the agent to complete the function for action group invocation.
String type
The data type of the parameter.
String connectionString
The endpoint URL for your index management page.
String credentialsSecretArn
The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.
PineconeFieldMapping fieldMapping
Contains the names of the fields to which to map information about the vector store.
String namespace
The namespace to be used to write new data to your database.
String agentId
The unique identifier of the agent for which to create a DRAFT version.
String agentId
The unique identifier of the agent for which the DRAFT version was created.
String agentStatus
The status of the DRAFT version and whether it is ready for use.
String agentVersion
The version of the agent.
Date preparedAt
The time at which the DRAFT version of the agent was last prepared.
String basePromptTemplate
Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.
InferenceConfiguration inferenceConfiguration
Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence
defined by the promptType. For more information, see Inference parameters for
foundation models.
String parserMode
Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in
the part of the agent sequence defined by the promptType. If you set the field as
OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
String promptCreationMode
Specifies whether to override the default prompt template for this promptType. Set this value to
OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave
it as DEFAULT, the agent uses a default prompt template.
String promptState
Specifies whether to allow the agent to carry out the step specified in the promptType. If you set
this value to DISABLED, the agent skips that step. The default state for each
promptType is as follows.
PRE_PROCESSING – ENABLED
ORCHESTRATION – ENABLED
KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
POST_PROCESSING – DISABLED
String promptType
The step in the agent sequence that this prompt configuration applies to.
String overrideLambda
The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent
sequence. If you specify this field, at least one of the promptConfigurations must contain a
parserMode value that is set to OVERRIDDEN. For more information, see Parser Lambda function in Agents
for Amazon Bedrock.
List<E> promptConfigurations
Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
String credentialsSecretArn
The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.
String databaseName
The name of your Amazon RDS database.
RdsFieldMapping fieldMapping
Contains the names of the fields to which to map information about the vector store.
String resourceArn
The Amazon Resource Name (ARN) of the vector store.
String tableName
The name of the table in the database.
String metadataField
The name of the field in which Amazon Bedrock stores metadata about the vector store.
String primaryKeyField
The name of the field in which Amazon Bedrock stores the ID for each entry.
String textField
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
String vectorField
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
String credentialsSecretArn
The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.
String endpoint
The endpoint URL of the Redis Enterprise Cloud database.
RedisEnterpriseCloudFieldMapping fieldMapping
Contains the names of the fields to which to map information about the vector store.
String vectorIndexName
The name of the vector index.
String metadataField
The name of the field in which Amazon Bedrock stores metadata about the vector store.
String textField
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
String vectorField
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
String bucketArn
The Amazon Resource Name (ARN) of the bucket that contains the data source.
String bucketOwnerAccountId
The bucket account owner ID for the S3 bucket.
List<E> inclusionPrefixes
A list of S3 prefixes that define the object containing the data sources. For more information, see Organizing objects using prefixes.
String kmsKeyArn
The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.
String 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.
String dataSourceId
The unique identifier of the data source to ingest.
String description
A description of the ingestion job.
String knowledgeBaseId
The unique identifier of the knowledge base to which to add the data source.
IngestionJob ingestionJob
An object containing information about the ingestion job.
MongoDbAtlasConfiguration mongoDbAtlasConfiguration
Contains the storage configuration of the knowledge base in MongoDB Atlas.
OpenSearchServerlessConfiguration opensearchServerlessConfiguration
Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
PineconeConfiguration pineconeConfiguration
Contains the storage configuration of the knowledge base in Pinecone.
RdsConfiguration rdsConfiguration
Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
RedisEnterpriseCloudConfiguration redisEnterpriseCloudConfiguration
Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.
String type
The vector store service in which the knowledge base is stored.
ActionGroupExecutor actionGroupExecutor
The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
String actionGroupId
The unique identifier of the action group.
String actionGroupName
Specifies a new name for the action group.
String actionGroupState
Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
String agentId
The unique identifier of the agent for which to update the action group.
String agentVersion
The unique identifier of the agent version for which to update the action group.
APISchema 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.
String description
Specifies a new name for the action group.
FunctionSchema functionSchema
Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
String 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 the description, apiSchema, and
actionGroupExecutor 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.
AgentActionGroup agentActionGroup
Contains details about the action group that was updated.
String agentAliasId
The unique identifier of the alias.
String agentAliasName
Specifies a new name for the alias.
String agentId
The unique identifier of the agent.
String description
Specifies a new description for the alias.
List<E> routingConfiguration
Contains details about the routing configuration of the alias.
AgentAlias agentAlias
Contains details about the alias that was updated.
String agentId
The unique identifier of the agent associated with the knowledge base that you want to update.
String agentVersion
The version of the agent associated with the knowledge base that you want to update.
String description
Specifies a new description for the knowledge base associated with an agent.
String knowledgeBaseId
The unique identifier of the knowledge base that has been associated with an agent.
String knowledgeBaseState
Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
AgentKnowledgeBase agentKnowledgeBase
Contains details about the knowledge base that has been associated with an agent.
String agentId
The unique identifier of the agent.
String agentName
Specifies a new name for the agent.
String agentResourceRoleArn
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
String customerEncryptionKeyArn
The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
String description
Specifies a new description of the agent.
String foundationModel
Specifies a new foundation model to be used for orchestration by the agent.
GuardrailConfiguration guardrailConfiguration
The unique Guardrail configuration assigned to the agent when it is updated.
Integer idleSessionTTLInSeconds
The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
String instruction
Specifies new instructions that tell the agent what it should do and how it should interact with users.
PromptOverrideConfiguration promptOverrideConfiguration
Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
Agent agent
Contains details about the agent that was updated.
String dataDeletionPolicy
The data deletion policy of the updated data source.
DataSourceConfiguration dataSourceConfiguration
Contains details about the storage configuration of the data source.
String dataSourceId
The unique identifier of the data source.
String description
Specifies a new description for the data source.
String knowledgeBaseId
The unique identifier of the knowledge base to which the data source belongs.
String name
Specifies a new name for the data source.
ServerSideEncryptionConfiguration serverSideEncryptionConfiguration
Contains details about server-side encryption of the data source.
VectorIngestionConfiguration vectorIngestionConfiguration
Contains details about how to ingest the documents in the data source.
DataSource dataSource
Contains details about the data source.
String description
Specifies a new description for the knowledge base.
KnowledgeBaseConfiguration knowledgeBaseConfiguration
Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.
String knowledgeBaseId
The unique identifier of the knowledge base to update.
String name
Specifies a new name for the knowledge base.
String roleArn
Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
StorageConfiguration storageConfiguration
Specifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.
KnowledgeBase knowledgeBase
Contains details about the knowledge base.
ChunkingConfiguration chunkingConfiguration
Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
String embeddingModelArn
The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
EmbeddingModelConfiguration embeddingModelConfiguration
The embeddings model configuration details for the vector model used in Knowledge Base.
Copyright © 2024. All rights reserved.