Get Knowledge Base

bedrockagent_get_knowledge_base

R Documentation

Gets information about a knowledge base

Description

Gets information about a knowledge base.

Usage

bedrockagent_get_knowledge_base(knowledgeBaseId)

Arguments

knowledgeBaseId

[required] The unique identifier of the knowledge base you want to get information on.

Value

A list with the following syntax:

list(
  knowledgeBase = list(
    knowledgeBaseId = "string",
    name = "string",
    knowledgeBaseArn = "string",
    description = "string",
    roleArn = "string",
    knowledgeBaseConfiguration = list(
      type = "VECTOR"|"KENDRA"|"SQL",
      vectorKnowledgeBaseConfiguration = list(
        embeddingModelArn = "string",
        embeddingModelConfiguration = list(
          bedrockEmbeddingModelConfiguration = list(
            dimensions = 123,
            embeddingDataType = "FLOAT32"|"BINARY",
            audio = list(
              list(
                segmentationConfiguration = list(
                  fixedLengthDuration = 123
                )
              )
            ),
            video = list(
              list(
                segmentationConfiguration = list(
                  fixedLengthDuration = 123
                )
              )
            )
          )
        ),
        supplementalDataStorageConfiguration = list(
          storageLocations = list(
            list(
              type = "S3",
              s3Location = list(
                uri = "string"
              )
            )
          )
        )
      ),
      kendraKnowledgeBaseConfiguration = list(
        kendraIndexArn = "string"
      ),
      sqlKnowledgeBaseConfiguration = list(
        type = "REDSHIFT",
        redshiftConfiguration = list(
          storageConfigurations = list(
            list(
              type = "REDSHIFT"|"AWS_DATA_CATALOG",
              awsDataCatalogConfiguration = list(
                tableNames = list(
                  "string"
                )
              ),
              redshiftConfiguration = list(
                databaseName = "string"
              )
            )
          ),
          queryEngineConfiguration = list(
            type = "SERVERLESS"|"PROVISIONED",
            serverlessConfiguration = list(
              workgroupArn = "string",
              authConfiguration = list(
                type = "IAM"|"USERNAME_PASSWORD",
                usernamePasswordSecretArn = "string"
              )
            ),
            provisionedConfiguration = list(
              clusterIdentifier = "string",
              authConfiguration = list(
                type = "IAM"|"USERNAME_PASSWORD"|"USERNAME",
                databaseUser = "string",
                usernamePasswordSecretArn = "string"
              )
            )
          ),
          queryGenerationConfiguration = list(
            executionTimeoutSeconds = 123,
            generationContext = list(
              tables = list(
                list(
                  name = "string",
                  description = "string",
                  inclusion = "INCLUDE"|"EXCLUDE",
                  columns = list(
                    list(
                      name = "string",
                      description = "string",
                      inclusion = "INCLUDE"|"EXCLUDE"
                    )
                  )
                )
              ),
              curatedQueries = list(
                list(
                  naturalLanguage = "string",
                  sql = "string"
                )
              )
            )
          )
        )
      )
    ),
    storageConfiguration = list(
      type = "OPENSEARCH_SERVERLESS"|"PINECONE"|"REDIS_ENTERPRISE_CLOUD"|"RDS"|"MONGO_DB_ATLAS"|"NEPTUNE_ANALYTICS"|"OPENSEARCH_MANAGED_CLUSTER"|"S3_VECTORS",
      opensearchServerlessConfiguration = list(
        collectionArn = "string",
        vectorIndexName = "string",
        fieldMapping = list(
          vectorField = "string",
          textField = "string",
          metadataField = "string"
        )
      ),
      opensearchManagedClusterConfiguration = list(
        domainEndpoint = "string",
        domainArn = "string",
        vectorIndexName = "string",
        fieldMapping = list(
          vectorField = "string",
          textField = "string",
          metadataField = "string"
        )
      ),
      pineconeConfiguration = list(
        connectionString = "string",
        credentialsSecretArn = "string",
        namespace = "string",
        fieldMapping = list(
          textField = "string",
          metadataField = "string"
        )
      ),
      redisEnterpriseCloudConfiguration = list(
        endpoint = "string",
        vectorIndexName = "string",
        credentialsSecretArn = "string",
        fieldMapping = list(
          vectorField = "string",
          textField = "string",
          metadataField = "string"
        )
      ),
      rdsConfiguration = list(
        resourceArn = "string",
        credentialsSecretArn = "string",
        databaseName = "string",
        tableName = "string",
        fieldMapping = list(
          primaryKeyField = "string",
          vectorField = "string",
          textField = "string",
          metadataField = "string",
          customMetadataField = "string"
        )
      ),
      mongoDbAtlasConfiguration = list(
        endpoint = "string",
        databaseName = "string",
        collectionName = "string",
        vectorIndexName = "string",
        credentialsSecretArn = "string",
        fieldMapping = list(
          vectorField = "string",
          textField = "string",
          metadataField = "string"
        ),
        endpointServiceName = "string",
        textIndexName = "string"
      ),
      neptuneAnalyticsConfiguration = list(
        graphArn = "string",
        fieldMapping = list(
          textField = "string",
          metadataField = "string"
        )
      ),
      s3VectorsConfiguration = list(
        vectorBucketArn = "string",
        indexArn = "string",
        indexName = "string"
      )
    ),
    status = "CREATING"|"ACTIVE"|"DELETING"|"UPDATING"|"FAILED"|"DELETE_UNSUCCESSFUL",
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    updatedAt = as.POSIXct(
      "2015-01-01"
    ),
    failureReasons = list(
      "string"
    )
  )
)

Request syntax

svc$get_knowledge_base(
  knowledgeBaseId = "string"
)