get_knowledge_base_documents `async` ¶

get_knowledge_base_documents(
    knowledge_base_id: Id,
    data_source_id: Id,
    document_identifiers: DocumentIdentifiers,
    *,
    config_overrides: Optional[AsyncBedrockAgentClientConfig] = None,
) -> GetKnowledgeBaseDocumentsResponse

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:

knowledge_base_id (Id) –

The unique identifier of the knowledge base that is connected to the data source.
data_source_id (Id) –

The unique identifier of the data source that contains the documents.
document_identifiers (DocumentIdentifiers) –

A list of objects, each of which contains information to identify a document for which to retrieve information.

Raises:

AccessDeniedException –

The request is denied because of missing access permissions.
InternalServerException –

An internal server error occurred. Retry your request.
ResourceNotFoundException –

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
ServiceQuotaExceededException –

The number of requests exceeds the service quota. Resubmit your request later.
ThrottlingException –

The number of requests exceeds the limit. Resubmit your request later.
ValidationException –

Input validation failed. Check your request parameters and retry the request.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_bedrock_agent/_services/async_bedrock_agent.py

async def get_knowledge_base_documents(
    self,
    knowledge_base_id: "capo_bedrock_agent.types.id.Id",
    data_source_id: "capo_bedrock_agent.types.id.Id",
    document_identifiers: "capo_bedrock_agent.types.document_identifiers.DocumentIdentifiers",
    *,
    config_overrides: Optional[AsyncBedrockAgentClientConfig] = None,
) -> "capo_bedrock_agent.types.get_knowledge_base_documents_response.GetKnowledgeBaseDocumentsResponse":
    """<p>Retrieves specific documents from a data source that is connected to a knowledge base. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-direct-ingestion.html">Ingest changes directly into a knowledge base</a> in the Amazon Bedrock User Guide.</p>

    Args:
        knowledge_base_id: <p>The unique identifier of the knowledge base that is connected to the data source.</p>
        data_source_id: <p>The unique identifier of the data source that contains the documents.</p>
        document_identifiers: <p>A list of objects, each of which contains information to identify a document for which to retrieve information.</p>

    Raises:
        capo_bedrock_agent.errors.access_denied_exception.AccessDeniedException: <p>The request is denied because of missing access permissions.</p>
        capo_bedrock_agent.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
        capo_bedrock_agent.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
        capo_bedrock_agent.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
        capo_bedrock_agent.errors.throttling_exception.ThrottlingException: <p>The number of requests exceeds the limit. Resubmit your request later.</p>
        capo_bedrock_agent.errors.validation_exception.ValidationException: <p>Input validation failed. Check your request parameters and retry the request.</p>
        capo_bedrock_agent.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_bedrock_agent.types.get_knowledge_base_documents_request.GetKnowledgeBaseDocumentsRequest]",
    ) -> AsyncOperationResponse[
        "capo_bedrock_agent.types.get_knowledge_base_documents_response.GetKnowledgeBaseDocumentsResponse"
    ]:
        import capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.get_knowledge_base_documents

        (
            output,
            http_response,
        ) = await capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.get_knowledge_base_documents.async_get_knowledge_base_documents(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetKnowledgeBaseDocuments")
    )
    input_: capo_bedrock_agent.types.get_knowledge_base_documents_request.GetKnowledgeBaseDocumentsRequest = {
        "knowledge_base_id": knowledge_base_id,
        "data_source_id": data_source_id,
        "document_identifiers": document_identifiers,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

get_knowledge_base_documents async ¶

get_knowledge_base_documents `async` ¶