Class: Aws::BedrockAgentRuntime::Types::RetrievalResultLocation

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentRuntime::Types::RetrievalResultLocation

Defined in:

gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb

Overview

Contains information about the data source location.

This data type is used in the following API operations:

• Retrieve response – in the location field

• RetrieveAndGenerate response – in the location field

• InvokeAgent response – in the location field

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #confluence_location ⇒ Types::RetrievalResultConfluenceLocation

  The Confluence data source location.

• #custom_document_location ⇒ Types::RetrievalResultCustomDocumentLocation

  Specifies the location of a document in a custom data source.

• #kendra_document_location ⇒ Types::RetrievalResultKendraDocumentLocation

  The location of a document in Amazon Kendra.

• #s3_location ⇒ Types::RetrievalResultS3Location

  The S3 data source location.

• #salesforce_location ⇒ Types::RetrievalResultSalesforceLocation

  The Salesforce data source location.

• #share_point_location ⇒ Types::RetrievalResultSharePointLocation

  The SharePoint data source location.

• #sql_location ⇒ Types::RetrievalResultSqlLocation

  Specifies information about the SQL query used to retrieve the result.

• #type ⇒ String

  The type of data source location.

• #web_location ⇒ Types::RetrievalResultWebLocation

  The web URL/URLs data source location.

Instance Attribute Details

#confluence_location ⇒ Types::RetrievalResultConfluenceLocation

The Confluence data source location.

Returns:

• (Types::RetrievalResultConfluenceLocation)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7566

class RetrievalResultLocation < Struct.new(
  :type,
  :s3_location,
  :web_location,
  :confluence_location,
  :salesforce_location,
  :share_point_location,
  :custom_document_location,
  :kendra_document_location,
  :sql_location)
  SENSITIVE = []
  include Aws::Structure
end

#custom_document_location ⇒ Types::RetrievalResultCustomDocumentLocation

Specifies the location of a document in a custom data source.

Returns:

• (Types::RetrievalResultCustomDocumentLocation)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7566

class RetrievalResultLocation < Struct.new(
  :type,
  :s3_location,
  :web_location,
  :confluence_location,
  :salesforce_location,
  :share_point_location,
  :custom_document_location,
  :kendra_document_location,
  :sql_location)
  SENSITIVE = []
  include Aws::Structure
end

#kendra_document_location ⇒ Types::RetrievalResultKendraDocumentLocation

The location of a document in Amazon Kendra.

Returns:

• (Types::RetrievalResultKendraDocumentLocation)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7566

class RetrievalResultLocation < Struct.new(
  :type,
  :s3_location,
  :web_location,
  :confluence_location,
  :salesforce_location,
  :share_point_location,
  :custom_document_location,
  :kendra_document_location,
  :sql_location)
  SENSITIVE = []
  include Aws::Structure
end

#s3_location ⇒ Types::RetrievalResultS3Location

The S3 data source location.

Returns:

• (Types::RetrievalResultS3Location)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7566

class RetrievalResultLocation < Struct.new(
  :type,
  :s3_location,
  :web_location,
  :confluence_location,
  :salesforce_location,
  :share_point_location,
  :custom_document_location,
  :kendra_document_location,
  :sql_location)
  SENSITIVE = []
  include Aws::Structure
end

#salesforce_location ⇒ Types::RetrievalResultSalesforceLocation

The Salesforce data source location.

Returns:

• (Types::RetrievalResultSalesforceLocation)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7566

class RetrievalResultLocation < Struct.new(
  :type,
  :s3_location,
  :web_location,
  :confluence_location,
  :salesforce_location,
  :share_point_location,
  :custom_document_location,
  :kendra_document_location,
  :sql_location)
  SENSITIVE = []
  include Aws::Structure
end

#share_point_location ⇒ Types::RetrievalResultSharePointLocation

The SharePoint data source location.

Returns:

• (Types::RetrievalResultSharePointLocation)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7566

class RetrievalResultLocation < Struct.new(
  :type,
  :s3_location,
  :web_location,
  :confluence_location,
  :salesforce_location,
  :share_point_location,
  :custom_document_location,
  :kendra_document_location,
  :sql_location)
  SENSITIVE = []
  include Aws::Structure
end

#sql_location ⇒ Types::RetrievalResultSqlLocation

Specifies information about the SQL query used to retrieve the result.

Returns:

• (Types::RetrievalResultSqlLocation)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7566

class RetrievalResultLocation < Struct.new(
  :type,
  :s3_location,
  :web_location,
  :confluence_location,
  :salesforce_location,
  :share_point_location,
  :custom_document_location,
  :kendra_document_location,
  :sql_location)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of data source location.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7566

class RetrievalResultLocation < Struct.new(
  :type,
  :s3_location,
  :web_location,
  :confluence_location,
  :salesforce_location,
  :share_point_location,
  :custom_document_location,
  :kendra_document_location,
  :sql_location)
  SENSITIVE = []
  include Aws::Structure
end

#web_location ⇒ Types::RetrievalResultWebLocation

The web URL/URLs data source location.

Returns:

• (Types::RetrievalResultWebLocation)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7566

class RetrievalResultLocation < Struct.new(
  :type,
  :s3_location,
  :web_location,
  :confluence_location,
  :salesforce_location,
  :share_point_location,
  :custom_document_location,
  :kendra_document_location,
  :sql_location)
  SENSITIVE = []
  include Aws::Structure
end