Created
December 18, 2025 09:12
-
-
Save engalar/6c2357bced7b02cf3eaa7df7e5609cdc to your computer and use it in GitHub Desktop.
domain_and_mf
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| DOMAIN ANALYSIS: AmazonBedrockConnector | |
| ------------------------------------------------------------ | |
| Entities (117 found): | |
| [Entity] ListFoundationModelsResponse [Non-Persistable] // This entity is the response for the Amazon Bedrock ListFoundationalModels action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListFoundationModels.html | |
| [Entity] InvokeModelRequest [Non-Persistable] extends AWSAuthentication.AbstractRequest // This entity is the request for the Amazon Bedrock InvokeModel action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_InvokeModel.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockruntime/model/InvokeModelRequest.html | |
| - ModelID: String[Unlimited] // The ModelID attribute describes identifier of the model and is a required parameter. | |
| - RequestBody: String[Unlimited] // The RequestBody attribute describes the JSON request body of the specific model to invoke and is a required parameter. | |
| [Entity] InvokeModelResponse [Non-Persistable] // This entity is the response for the Amazon Bedrock InvokeModel action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_InvokeModel.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockruntime/model/InvokeModelResponse.html | |
| - ResponseBody: String[Unlimited] // The ResponseBody attribute holds the JSON response body of the specific model. | |
| [Entity] FoundationModelSummary [Non-Persistable] // This entity contains details (ModelArn & ModelId) of the requested foundational models. | |
| - ModelARN: String[Unlimited] // The ARN (Amazon Resource Name) that identifies the foundational model (string). | |
| - ModelID: String[Unlimited] // ID assigned by Amazon Bedrock to their specific foundational models and is used to invoke the model in question (string). | |
| - ModelName: String[Unlimited] // The name of the foundational model. | |
| - ProviderName: String[Unlimited] // The provider name of the foundational model. | |
| - ResponseStreamingSupported: Boolean = false // The ResponseStreamingSupported attribute indicates whether the model supports streaming. | |
| [Entity] ListFoundationModelsRequest [Non-Persistable] extends AWSAuthentication.AbstractRequest // This entity is the request for the Amazon Bedrock ListFoundationModels action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListFoundationModels.html\n\nJava SDK:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrock/model/ListFoundationModelsRequest.html | |
| - ByCustomizationType: Enumeration[AmazonBedrockConnector.ENUM_CustomizationType] // To filter the received foundation models by customization type. | |
| - ByInferenceType: Enumeration[AmazonBedrockConnector.ENUM_InferenceType] // To filter the received foundation models by inference type. | |
| - ByOutputModality: Enumeration[AmazonBedrockConnector.ENUM_InputOutputModality] // To filter the received foundation models by output modality type. | |
| - ByProvider: String[Unlimited] // To filter the received foundation models by an Amazon Bedrock model provider. | |
| [Entity] RetrieveRequest_Extension [Non-Persistable] extends AWSAuthentication.AbstractRequest // This entity is the request for the Amazon Bedrock Retrieve action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html\n\nJava SDK documentation:\nhttps://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/bedrockagentruntime/model/RetrieveRequest.html | |
| - KnowledgeBaseId: String[Unlimited] // The KnowledgeBaseId attribute describes the unique identifier of the knowledge base to query and is a required parameter. | |
| - NextToken: String[Unlimited] // The NextToken attribute describes if there are more results than can fit in the response, the response returns a nextToken.\n\nUse this token in the nextToken field of another request to retrieve the next batch of results. | |
| [Entity] StartIngestionJobRequest [Non-Persistable] extends AWSAuthentication.AbstractRequest // This entity is the request for the Amazon Bedrock StartIngestionJob action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_StartIngestionJob.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockruntime/model/StartIngestionJob.html | |
| - DataSourceId: String[Unlimited] // The unique identifier of the data source to ingest. | |
| - KnowledgeBaseId: String[Unlimited] // The unique identifier of the knowledge base to which to add the data source. | |
| - ClientToken: String[Unlimited] | |
| - Description: String[Unlimited] | |
| [Entity] RetrieveAndGenerateRequest_Extension [Non-Persistable] extends AWSAuthentication.AbstractRequest // This entity is the request for the Amazon Bedrock RetrieveAndGenerate action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/RetrieveAndGenerateRequest.html\n\n | |
| - KmsKeyARN: String[Unlimited] // The KMSKeyArn attribute describes the ARN of the AWS KMS key encrypting the session. | |
| - RetrieveAndGenerateType: Enumeration[AmazonBedrockConnector.ENUM_RetrieveAndGenerateType] // The RetrieveAndGenerateType describes the type of resource that is queried by the request. The only supported value currently is "KNOWLEDGE_BASE" | |
| - PromptTemplate: String[Unlimited] // This is the custom knowledge base prompt template that allows you to replace the default prompt tempate with your own. | |
| [Entity] RetrieveResponse [Non-Persistable] extends GenAICommons.Response // This entity is the response for the Amazon Bedrock Retrieve action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/RetrieveResponse.html | |
| - NextToken: String[Unlimited] // The NextToken attribute describes if there are more results than can fit in the response, the response returns a nextToken.\n\nUse this token in the nextToken field of another request to retrieve the next batch of results. | |
| [Entity] GetIngestionJobRequest [Non-Persistable] extends AWSAuthentication.AbstractRequest // This entity is the request for the Amazon Bedrock GetIngestionJob action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetIngestionJob.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockruntime/model/GetIngestionJob.html | |
| - DataSourceId: String[Unlimited] // The unique identifier of the data source to ingest. | |
| - IngestionJobId: String[Unlimited] // The unique identifier of the ingestion job to retrieve. | |
| - KnowledgeBaseId: String[Unlimited] // The unique identifier of the knowledge base to which to add the data source. | |
| [Entity] RetrievalConfiguration [Non-Persistable] // This entity holds information about how the results should be returned.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_KnowledgeBaseRetrievalConfiguration.html\n\nJava SDK documentation:\nhttps://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/bedrockagentruntime/model/KnowledgeBaseRetrievalConfiguration.html | |
| - NumberOfResults: Integer // The NumberOfResults attribute describes the number of results to return. | |
| [Entity] RetrievalResult [Non-Persistable] extends GenAICommons.Reference // This entity holds information about a result from querying the knowledge base.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_KnowledgeBaseRetrievalResult.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/KnowledgeBaseRetrievalResult.html | |
| - Score: Decimal // The Score attribute describes the level of relevance of the result to the query. | |
| [Entity] RetrieveAndGenerateResponse [Non-Persistable] extends GenAICommons.Response // This entity is the response for the Amazon Bedrock RetrieveAndGenerate action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/RetrieveAndGenerateResponse.html | |
| [Entity] Location [Non-Persistable] // This entity holds information about the location of the data source.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrievalResultLocation.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/RetrievalResultLocation.html | |
| - DataSourceType: Enumeration[AmazonBedrockConnector.ENUM_DataSourceType] // The DataSourceType attribute describes the type of the location of the data source. | |
| [Entity] S3Location [Non-Persistable] // This entity holds information about the S3 location of the data source.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrievalResultS3Location.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/RetrievalResultS3Location.html | |
| - URI: String[Unlimited] // The URI attribute describes the S3 URI of the data source. | |
| [Entity] IngestionJob [Non-Persistable] // This entity holds information about an IngestionJob.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_IngestionJob.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/IngestionJob.html | |
| - Description: String[Unlimited] // The description of the ingestion job. | |
| - DataSourceId: String[Unlimited] // The unique identifier of the ingested data source. | |
| - IngestionJobId: String[Unlimited] // The unique identifier of the ingestion job. | |
| - KnowledgeBaseId: String[Unlimited] // The unique identifier of the knowledge base to which the data source is being added. | |
| - Status: Enumeration[AmazonBedrockConnector.ENUM_IngestionJobStatus] // The status of the ingestion job.\n\nValid Values: STARTING | IN_PROGRESS | COMPLETE | FAILED | |
| - StartedAt: DateTime[UTC] // The time at which the ingestion job started. | |
| - UpdatedAt: DateTime[UTC] // The time at which the ingestion job was last updated. | |
| [Entity] ListKnowledgeBasesRequest [Non-Persistable] extends AWSAuthentication.AbstractRequest // This entity is the request for the Amazon Bedrock ListKnowledgeBases action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListKnowledgeBases.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/ListKnowledgeBasesRequest.html | |
| - MaxResults: Integer // The MaxResults attribute describes the maximum number of results to return in the response. | |
| - NextToken: String[Unlimited] // 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. | |
| [Entity] FailureReason [Non-Persistable] // Contains information about the failure of the interaction. | |
| - Text: String[Unlimited] // The reason the interaction failed. | |
| [Entity] ListKnowledgeBasesResponse [Non-Persistable] // This entity is the response for the Amazon Bedrock ListKnowledgeBases action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListKnowledgeBases.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/ListKnowledgeBasesResponse.html | |
| - NextToken: String[Unlimited] // 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. | |
| [Entity] IngestionJobStats [Non-Persistable] // Contains information about the failure of the interaction. | |
| - numberOfDocumentsDeleted: Long // The number of documents that was deleted. | |
| - numberOfDocumentsFailed: Long // The number of documents that failed to be ingested. | |
| - numberOfDocumentsScanned: Long // The total number of documents that were scanned. | |
| - numberOfModifiedDocumentsIndexed: Long // The number of modified documents in the data source that were successfully indexed. | |
| - numberOfNewDocumentsIndexed: Long // The number of new documents in the data source that were successfully indexed. | |
| [Entity] KnowledgeBaseSummary [Non-Persistable] // The KnowledgeBaseSummary entity holds information about the details of a knowledge base.\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListKnowledgeBases.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/KnowledgeBaseSummary.html | |
| - KnowledgeBaseID: String[Unlimited] // The KnowledgeBaseID attribute describes the unique identifier of the knowledge base. | |
| - Name: String[Unlimited] // The Name attribute describes the name of the knowledge base. | |
| - Status: Enumeration[AmazonBedrockConnector.ENUM_KnowledgeBaseStatus] // The Status attribute describes the status of the knowledge base. | |
| - UpdatedAt: DateTime[Localized] // The UpdatedAt attribute describes the time at which the knowledge base was last updated. | |
| - Description: String[Unlimited] // The Description attribute describes the knowledge base. | |
| [Entity] StartIngestionJob [Non-Persistable] extends AmazonBedrockConnector.IngestionJob | |
| [Entity] GetIngestionJob [Non-Persistable] extends AmazonBedrockConnector.IngestionJob | |
| [Entity] StartIngestionJobResponse [Non-Persistable] // This entity is the response for the Amazon Bedrock StartIngestionJob action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_InvokeModel.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockruntime/model/InvokeModelResponse.html | |
| [Entity] GetIngestionJobResponse [Non-Persistable] // This entity is the response for the Amazon Bedrock GetIngestionJob action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_InvokeModel.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockruntime/model/InvokeModelResponse.html | |
| [Entity] SupportedCustomization [Non-Persistable] // This entity contains the customization type that the model supports. | |
| - CustomizationType: Enumeration[AmazonBedrockConnector.ENUM_CustomizationType] // The CustomizationType identifies the type of the customization. | |
| [Entity] SupportedInferenceType [Non-Persistable] // This entity contains the inference type that the model supports. | |
| - InferenceType: Enumeration[AmazonBedrockConnector.ENUM_InferenceType] // The InferenceType identifies the type of the inference. | |
| [Entity] InputModality [Non-Persistable] // This entity contains the input modality that the model supports. | |
| - InputModalityType: Enumeration[AmazonBedrockConnector.ENUM_InputOutputModality] // The InputModalityType identifies the type of the input modality. | |
| [Entity] FoundationModelLifecycle [Non-Persistable] // This entity contains details about whether a model version is available or deprecated. | |
| - Status: Enumeration[AmazonBedrockConnector.ENUM_ModelLifecycleStatus] // The Status attribute describes whether a model version is available (ACTIVE) or deprecated (LEGACY). | |
| [Entity] OutputModality [Non-Persistable] // This entity contains the output modality that the model supports. | |
| - OutputModalityType: Enumeration[AmazonBedrockConnector.ENUM_InputOutputModality] // The OutputModalityType identifies the type of the output modality. | |
| [Entity] InvokeAgentRequest [Non-Persistable] extends AWSAuthentication.AbstractRequest // The request body to invoke the agent.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/InvokeAgentRequest.html | |
| - InputText: String[Unlimited] // Atribute that holds the prompt text to send the agent. | |
| - AgentId: String[Unlimited] // Required attribute that holds the unique identifier of the agent to use. | |
| - AgentAliasId: String[Unlimited] // Required attribute holding the alias of the agent to use. | |
| - SessionId: String[Unlimited] // Required attribute that holds the unique identifier of the session. Use the same value across requests to continue the same conversation. | |
| - EnableTrace: Boolean = false // This boolean specifies whether to turn on the trace or not to track the agent's reasoning process.\n\nFind more information here: \nhttps://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events | |
| - EndSession: Boolean = false // Boolean that specifies whether to end the session with the agent or not. | |
| [Entity] GeneratedResponsePart [Non-Persistable] // The GeneratedResponsePart entity holds information about a part of the generated response that is accompanied by a citation.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_GeneratedResponsePart.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/GeneratedResponsePart.html | |
| - Text: String[Unlimited] // The Text attribute describes the part of the generated text that contains a citation. | |
| - Start: Integer // The Start attribute describes where the text with a citation starts in the generated output. | |
| - End: Integer // The End attribute describes where the text with a citation ends in the generated output. | |
| [Entity] InvokeAgentAttribute [Non-Persistable] // Generalization for orchestration of key value pairs | |
| - Key: String[Unlimited] | |
| - Value: String[Unlimited] | |
| [Entity] RetrievedReference [Non-Persistable] // The RetrievedReference entitiy holds information about a sources cited for the generated response.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrievedReference.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/RetrievedReference.html | |
| - Text: String[Unlimited] // The Text attribute contains the cited text from the data source. | |
| [Entity] SessionAttribute [Non-Persistable] extends AmazonBedrockConnector.InvokeAgentAttribute // Contains attributes relevant to the session and their values.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_SessionState.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/SessionState.html | |
| [Entity] Citation [Non-Persistable] // The Citation entitiy contains a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Citation.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/Citation.html | |
| [Entity] PromptSessionAttribute [Non-Persistable] extends AmazonBedrockConnector.InvokeAgentAttribute // Contains attributes related to the prompt and their values.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_SessionState.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/SessionState.html | |
| [Entity] ReferenceLocation [Non-Persistable] extends AmazonBedrockConnector.Location | |
| [Entity] SessionState [Non-Persistable] // Contains parameters that specify various attributes of the session.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_SessionState.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/SessionState.html | |
| [Entity] InvokeAgentResponse [Non-Persistable] // Response object of invokeAgent operation\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/InvokeAgentResponse.html | |
| - OutputText: String[Unlimited] // This corresponds to the 'bytes' part of the response. For convenience we handle it as text here. \n\nSee also\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_PayloadPart.html#bedrock-Type-agent-runtime_PayloadPart-bytes | |
| [Entity] InvokeAgentCitation [Non-Persistable] extends AmazonBedrockConnector.Citation // The Citation entitiy contains a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Citation.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/Citation.html | |
| [Entity] TracePart [Non-Persistable] // Generalization which contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see\n\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_TracePart.html and\nhttps://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement | |
| - AgentAliasId: String[Unlimited] // Same attribute as specified in the request. The attribute values should correspond.\n\nSee also:\nAPI Reference\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_TracePart.html#bedrock-Type-agent-runtime_TracePart-agentAliasId\n\nSDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/TracePart.html#agentAliasId() | |
| - Agentid: String[Unlimited] // Same attribute as specified in the request. The attribute values should correspond.\n\nSee also:\nAPI Reference\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_TracePart.html#bedrock-Type-agent-runtime_TracePart-agentId\n\nSDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/TracePart.html#agentId() | |
| - SessionId: String[Unlimited] // Same attribute as specified in the request. The attribute values should correspond.\n\nSee also:\nAPI Reference\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_TracePart.html#bedrock-Type-agent-runtime_TracePart-sessionId\n\nSDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/TracePart.html#sessionId() | |
| [Entity] AbstractTrace [Non-Persistable] // Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Trace.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/Trace.html | |
| - TraceId: String[Unlimited] // The unique identifier of the trace. | |
| - TraceType: Enumeration[AmazonBedrockConnector.ENUM_TraceType] // The type of trace. The following values are possible: failure, orchestration, preprocessing, postprocessing \n\nSee also:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Trace.html | |
| [Entity] FailureTrace [Non-Persistable] extends AmazonBedrockConnector.AbstractTrace // This entity contains information about the failure of the interaction.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_FailureTrace.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/FailureTrace.html\n\n | |
| - FailureReason: String[Unlimited] // The reason the interaction failed | |
| [Entity] PreProcessingModelInvocationOutput [Non-Persistable] extends AmazonBedrockConnector.AbstractTrace // The foundation model output from the pre-processing step.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_PreProcessingModelInvocationOutput.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/PreProcessingModelInvocationOutput.html | |
| - IsValid: Boolean = false // Attribute actually comes from entity PreProcessingParsedResponse. Specifies whether the user input is valid or not.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_PreProcessingParsedResponse.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/PreProcessingParsedResponse.html | |
| - Rationale: String[Unlimited] // The text returned by the parsing of the pre-processing step, explaining the steps that the agent plans to take in orchestration, if the user input is valid.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_PreProcessingParsedResponse.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/PreProcessingParsedResponse.html | |
| [Entity] InvocationInput [Non-Persistable] extends AmazonBedrockConnector.AbstractTrace // Contains information pertaining to the action group or knowledge base that is being invoked.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvocationInput.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/InvocationInput.html | |
| - InvocationType: Enumeration[AmazonBedrockConnector.ENUM_InvocationType] // Specifies whether the agent is invoking an action group or a knowledge base. | |
| [Entity] ActionGroupInvocationInput [Non-Persistable] // Contains information pertaining to the action group or knowledge base that is being invoked.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_ActionGroupInvocationInput.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/ActionGroupInvocationInput.html\n\n | |
| - ActionGroupName: String[Unlimited] // The name of the action group. | |
| - ApiPath: String[Unlimited] // The path to the API to call, based off the action group. | |
| - Verb: String[Unlimited] // The API method being used, based off the action group. | |
| [Entity] InvocationInputParameter [Non-Persistable] extends AmazonBedrockConnector.Parameter // The parameters in the Lambda input event.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Parameter.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/Parameter.html\n | |
| [Entity] RequestBodyContent [Non-Persistable] // The parameters in the request body for the Lambda input event.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RequestBody.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/RequestBody.html\n\n | |
| - ContentKey: String[Unlimited] // ContentKey as returned in the RequestBodyContent | |
| [Entity] Parameter [Non-Persistable] // Generalization for parameters of orchestration trace | |
| - Name: String[Unlimited] // The name of the parameter | |
| - _Type: String[Unlimited] // The type of the parameter | |
| - Value: String[Unlimited] // The value of the parameter | |
| [Entity] RequestBodyContentParameter [Non-Persistable] extends AmazonBedrockConnector.Parameter // A parameter in the Lambda input event (for the request body).\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Parameter.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/Parameter.html\n\n | |
| [Entity] PostProcessingModelInvocationInput [Non-Persistable] extends AmazonBedrockConnector.ModelInvocationInput // The foundation model input for the post-processing step.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_ModelInvocationInput.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/ModelInvocationInput.html | |
| [Entity] Rationale [Non-Persistable] extends AmazonBedrockConnector.AbstractTrace // Contains the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Rationale.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/Rationale.html | |
| - Text: String[Unlimited] // The reasoning or thought process of the agent, based on the input. | |
| [Entity] PostProcessingModelInvocationOutput [Non-Persistable] extends AmazonBedrockConnector.AbstractTrace // The foundation model output from the post-processing step.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_PostProcessingModelInvocationOutput.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/PostProcessingModelInvocationOutput.html | |
| - ParsedResponse: String[Unlimited] // Details about the response from the Lambda parsing of the output of the post-processing step. | |
| [Entity] PreProcessingModelInvocationInput [Non-Persistable] extends AmazonBedrockConnector.ModelInvocationInput // The foundation model input for the pre-processing step.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_ModelInvocationInput.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/ModelInvocationInput.html | |
| [Entity] OrchestrationModelInvocationInput [Non-Persistable] extends AmazonBedrockConnector.ModelInvocationInput // The input for the pre-processing step.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_ModelInvocationInput.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/ModelInvocationInput.html | |
| [Entity] Observation [Non-Persistable] extends AmazonBedrockConnector.AbstractTrace // Contains the result or output of an action group or knowledge base, or the response to the user.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/Observation.html | |
| - ActionGroupInvocationOutput: String[Unlimited] // Contains the JSON-formatted string returned by the API invoked by the action group. | |
| - FinalResponse: String[Unlimited] // Contains details about the response to the user. | |
| - ObservationType: Enumeration[AmazonBedrockConnector.ENUM_ObservationType] // Specifies what kind of information the agent returns in the observation. The following values are possible. | |
| [Entity] RepromptResponse [Non-Persistable] // Contains details about the agent's response to reprompt the input.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RepromptResource.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/RepromptResource.html | |
| - RepromptSource: Enumeration[AmazonBedrockConnector.ENUM_RepromptSource] // Specifies what output is prompting the agent to reprompt the input. | |
| - Text: String[Unlimited] // The text reprompting the input. | |
| [Entity] ObservationRetrievedReference [Non-Persistable] extends AmazonBedrockConnector.RetrievedReference // The RetrievedReference entity holds information about a sources cited for the generated response.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrievedReference.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/RetrievedReference.html | |
| [Entity] ModelInvocationInput [Non-Persistable] extends AmazonBedrockConnector.AbstractTrace // Contains parameters that specify the input to the pre- or post-processing step.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_ModelInvocationInput.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/ModelInvocationInput.html | |
| - OverrideLambda: String[Unlimited] // The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. | |
| - ParserMode: Enumeration[AmazonBedrockConnector.ENUM_CreationMode] // 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. | |
| - PromptCreationMode: Enumeration[AmazonBedrockConnector.ENUM_CreationMode] // Specifies whether the default prompt template was OVERRIDDEN. If it was, the basePromptTemplate that was set in the PromptOverrideConfiguration object when the agent was created or updated is used instead. | |
| - Text: String[Unlimited] // The text that prompted the agent at this step. | |
| - PromptType: Enumeration[AmazonBedrockConnector.ENUM_PromptType] // The step in the agent sequence. | |
| [Entity] KnowledgeBaseLookupInput [Non-Persistable] // Contains details about the knowledge base to look up and the query to be made.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_KnowledgeBaseLookupInput.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/KnowledgeBaseLookupInput.html | |
| - KnowledgeBaseId: String[Unlimited] // The unique identifier of the knowledge base to look up. | |
| - Text: String[Unlimited] // The query made to the knowledge base. | |
| [Entity] CitationRetrievedReference [Non-Persistable] extends AmazonBedrockConnector.RetrievedReference // The CitationRetrievedResponse entity holds information about the citation, which contains a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Citation.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/Citation.html | |
| [Entity] UserData [Non-Persistable] | |
| - PreferredCuisine: String[Unlimited] | |
| [Entity] Nonce [Persistable] | |
| - Value: String[Unlimited] | |
| - SessionId: String[Unlimited] | |
| [Entity] KnowledgeBaseTool [Non-Persistable] extends GenAICommons.Tool // This entity holds information about the specified knowledge base.\nIt can be added to the request using the "Request: Add Knowledge Base to Collection" operation from the toolbox. | |
| - KnowledgeBaseId: String[Length: 500] // The KnowledgeBaseId attribute describes the unique identifier of the knowledge base that is queried and the foundation model used for generation. | |
| [Entity] ChatCompletionsRequest_Extension [Non-Persistable] extends AWSAuthentication.AbstractRequest // This entity extends the GenAICommons.Request entity and is used for the ChatCompletions operation.\nThis operation is based on the Converse API for Amazon Bedrock:\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockruntime/BedrockRuntimeClient.html#converse(software.amazon.awssdk.services.bedrockruntime.model.ConverseRequest) | |
| [Entity] CohereEmbedOptions_Extension [Non-Persistable] // Extends the GenAICommons.EmbeddingsOptions object with attributes specific to Cohere Embed. | |
| - InputType: Enumeration[AmazonBedrockConnector.ENUM_InputType_CohereEmbed] // Prepends special tokens to differentiate each type from one another. Available options are \n\n- search_document – In search use-cases, use search_document when you encode documents for embeddings that you store in a vector database.\n\n- search_query – Use search_query when querying your vector DB to find relevant documents.\n\n- classification – Use classification when using embeddings as an input to a text classifier.\n\n- clustering – Use clustering to cluster the embeddings. | |
| - EmbeddingTypes: Enumeration[AmazonBedrockConnector.ENUM_EmbeddingTypes_CohereEmbed] // Specifies the types of embeddings you want to have returned. Optional and default is None, which returns the Embed Floats response type. Can be one or more of the following types:\n\nfloat – Use this value to return the default float embeddings.\n\nint8 – Use this value to return signed int8 embeddings.\n\nuint8 – Use this value to return unsigned int8 embeddings.\n\nbinary – Use this value to return signed binary embeddings.\n\nubinary – Use this value to return unsigned binary embeddings. | |
| - Truncate: Enumeration[AmazonBedrockConnector.ENUM_Truncate_CohereEmbed] // Specifies how the API handles inputs longer than the maximum token length. Use one of the following:\n\nNONE – (Default) Returns an error when the input exceeds the maximum input token length.\n\nSTART – Discards the start of the input.\n\nEND – Discards the end of the input. | |
| [Entity] AbstractRequestParameter [Non-Persistable] // Use a specialization of this entity to send an additional model-specific request parameter as part of the request. | |
| - Key: String[Length: 200] // The Key attribute describes the identifier of the additional model-specific request parameter. | |
| [Entity] TitanImageOptions_Extension [Non-Persistable] // This entity extends the GenAICommons.Request entity with attributes that are specific to the Titan Image model family. | |
| - NegativeText: String[Unlimited] // The NegativeText attribute describes a text prompt to define what not to include in the image. | |
| [Entity] StringRequestParameter [Non-Persistable] extends AmazonBedrockConnector.AbstractRequestParameter // Use this entity to send an additional model-specific request parameter with a string value. | |
| - Value: String[Unlimited] // The Value attribute describes the value of the additional model-specific request parameter. | |
| [Entity] CohereEmbedResponse [Non-Persistable] extends GenAICommons.EmbeddingsResponse // Extends the EmbeddingsResponse object with attributes specific to Cohere Embed. | |
| - ResponseType: String[Unlimited] // The response type. This value is always embeddings_floats. | |
| - _id: String[Unlimited] // An identifier for the response. Will not be filled when there is more than 96 text input chunks. | |
| [Entity] DecimalRequestParameter [Non-Persistable] extends AmazonBedrockConnector.AbstractRequestParameter // Use this entity to send an additional model-specific request parameter with a decimal value. | |
| - Value: Decimal // The Value attribute describes the value of the additional model-specific request parameter. | |
| [Entity] ListAgentsRequest [Non-Persistable] extends AWSAuthentication.AbstractRequest // This entity is the request for the Amazon Bedrock ListAgents action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListAgents.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/ListAgentsRequest.html | |
| - MaxResults: Integer // The MaxResults attribute describes the maximum number of results to return in the response. | |
| - NextToken: String[Unlimited] // 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. | |
| [Entity] ResponseFieldRequest [Non-Persistable] // The ResponseFieldRequest entity can be used to request a model-specific response field to be returned in addition to the information on the GenAICommons.Response entity. | |
| - FieldName: String[Length: 200] // The FieldName attribute describes the name of the additional response field that should be returned. | |
| [Entity] CohereEmbedMappingHelper [Non-Persistable] | |
| - InputType: Enumeration[AmazonBedrockConnector.ENUM_InputType_CohereEmbed] | |
| - Truncate: Enumeration[AmazonBedrockConnector.ENUM_Truncate_CohereEmbed] | |
| - EmbeddingTypes: Enumeration[AmazonBedrockConnector.ENUM_EmbeddingTypes_CohereEmbed] | |
| [Entity] IntegerRequestParameter [Non-Persistable] extends AmazonBedrockConnector.AbstractRequestParameter // Use this entity to send an additional model-specific request parameter with an integer value. | |
| - Value: Integer // The Value attribute describes the value of the additional model-specific request parameter. | |
| [Entity] TitanEmbeddingsOptions_Extension [Non-Persistable] // This entity extends the GenAICommons.EmbeddingsOptions with attributes specific for Titan Embeddings. | |
| - Normalize: Boolean = true // This boolean attribute specifies whether to normalize the output embeddings to unit vectors. It defaults to true. | |
| [Entity] RequestedResponseField [Non-Persistable] // This entity holds information about additional model-specific response fields. If valid additional response fields were requested during the request a list of this entity will be returned as part of the response. | |
| - Key: String[Length: 200] // The Key attribute describes the identifier of the requested additional model-specific response field. | |
| - Value: String[Unlimited] // The Value attribute describes the value of the requested additional model-specific response field. | |
| [Entity] TitanImageResponse [Non-Persistable] extends GenAICommons.Response // This entity inherits from the GenAICommons.Response entity and contains attributes that are specific to the Titan Image model family. | |
| - Error: String[Unlimited] // If the request violates the content moderation policy in one of the following situations, a message is returned in this field.\n-If the input text, image, or mask image is flagged by the content moderation policy.\n-If at least one output image is flagged by the content moderation policy | |
| [Entity] ChatCompletionsResponse [Non-Persistable] extends GenAICommons.Response | |
| - LatencyMs: Integer // The LatencyMs attribute describes the latency of the API call in milliseconds. | |
| [Entity] TitanEmbeddingsMappingHelper [Non-Persistable] // This is a helper entity that solely serves the purpose to simplify the export mapping. | |
| - Dimension: Integer | |
| - Normalize: Boolean = true | |
| - InputText: String[Unlimited] | |
| [Entity] ListAgentsResponse [Non-Persistable] // This entity is the response for the Amazon Bedrock ListAgents action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListAgents.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/ListAgentsResponse.html | |
| - NextToken: String[Unlimited] // 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. | |
| [Entity] TitanImageMappingHelper [Non-Persistable] // This entity is needed for the JSON export. \nDo not use. | |
| - Text: String[Unlimited] | |
| - NegativeText: String[Unlimited] | |
| [Entity] AgentSummary [Non-Persistable] // The AgentSummary entity holds information about the details of an agent.\n\nSee also:\n\nAPI Reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_AgentSummary.html\n\nJava SDK Documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/AgentSummary.html | |
| - AgentID: String[Unlimited] // The unique identifier of the agent. | |
| - AgentName: String[Unlimited] // The name of the agent. | |
| - AgentStatus: Enumeration[AmazonBedrockConnector.ENUM_AgentStatus] // The status of the agent. | |
| - Description: String[Unlimited] // The description of the agent. | |
| - LatestAgentVersion: String[Unlimited] // The latest version of the agent. | |
| - UpdatedAt: DateTime[Localized] // The time at which the agent was last updated. | |
| [Entity] GetAgentRequest [Non-Persistable] extends AWSAuthentication.AbstractRequest // This entity is the request for the Amazon Bedrock GetAgent action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgent.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/GetAgentRequest.html | |
| - AgentID: String[Unlimited] // The unique identifier of the agent. | |
| [Entity] GetAgentResponse [Non-Persistable] // This entity is the response for the Amazon Bedrock GetAgent action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgent.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/GetAgentResponse.html | |
| [Entity] Agent [Non-Persistable] // This entity contains details about an agent.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_Agent.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/Agent.html | |
| - AgentARN: String[Unlimited] // The Amazon Resource Name (ARN) of the agent. | |
| - AgentID: String[Length: 200] // The unique identifier of the agent. | |
| - AgentName: String[Unlimited] // The name of the agent. | |
| - AgentResourceRoleARN: String[Unlimited] // The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent. | |
| - AgentStatus: Enumeration[AmazonBedrockConnector.ENUM_AgentStatus] // The status of the agent. | |
| - AgentVersion: String[Unlimited] // The version of the agent. | |
| - CreatedAt: DateTime[Localized] // The time at which the agent was created. | |
| - IdleSessionTTLInSeconds: Integer // The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent. | |
| - UpdatedAt: DateTime[Localized] // The time at which the agent was last updated. | |
| - ClientToken: String[Unlimited] // 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. | |
| - CustomerEncryptionKeyArn: String[Unlimited] // The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the agent. | |
| - Description: String[Unlimited] // The description of the agent. | |
| - FoundationModel: String[Unlimited] // The foundation model used for orchestration by the agent. | |
| - Instruction: String[Unlimited] // Instructions that tell the agent what it should do and how it should interact with users. | |
| - PreparedAt: DateTime[Localized] // The time at which the agent was last prepared. | |
| [Entity] AgentFailureReason [Non-Persistable] // This entity contains the reasons that the agent-related API that you invoked failed. A new object is created for each reason. | |
| - Text: String[Unlimited] // Reason the agent-related API that you invoked failed. | |
| [Entity] RecommendedAction [Non-Persistable] // This entity contains the recommended actions to take for the agent-related API that you invoked to succeed. A new object is created for each recommended action. | |
| - Text: String[Unlimited] // Contains a recommended action to take for the agent-related API that you invoked to succeed. | |
| [Entity] AmazonBedrockAgent [Persistable] // This entity holds information about an Agent . \n\nThis entity is used as part of the 'Sync Metadata' operations. \nA new AmazonBedrockAgent object will be created for each Agent found in your AWS Account when syncing data.\n\nTo sync Agents to the database, use the 'Sync Agents' operation in the toolbox.\n | |
| - AgentID: String[Length: 200] // The unique identifier of the agent. | |
| - AgentName: String[Length: 200] // The name of the agent. | |
| - AgentStatus: Enumeration[AmazonBedrockConnector.ENUM_AgentStatus] // The status of the agent. | |
| - Description: String[Unlimited] // The description of the agent. | |
| - LatestAgentVersion: String[Length: 200] // The latest version of the agent. | |
| - UpdatedAt: DateTime[Localized] // The last time the agent has been updated. | |
| [Entity] AmazonBedrockRegion [Persistable] // This entity holds information about a AWS region. \n\nThis entity is used as part of the 'Sync Metadata' operations. \nA new AmazonBedrockRegion object will be created for each region you sync data in. | |
| - Region: Enumeration[AWSAuthentication.ENUM_Region] // The AWS Region identifier and location. | |
| [Entity] AmazonBedrockKnowledgeBase [Persistable] extends GenAICommons.DeployedKnowledgeBase // This entity holds information about a KnowledgeBase. \n\nThis entity is used as part of the 'Sync Metadata' operations. \nA new AmazonBedrockKnowledgeBase object will be created for each Knowledge Base found in your AWS Account when syncing data.\n\nTo sync Knowledge Bases to the database, use the 'Sync KnowledgeBases' operation in the toolbox. | |
| - KnowledgeBaseID: String[Length: 200] // The unique identifier of the knowledge base. | |
| - Status: Enumeration[AmazonBedrockConnector.ENUM_KnowledgeBaseStatus] // The status of the knowledge base. | |
| - UpdatedAt: DateTime[Localized] // The time at which the knowledge base was last updated. | |
| - Description: String[Unlimited] // The description of the knowledge base. | |
| [Entity] BedrockDeployedModel [Persistable] extends GenAICommons.DeployedModel // BedrockDeployedModel is a specialization of GenAICommons.DeployedModel and holds information about a Model. To make the operations more compatible and interchangeable with operations from other GenAI connectors based on the GenAI commons module, the operations technically accept DeployedModel objects, but internally required to be of the specialization BedrockDeployedModel.\n\nThis entity is used as part of the 'Sync Metadata' operations. \nA new BedrockDeployedModel object will be created for each Model found in your AWS Account when syncing data.\nTo sync Models to the database, use the 'Sync Models' operation in the toolbox. | |
| - ModelARN: String[Length: 200] // The AWS ARN of the model. | |
| - ModelName: String[Length: 200] // The name of the model. | |
| - ProviderName: String[Length: 200] // The name of the model provider (e.g. Anthropic, Meta, Cohere). | |
| - LifecycleStatus: Enumeration[AmazonBedrockConnector.ENUM_ModelLifecycleStatus] // The status of the model. | |
| - AvailableInCurrentRegion: Boolean = true // A boolean to specify if the model is currently available/usable in the region set in the Settings. | |
| - IsCustom: Boolean = false | |
| [Entity] ModelInferenceType [Persistable] // This entity holds information about an InferenceType. \n\nThis entity is used as part of the 'Sync Metadata' operations. \nInferenceType objects will be created when syncing models using the 'Sync Models' operation. | |
| - InferenceType: Enumeration[AmazonBedrockConnector.ENUM_InferenceType] // The type of availability of the model. | |
| [Entity] WebLocation [Non-Persistable] // This entity holds information about the Web location of the data source.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrievalResultWebLocation.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/model/RetrievalResultWebLocation.html | |
| - URL: String[Unlimited] // The URL of the web data source. | |
| [Entity] ListDataSourcesRequest [Non-Persistable] extends AWSAuthentication.AbstractRequest // This entity is the request for the Amazon Bedrock ListDataSources action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListDataSources.html\n\nJava SDK documentation\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/ListDataSourcesRequest.html | |
| - KnowledgeBaseId: String[Unlimited] // The identifier of the knowledge base for which to return a list of data sources. | |
| - MaxResults: Integer // The MaxResults attribute describes the maximum number of results to return in the response. | |
| - NextToken: String[Unlimited] // 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. | |
| [Entity] ListDataSourcesResponse [Non-Persistable] // This entity is the response for the Amazon Bedrock ListDataSources action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListDataSources.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/ListDataSourcesResponse.html | |
| - NextToken: String[Unlimited] // 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. | |
| [Entity] DataSourceSummary [Non-Persistable] // Contains details about a data source.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_DataSourceSummary.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/DataSourceSummary.html | |
| - DataSourceId: String[Unlimited] // The unique identifier of the data source. | |
| - KnowledgeBaseId: String[Unlimited] // The unique identifier of the knowledge base to which the data source belongs. | |
| - Name: String[Unlimited] // The name of the data source. | |
| - Status: Enumeration[AmazonBedrockConnector.ENUM_DataSourceStatus] // The status of the data source. | |
| - UpdatedAt: DateTime[Localized] // The time at which the data source was last updated. | |
| - Description: String[Unlimited] // The description of the data source. | |
| [Entity] DeleteDataSourceRequest [Non-Persistable] extends AWSAuthentication.AbstractRequest // This entity is the request for the Amazon Bedrock DeleteDataSource action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_DeleteDataSource.html\n\nJava SDK documentation\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/DeleteDataSourceRequest.html | |
| - KnowledgeBaseId: String[Unlimited] // The unique identifier of the knowledge base from which to delete the data source. | |
| - DataSourceId: String[Unlimited] // The unique identifier of the data source to delete. | |
| [Entity] DeleteDataSourceResponse [Non-Persistable] // This entity is the response for the Amazon Bedrock DeleteDataSource action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_DeleteDataSource.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/DeleteDataSourceResponse.html | |
| - DataSourceId: String[Unlimited] // The unique identifier of the data source that was deleted. | |
| - KnowledgeBaseId: String[Unlimited] // The unique identifier of the knowledge base to which the data source that was deleted belonged. | |
| - Status: Enumeration[AmazonBedrockConnector.ENUM_DataSourceStatus] // The status of the data source. | |
| [Entity] CreateDataSourceRequest [Non-Persistable] extends AWSAuthentication.AbstractRequest // This entity is the request for the Amazon Bedrock CreateDataSource action.\n\nCurrently it is supported for data source types S3 and Confluence.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateDataSource.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/CreateDataSourceRequest.html | |
| - KnowledgeBaseId: String[Unlimited] // The unique identifier of the knowledge base to which to add the data source. | |
| - Name: String[Unlimited] // The name of the data source. | |
| - Description: String[Unlimited] // A description of the data source. | |
| [Entity] DataSourceConfiguration [Non-Persistable] // The connection configuration for the data source.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_DataSourceConfiguration.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/DataSourceConfiguration.html | |
| - DataSourceType: Enumeration[AmazonBedrockConnector.ENUM_DataSourceType] // The type of data source. | |
| [Entity] ConfluenceDataSourceConfiguration [Non-Persistable] // The configuration information to connect to Confluence as your data source.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ConfluenceDataSourceConfiguration.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/ConfluenceDataSourceConfiguration.html | |
| [Entity] ConfluenceSourceConfiguration [Non-Persistable] // The endpoint information to connect to your Confluence data source.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ConfluenceSourceConfiguration.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/ConfluenceSourceConfiguration.html | |
| - AuthType: Enumeration[AmazonBedrockConnector.ENUM_ConfluenceAuthType] // The supported authentication type to authenticate and connect to your Confluence instance. | |
| - CredentialsSecretARN: String[Unlimited] // The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your Confluence instance URL. | |
| - HostType: Enumeration[AmazonBedrockConnector.ENUM_ConfluenceHostType] // The supported host type, whether online/cloud or server/on-premises. | |
| - HostURL: String[Unlimited] // The Confluence host URL or instance URL. | |
| [Entity] CreateDataSourceConfiguration [Non-Persistable] extends AmazonBedrockConnector.DataSourceConfiguration | |
| [Entity] CreateDataSourceResponse [Non-Persistable] extends AmazonBedrockConnector.DataSource // This entity is the response for the Amazon Bedrock CreateDataSource action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateDataSource.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/CreateDataSourceResponse.html | |
| [Entity] S3DataSourceConfiguration [Non-Persistable] // The configuration information to connect to Amazon S3 as your data source.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_S3DataSourceConfiguration.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/S3DataSourceConfiguration.html | |
| - BucketARN: String[Unlimited] // The Amazon Resource Name (ARN) of the S3 bucket that contains your data. | |
| - BucketOwnerAccountId: String[Unlimited] // The account ID for the owner of the S3 bucket. | |
| [Entity] SharePointDataSourceConfiguration [Non-Persistable] // The configuration information to connect to SharePoint as your data source.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_SharePointDataSourceConfiguration.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/SharePointDataSourceConfiguration.html | |
| [Entity] SharePointSourceConfiguration [Non-Persistable] // The endpoint information to connect to your SharePoint data source.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_SharePointSourceConfiguration.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/SharePointSourceConfiguration.html | |
| - AuthType: Enumeration[AmazonBedrockConnector.ENUM_SharePointAuthType] = OAUTH2_CLIENT_CREDENTIALS // The supported authentication type to authenticate and connect to your SharePoint site/sites. | |
| - CredentialsSecretArn: String[Unlimited] // The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your SharePoint site/sites. | |
| - Domain: String[Unlimited] // The domain of your SharePoint instance or site URL/URLs. | |
| - HostType: Enumeration[AmazonBedrockConnector.ENUM_SharePointHostType] // The supported host type, whether online/cloud or server/on-premises. | |
| - TenantId: String[Unlimited] // The identifier of your Microsoft 365 tenant. | |
| [Entity] Site [Non-Persistable] | |
| - SiteURL: String[Unlimited] // The SharePoint site URL. | |
| [Entity] DataSource [Non-Persistable] // Contains details about a data source.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_DataSource.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/DataSource.html | |
| - CreatedAt: DateTime[Localized] // The time at which the data source was created. | |
| - DataSourceId: String[Unlimited] // The unique identifier of the data source. | |
| - KnowledgeBaseId: String[Unlimited] // The unique identifier of the knowledge base to which the data source belongs. | |
| - Name: String[Unlimited] // The name of the data source. | |
| - Status: Enumeration[AmazonBedrockConnector.ENUM_DataSourceStatus] // The status of the data source. | |
| - UpdatedAt: DateTime[Localized] // The time at which the data source was last updated. | |
| - Description: String[Unlimited] // A description of the data source. | |
| [Entity] GetDataSourceRequest [Non-Persistable] extends AWSAuthentication.AbstractRequest // This entity is the request for the Amazon Bedrock GetDataSource action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetDataSource.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/GetDataSourceRequest.html | |
| - DataSourceId: String[Unlimited] // The unique identifier of the data source. | |
| - KnowledgeBaseId: String[Unlimited] // The unique identifier of the knowledge base for the data source. | |
| [Entity] GetDataSourceResponse [Non-Persistable] extends AmazonBedrockConnector.DataSource // This entity is the response for the Amazon Bedrock GetDataSource action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetDataSource.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/GetDataSourceResponse.html | |
| [Entity] ListIngestionJobsRequest [Non-Persistable] extends AWSAuthentication.AbstractRequest // This entity is the request for the Amazon Bedrock ListIngestionJobs action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListIngestionJobs.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/ListIngestionJobsRequest.html | |
| - DataSourceId: String[Unlimited] // The unique identifier of the data source for the list of data ingestion jobs. | |
| - KnowledgeBaseId: String[Unlimited] // The unique identifier of the knowledge base for the list of data ingestion jobs. | |
| - MaxResults: Integer // 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. | |
| - NextToken: String[Unlimited] // 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. | |
| [Entity] ListIngestionJobsResponse [Non-Persistable] // This entity is the response for the Amazon Bedrock ListIngestionJobs action.\n\nAPI reference:\nhttps://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListIngestionJobs.html\n\nJava SDK documentation:\nhttps://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/model/ListIngestionJobsResponse.html | |
| - NextToken: String[Unlimited] // 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. | |
| [Entity] IngestionJobSummary [Non-Persistable] extends AmazonBedrockConnector.IngestionJob | |
| [Entity] ComputerUseTool [Non-Persistable] extends AmazonBedrockConnector.AbstractRequestParameter | |
| Associations (Internal: 52, Cross: 8): | |
| CohereEmbedMappingHelper_CohereEmbedMappingHelper: AmazonBedrockConnector.CohereEmbedMappingHelper <-> AmazonBedrockConnector.CohereEmbedMappingHelper [Type:Reference | Owner:Default] | |
| TitanImageMappingHelper_TitanImageOptions_Extension: AmazonBedrockConnector.TitanImageMappingHelper <-> AmazonBedrockConnector.TitanImageOptions_Extension [Type:Reference | Owner:Default] | |
| AgentSummary_ListAgentsResponse: AmazonBedrockConnector.AgentSummary <-> AmazonBedrockConnector.ListAgentsResponse [Type:Reference | Owner:Default] | |
| Agent_GetAgentResponse: AmazonBedrockConnector.Agent <-> AmazonBedrockConnector.GetAgentResponse [Type:Reference | Owner:Both] | |
| AgentFailureReason_Agent: AmazonBedrockConnector.AgentFailureReason <-> AmazonBedrockConnector.Agent [Type:Reference | Owner:Default] | |
| RecommendedAction_Agent: AmazonBedrockConnector.RecommendedAction <-> AmazonBedrockConnector.Agent [Type:Reference | Owner:Default] | |
| ChatCompletionsRequest_Extension_AbstractRequestParameter: AmazonBedrockConnector.ChatCompletionsRequest_Extension <==> AmazonBedrockConnector.AbstractRequestParameter [Type:ReferenceSet | Owner:Default] | |
| ChatCompletionsRequest_Extension_ResponseFieldRequest: AmazonBedrockConnector.ChatCompletionsRequest_Extension <==> AmazonBedrockConnector.ResponseFieldRequest [Type:ReferenceSet | Owner:Default] | |
| RequestedResponseField_ChatCompletionsResponse: AmazonBedrockConnector.RequestedResponseField <-> AmazonBedrockConnector.ChatCompletionsResponse [Type:Reference | Owner:Default] | |
| FoundationModelSummary_ListFoundationModelsResponse: AmazonBedrockConnector.FoundationModelSummary <-> AmazonBedrockConnector.ListFoundationModelsResponse [Type:Reference | Owner:Default] | |
| RetrieveRequest_Extension_RetrievalConfiguration: AmazonBedrockConnector.RetrieveRequest_Extension <-> AmazonBedrockConnector.RetrievalConfiguration [Type:Reference | Owner:Both] | |
| Location_S3Location: AmazonBedrockConnector.S3Location <-> AmazonBedrockConnector.Location [Type:Reference | Owner:Both] | |
| FailureReason_IngestionJob: AmazonBedrockConnector.FailureReason <-> AmazonBedrockConnector.IngestionJob [Type:Reference | Owner:Default] | |
| KnowledgeBaseSummary_ListKnowledgeBasesResponse: AmazonBedrockConnector.KnowledgeBaseSummary <-> AmazonBedrockConnector.ListKnowledgeBasesResponse [Type:Reference | Owner:Default] | |
| IngestionJobStats_IngestionJob: AmazonBedrockConnector.IngestionJobStats <-> AmazonBedrockConnector.IngestionJob [Type:Reference | Owner:Both] | |
| StartIngestionJob_StartIngestionJobResponse: AmazonBedrockConnector.StartIngestionJob <-> AmazonBedrockConnector.StartIngestionJobResponse [Type:Reference | Owner:Both] | |
| GetIngestionJob_GetIngestionJobResponse: AmazonBedrockConnector.GetIngestionJob <-> AmazonBedrockConnector.GetIngestionJobResponse [Type:Reference | Owner:Both] | |
| SupportedCustomization_FoundationModelSummary: AmazonBedrockConnector.SupportedCustomization <-> AmazonBedrockConnector.FoundationModelSummary [Type:Reference | Owner:Default] | |
| SupportedInferenceType_FoundationModelSummary: AmazonBedrockConnector.SupportedInferenceType <-> AmazonBedrockConnector.FoundationModelSummary [Type:Reference | Owner:Default] | |
| InputModality_FoundationModelSummary: AmazonBedrockConnector.InputModality <-> AmazonBedrockConnector.FoundationModelSummary [Type:Reference | Owner:Default] | |
| FoundationModelLifecycle_FoundationModelSummary: AmazonBedrockConnector.FoundationModelLifecycle <-> AmazonBedrockConnector.FoundationModelSummary [Type:Reference | Owner:Both] | |
| OutputModality_FoundationModelSummary: AmazonBedrockConnector.OutputModality <-> AmazonBedrockConnector.FoundationModelSummary [Type:Reference | Owner:Default] | |
| SessionAttribute_SessionState: AmazonBedrockConnector.SessionAttribute <-> AmazonBedrockConnector.SessionState [Type:Reference | Owner:Default] | |
| GeneratedResponsePart_Citation: AmazonBedrockConnector.GeneratedResponsePart <-> AmazonBedrockConnector.Citation [Type:Reference | Owner:Both] | |
| PromptSessionAttribute_SessionState: AmazonBedrockConnector.PromptSessionAttribute <-> AmazonBedrockConnector.SessionState [Type:Reference | Owner:Default] | |
| SessionState_InvokeAgentRequest: AmazonBedrockConnector.SessionState <-> AmazonBedrockConnector.InvokeAgentRequest [Type:Reference | Owner:Both] | |
| ReferenceLocation_RetrievedReference: AmazonBedrockConnector.ReferenceLocation <-> AmazonBedrockConnector.RetrievedReference [Type:Reference | Owner:Both] | |
| InvokeAgentCitation_InvokeAgentResponse: AmazonBedrockConnector.InvokeAgentCitation <-> AmazonBedrockConnector.InvokeAgentResponse [Type:Reference | Owner:Default] | |
| TracePart_InvokeAgentResponse: AmazonBedrockConnector.TracePart <-> AmazonBedrockConnector.InvokeAgentResponse [Type:Reference | Owner:Default] | |
| AbstractTrace_TracePart: AmazonBedrockConnector.AbstractTrace <-> AmazonBedrockConnector.TracePart [Type:Reference | Owner:Both] | |
| ActionGroupInvocationInput_InvocationInput: AmazonBedrockConnector.ActionGroupInvocationInput <-> AmazonBedrockConnector.InvocationInput [Type:Reference | Owner:Both] | |
| RequestBodyContentParameter_RequestBodyContent: AmazonBedrockConnector.RequestBodyContentParameter <-> AmazonBedrockConnector.RequestBodyContent [Type:Reference | Owner:Default] | |
| RepromptResponse_Observation: AmazonBedrockConnector.RepromptResponse <-> AmazonBedrockConnector.Observation [Type:Reference | Owner:Both] | |
| ObservationRetrievedReference_Observation: AmazonBedrockConnector.ObservationRetrievedReference <-> AmazonBedrockConnector.Observation [Type:Reference | Owner:Default] | |
| RequestBodyContent_ActionGroupInvocationInput: AmazonBedrockConnector.RequestBodyContent <-> AmazonBedrockConnector.ActionGroupInvocationInput [Type:Reference | Owner:Default] | |
| InvocationInputParameter_ActionGroupInvocationInput: AmazonBedrockConnector.InvocationInputParameter <-> AmazonBedrockConnector.ActionGroupInvocationInput [Type:Reference | Owner:Default] | |
| KnowledgeBaseLookupInput_InvocationInput: AmazonBedrockConnector.KnowledgeBaseLookupInput <-> AmazonBedrockConnector.InvocationInput [Type:Reference | Owner:Both] | |
| CitationRetrievedReference_Citation: AmazonBedrockConnector.CitationRetrievedReference <-> AmazonBedrockConnector.Citation [Type:Reference | Owner:Default] | |
| AmazonBedrockAgent_AmazonBedrockRegion: AmazonBedrockConnector.AmazonBedrockAgent <-> AmazonBedrockConnector.AmazonBedrockRegion [Type:Reference | Owner:Default] | |
| BedrockDeployedModel_ModelInferenceType: AmazonBedrockConnector.BedrockDeployedModel <==> AmazonBedrockConnector.ModelInferenceType [Type:ReferenceSet | Owner:Default] | |
| WebLocation_Location: AmazonBedrockConnector.WebLocation <-> AmazonBedrockConnector.Location [Type:Reference | Owner:Both] | |
| DataSourceSummary_ListDataSourcesResponse: AmazonBedrockConnector.DataSourceSummary <-> AmazonBedrockConnector.ListDataSourcesResponse [Type:Reference | Owner:Default] | |
| ConfluenceDataSourceConfiguration_DataSourceConfiguration: AmazonBedrockConnector.ConfluenceDataSourceConfiguration <-> AmazonBedrockConnector.DataSourceConfiguration [Type:Reference | Owner:Both] | |
| ConfluenceSourceConfiguration_ConfluenceDataSourceConfiguration: AmazonBedrockConnector.ConfluenceSourceConfiguration <-> AmazonBedrockConnector.ConfluenceDataSourceConfiguration [Type:Reference | Owner:Both] | |
| CreateDataSourceConfiguration_CreateDataSourceRequest: AmazonBedrockConnector.CreateDataSourceConfiguration <-> AmazonBedrockConnector.CreateDataSourceRequest [Type:Reference | Owner:Both] | |
| S3DataSourceConfiguration_DataSourceConfiguration: AmazonBedrockConnector.S3DataSourceConfiguration <-> AmazonBedrockConnector.DataSourceConfiguration [Type:Reference | Owner:Both] | |
| SharePointSourceConfiguration_SharePointDataSourceConfiguration: AmazonBedrockConnector.SharePointSourceConfiguration <-> AmazonBedrockConnector.SharePointDataSourceConfiguration [Type:Reference | Owner:Both] | |
| SharePointDataSourceConfiguration_DataSourceConfiguration: AmazonBedrockConnector.SharePointDataSourceConfiguration <-> AmazonBedrockConnector.DataSourceConfiguration [Type:Reference | Owner:Both] | |
| Site_SharePointSourceConfiguration: AmazonBedrockConnector.Site <-> AmazonBedrockConnector.SharePointSourceConfiguration [Type:Reference | Owner:Default] | |
| DataSourceConfiguration_DataSource: AmazonBedrockConnector.DataSourceConfiguration <-> AmazonBedrockConnector.DataSource [Type:Reference | Owner:Both] | |
| IngestionJobSummary_ListIngestionJobsResponse: AmazonBedrockConnector.IngestionJobSummary <-> AmazonBedrockConnector.ListIngestionJobsResponse [Type:Reference | Owner:Default] | |
| ComputerUseTool_AbstractRequestParameter: AmazonBedrockConnector.ComputerUseTool <==> AmazonBedrockConnector.AbstractRequestParameter [Type:ReferenceSet | Owner:Default] | |
| Nonce_Session: AmazonBedrockConnector.Nonce <-> System.Session [Type:Reference | Owner:Default] | |
| RetrieveAndGenerateRequest_Extension_Request: AmazonBedrockConnector.RetrieveAndGenerateRequest_Extension <-> GenAICommons.Request [Type:Reference | Owner:Default] | |
| ChatCompletionsRequest_Extension_Request: AmazonBedrockConnector.ChatCompletionsRequest_Extension <-> GenAICommons.Request [Type:Reference | Owner:Default] | |
| CohereEmbedOptions_Extension_EmbeddingsOptions: AmazonBedrockConnector.CohereEmbedOptions_Extension <-> GenAICommons.EmbeddingsOptions [Type:Reference | Owner:Default] | |
| TitanImageOptions_Extension_ImageOptions: AmazonBedrockConnector.TitanImageOptions_Extension <-> GenAICommons.ImageOptions [Type:Reference | Owner:Default] | |
| CohereEmbedMappingHelper_ChunkCollection: AmazonBedrockConnector.CohereEmbedMappingHelper <-> GenAICommons.ChunkCollection [Type:Reference | Owner:Default] | |
| RetrieveRequest_Extension_Request: AmazonBedrockConnector.RetrieveRequest_Extension <-> GenAICommons.Request [Type:Reference | Owner:Default] | |
| TitanEmbeddingsOptions_Extension_EmbeddingsOptions: AmazonBedrockConnector.TitanEmbeddingsOptions_Extension <-> GenAICommons.EmbeddingsOptions [Type:Reference | Owner:Default] | |
| ============================================================ | |
| MICROFLOW ANALYSIS: Tool_SparqlConverter | |
| ------------------------------------------------------------ | |
| [StartEvent] | |
| [CreateVariableAction] $SystemPrompt = 'You are an expert SPARQL assistant. Your task is to generate valid, executable, and well-formatted SPARQL queries based on the user''s request and the provided ontology.\n\n### STRICT OUTPUT RULES:\n1. **Executable Code Only**: Return ONLY the SPARQL query. No explanations, no markdown code block fences (unless requested), no comments.\n2. **Formatting**: The SPARQL query must be **pretty-printed** (proper indentation for WHERE clauses and sub-patterns) for readability.\n3. **Syntax Compliance**:\n - **Prefixes**: URIs in PREFIX declarations MUST be enclosed in angle brackets `< >`.\n - **Quotes**: You must STRICTLY use standard **English (ASCII) double quotes** (`"`) for string literals. NEVER use Chinese quotes (`“` or `”`).\n - **Structure**: Always include PREFIX, SELECT, and WHERE clauses. Add `LIMIT` if the result set might be large.\n\n### Ontology Namespace and Schema:\n\n#### PREFIXES\nPREFIX assembly: <http://cambridgesemantics.com/SourceLayer/dd2b0d28f5ed4f5c848d978e36ebadbb/Model#>\nPREFIX incident: <http://cambridgesemantics.com/SourceLayer/4232a7b28f5c489ba8ecab330a2c57e4/Model#>\nPREFIX bom: <http://cambridgesemantics.com/SourceLayer/d7b06f61ebbf44278097d3f7e48616a8/Model#>\nPREFIX model: <http://cambridgesemantics.com/SourceLayer/9d584fa502fd4fae8390bab3627be5f0/Model#>\n\n#### 1. Unified Manufacturing Model (model:)\n**Use this namespace for MES Workorders, PLM BOMs, and ERP Material data.**\n\n**Core Classes:**\n- `model:MesWorkorder`: Manufacturing Execution System work order.\n- `model:PlmItemPart`: Product Lifecycle Management item definition.\n- `model:PlmBom`: Bill of Materials structure.\n- `model:ErpMaterialMaster`: ERP Material Master data.\n\n**Key Properties:**\n- **On MesWorkorder**:\n - `model:MesWorkorder.itemId` (String, e.g., "ITEM-10170")\n - `model:MesWorkorder.workorderId` (ID)\n - `model:MesWorkorder.status` (e.g., "Running", "Completed")\n - `model:MesWorkorder.workCenter`\n - `model:MesWorkorder.startTime`\n- **On PlmItemPart**:\n - `model:PlmItemPart.itemId`\n- **On PlmBom**:\n - `model:PlmBom.parentItemId` (Links to parent item)\n - `model:PlmBom.childItemId` (Links to child component)\n - `model:PlmBom.quantity`\n\n**Connecting Logic:**\n- **Find Active Production**: Filter `model:MesWorkorder.status` by "Running".\n- **MES ↔ BOM**: Join `model:MesWorkorder.itemId` with `model:PlmBom.parentItemId` to find parts needed for a running order.\n- **MES ↔ ERP**: Workorders link to ERP materials loosely. Sometimes you need `FILTER(CONTAINS(STR(?link), "ErpMaterialMaster"))` to find the specific ERP relation.\n\n#### 2. Assembly Stage Model (assembly:)\n- Classes: `assembly:AssemblyStagesItemid` (VIN/Item), `assembly:AssemblyStagesItemid.AssemblyRecord`.\n- Properties: `vin`, `machineId`, `operator`, `assemblyDatetime`.\n- Use: Tracking specific assembly history of a VIN.\n\n#### 3. Machine Incidents Model (incident:)\n- Classes: `incident:AllMachinesIncident`, `incident:AllMachinesIncident.Machine`.\n- Properties: `alertStatus`, `incidentType`, `description`.\n- Use: Analysis of machine breakdowns.\n\n#### 4. Vehicle BOM Model (vehicle/bom:)\n- Classes: `vehicle:EvoraBom`, `vehicle:EvoraBom.Subsystem`.\n- Use: Static vehicle structure analysis (Body, Interior, etc.).\n\n---\n### Example Output Format (Reference)\n\nUser: "Find running workorders for ITEM-10170"\nAssistant:\nPREFIX model: <http://cambridgesemantics.com/SourceLayer/9d584fa502fd4fae8390bab3627be5f0/Model#>\n\nSELECT ?workorderId ?workCenter ?startTime\nWHERE {\n ?wo a model:MesWorkorder ;\n model:MesWorkorder.itemId "ITEM-10170" ;\n model:MesWorkorder.status "Running" ;\n model:MesWorkorder.workorderId ?workorderId ;\n model:MesWorkorder.workCenter ?workCenter ;\n model:MesWorkorder.startTime ?startTime .\n}\nLIMIT 10\n'\n | |
| [MicroflowCallAction] Target: GenAICommons.Request_Create (GenAICommons.Request_Create.SystemPrompt=$SystemPrompt\n, GenAICommons.Request_Create.Temperature=0.2\n, GenAICommons.Request_Create.MaxTokens=256\n, GenAICommons.Request_Create.TopP=0.2\n, GenAICommons.Request_Create.ID=$UserPrompt) -> $Request | |
| [MicroflowCallAction] Target: GenAICommons.Request_AddMessage (GenAICommons.Request_AddMessage.Request=$Request, GenAICommons.Request_AddMessage.ENUM_MessageRole=GenAICommons.ENUM_MessageRole.user, GenAICommons.Request_AddMessage.FileCollection=empty\n, GenAICommons.Request_AddMessage.ContentString=trim($UserPrompt)) | |
| [RetrieveAction] Entity: GenAICommons.DeployedModel | XPath: [contains(Model,'claude-3-5')]\n -> $DeployedModel | |
| [MicroflowCallAction] Target: GenAICommons.ChatCompletions_WithHistory (GenAICommons.ChatCompletions_WithHistory.Request=$Request, GenAICommons.ChatCompletions_WithHistory.DeployedModel=$DeployedModel) -> $Response_SparqlQuery | |
| [ExclusiveSplit] ? find($Response_SparqlQuery/ResponseText, 'PREFIX') != -1\n (Prefix found?) | |
| --[true]--> | |
| [CreateVariableAction] $SparqlQuery_Cleaned = substring($Response_SparqlQuery/ResponseText, find($Response_SparqlQuery/ResponseText, 'PREFIX'))\n | |
| [EndEvent] Return: $Response_SparqlQuery/ResponseText\n | |
| --[false]--> | |
| [EndEvent] Return: $Response_SparqlQuery/ResponseText\n | |
| ============================================================ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment