|
| 1 | +--- |
| 2 | +layout: client |
| 3 | +category: clients |
| 4 | +name: BedrockAgent |
| 5 | +package: async-aws/bedrock-agent |
| 6 | +--- |
| 7 | + |
| 8 | +## Usage |
| 9 | + |
| 10 | +### Delete knowledge base documents |
| 11 | + |
| 12 | +```php |
| 13 | +use AsyncAws\BedrockAgent\BedrockAgentClient; |
| 14 | +use AsyncAws\BedrockAgent\Enum\ContentDataSourceType; |
| 15 | +use AsyncAws\BedrockAgent\Input\DeleteKnowledgeBaseDocumentsRequest; |
| 16 | +use AsyncAws\BedrockAgent\ValueObject\DocumentIdentifier; |
| 17 | +use AsyncAws\BedrockAgent\ValueObject\S3Location; |
| 18 | + |
| 19 | +$bedrockAgent = new BedrockAgentClient(); |
| 20 | + |
| 21 | +$request = new DeleteKnowledgeBaseDocumentsRequest([ |
| 22 | + 'knowledgeBaseId' => 'kb-1234567890abcdef', |
| 23 | + 'dataSourceId' => 'ds-abcdef1234567890', |
| 24 | + 'clientToken' => 'token-1234', |
| 25 | + 'documentIdentifiers' => [new DocumentIdentifier([ |
| 26 | + 'dataSourceType' => ContentDataSourceType::S3, |
| 27 | + 's3' => new S3Location([ |
| 28 | + 'uri' => 's3://my-bucket/documents/', |
| 29 | + ]), |
| 30 | + ])], |
| 31 | +]); |
| 32 | + |
| 33 | +$result = $bedrockAgent->deleteKnowledgeBaseDocuments($request); |
| 34 | + |
| 35 | +foreach ($result->getDocumentDetails() as $documentDetail) { |
| 36 | + echo $documentDetail->getStatus() . PHP_EOL; |
| 37 | +} |
| 38 | + |
| 39 | +``` |
| 40 | +more information [DeleteKnowledgeBaseDocuments](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_DeleteKnowledgeBaseDocuments.html) |
| 41 | + |
| 42 | +### Get knowledge base documents |
| 43 | + |
| 44 | +```php |
| 45 | +use AsyncAws\BedrockAgent\BedrockAgentClient; |
| 46 | +use AsyncAws\BedrockAgent\Enum\ContentDataSourceType; |
| 47 | +use AsyncAws\BedrockAgent\Input\GetKnowledgeBaseDocumentsRequest; |
| 48 | +use AsyncAws\BedrockAgent\ValueObject\DocumentIdentifier; |
| 49 | +use AsyncAws\BedrockAgent\ValueObject\S3Location; |
| 50 | + |
| 51 | +$bedrockAgent = new BedrockAgentClient(); |
| 52 | + |
| 53 | +$request = new GetKnowledgeBaseDocumentsRequest([ |
| 54 | + 'knowledgeBaseId' => 'kb-1234567890abcdef', |
| 55 | + 'dataSourceId' => 'ds-abcdef1234567890', |
| 56 | + 'documentIdentifiers' => [new DocumentIdentifier([ |
| 57 | + 'dataSourceType' => ContentDataSourceType::S3, |
| 58 | + 's3' => new S3Location([ |
| 59 | + 'uri' => 's3://my-bucket/documents/', |
| 60 | + ]), |
| 61 | + ])], |
| 62 | +]); |
| 63 | + |
| 64 | +$result = $bedrockAgent->getKnowledgeBaseDocuments($request); |
| 65 | + |
| 66 | +foreach ($result->getDocumentDetails() as $documentDetail) { |
| 67 | + echo $documentDetail->getIdentifier()->getS3()->getUri() . PHP_EOL; |
| 68 | +} |
| 69 | + |
| 70 | +``` |
| 71 | +more information [GetKnowledgeBaseDocuments](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetKnowledgeBaseDocuments.html) |
| 72 | + |
| 73 | +### Ingest knowledge base documents |
| 74 | + |
| 75 | +```php |
| 76 | +use AsyncAws\BedrockAgent\Enum\ContentDataSourceType; |
| 77 | +use AsyncAws\BedrockAgent\Enum\MetadataSourceType; |
| 78 | +use AsyncAws\BedrockAgent\Input\IngestKnowledgeBaseDocumentsRequest; |
| 79 | +use AsyncAws\BedrockAgent\ValueObject\CustomS3Location; |
| 80 | +use AsyncAws\BedrockAgent\ValueObject\DocumentContent; |
| 81 | +use AsyncAws\BedrockAgent\ValueObject\DocumentMetadata; |
| 82 | +use AsyncAws\BedrockAgent\ValueObject\KnowledgeBaseDocument; |
| 83 | +use AsyncAws\BedrockAgent\ValueObject\S3Content; |
| 84 | +use AsyncAws\BedrockAgent\ValueObject\S3Location; |
| 85 | + |
| 86 | +$bedrockAgent = new BedrockAgentClient(); |
| 87 | + |
| 88 | +$request = new IngestKnowledgeBaseDocumentsRequest([ |
| 89 | + 'knowledgeBaseId' => 'kb-1234567890abcdef', |
| 90 | + 'dataSourceId' => 'ds-abcdef1234567890', |
| 91 | + 'clientToken' => 'token-1234', |
| 92 | + 'documents' => [new KnowledgeBaseDocument([ |
| 93 | + 'metadata' => new DocumentMetadata([ |
| 94 | + 'type' => MetadataSourceType::S3_LOCATION, |
| 95 | + 's3Location' => new CustomS3Location([ |
| 96 | + 'uri' => 's3://my-bucket/documents/', |
| 97 | + 'bucketOwnerAccountId' => 'account-1234', |
| 98 | + ]), |
| 99 | + ]), |
| 100 | + 'content' => new DocumentContent([ |
| 101 | + 'dataSourceType' => ContentDataSourceType::S3, |
| 102 | + 's3' => new S3Content([ |
| 103 | + 's3Location' => new S3Location([ |
| 104 | + 'uri' => 's3://my-bucket/documents/', |
| 105 | + ]), |
| 106 | + ]), |
| 107 | + ]), |
| 108 | + ])], |
| 109 | +]); |
| 110 | + |
| 111 | +$result = $bedrockAgent->ingestKnowledgeBaseDocuments($request); |
| 112 | + |
| 113 | +foreach ($result->getDocumentDetails() as $documentDetail) { |
| 114 | + echo $documentDetail->getStatus() . PHP_EOL; |
| 115 | + echo $documentDetail->getIdentifier()->getS3()->getUri() . PHP_EOL; |
| 116 | +} |
| 117 | + |
| 118 | +``` |
| 119 | +more information [IngestKnowledgeBaseDocuments](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_IngestKnowledgeBaseDocuments.html) |
| 120 | + |
| 121 | +### List knowledge base documents |
| 122 | + |
| 123 | +```php |
| 124 | +use AsyncAws\BedrockAgent\BedrockAgentClient; |
| 125 | +use AsyncAws\BedrockAgent\Input\ListKnowledgeBaseDocumentsRequest; |
| 126 | + |
| 127 | +$bedrockAgent = new BedrockAgentClient(); |
| 128 | + |
| 129 | +$request = new ListKnowledgeBaseDocumentsRequest([ |
| 130 | + 'knowledgeBaseId' => 'kb-1234567890abcdef', |
| 131 | + 'dataSourceId' => 'ds-abcdef1234567890', |
| 132 | + 'maxResults' => 50, |
| 133 | +]); |
| 134 | + |
| 135 | +$result = $bedrockAgent->listKnowledgeBaseDocuments($request); |
| 136 | + |
| 137 | +foreach ($result->getDocumentDetails() as $documentDetail) { |
| 138 | + echo $documentDetail->getIdentifier()->getS3()->getUri() . PHP_EOL; |
| 139 | +} |
| 140 | + |
| 141 | +``` |
| 142 | +more information [ListKnowledgeBaseDocuments](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListKnowledgeBaseDocuments.html) |
0 commit comments