get_knowledge_base_documents¶
Operation¶
get_knowledge_base_documents
¶
get_knowledge_base_documents(request: GetKnowledgeBaseDocumentsInput | GetKnowledgeBaseDocumentsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetKnowledgeBaseDocumentsInputDict]) -> GetKnowledgeBaseDocumentsOutput
Retrieves specific documents from a data source that is connected to a knowledge base. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetKnowledgeBaseDocumentsInput | GetKnowledgeBaseDocumentsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[GetKnowledgeBaseDocumentsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetKnowledgeBaseDocumentsOutput
|
An instance of |
get_knowledge_base_documents
async
¶
get_knowledge_base_documents(request: GetKnowledgeBaseDocumentsInput | GetKnowledgeBaseDocumentsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetKnowledgeBaseDocumentsInputDict]) -> GetKnowledgeBaseDocumentsOutput
Retrieves specific documents from a data source that is connected to a knowledge base. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetKnowledgeBaseDocumentsInput | GetKnowledgeBaseDocumentsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[GetKnowledgeBaseDocumentsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetKnowledgeBaseDocumentsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetKnowledgeBaseDocumentsInputDict
¶
Bases: TypedDict
Dictionary form of GetKnowledgeBaseDocumentsInput.
Attributes¶
data_source_id
instance-attribute
¶
The unique identifier of the data source that contains the documents.
document_identifiers
instance-attribute
¶
document_identifiers: Required[Sequence[DocumentIdentifier | DocumentIdentifierDict]]
A list of objects, each of which contains information to identify a document for which to retrieve information.
GetKnowledgeBaseDocumentsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetKnowledgeBaseDocumentsInput structure.
Attributes¶
data_source_id
class-attribute
instance-attribute
¶
data_source_id: str | None = ...
The unique identifier of the data source that contains the documents.
document_identifiers
class-attribute
instance-attribute
¶
document_identifiers: list[DocumentIdentifier] | None = ...
A list of objects, each of which contains information to identify a document for which to retrieve information.
Output¶
GetKnowledgeBaseDocumentsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetKnowledgeBaseDocumentsOutput structure.
Attributes¶
document_details
class-attribute
instance-attribute
¶
document_details: list[KnowledgeBaseDocumentDetail] | None = ...
A list of objects, each of which contains information about the documents that were retrieved.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.