Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. wisdom
  5. getKnowledgeBase

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.wisdom.getKnowledgeBase

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::Wisdom::KnowledgeBase Resource Type

    Using getKnowledgeBase

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getKnowledgeBase(args: GetKnowledgeBaseArgs, opts?: InvokeOptions): Promise<GetKnowledgeBaseResult>
function getKnowledgeBaseOutput(args: GetKnowledgeBaseOutputArgs, opts?: InvokeOptions): Output<GetKnowledgeBaseResult>
    def get_knowledge_base(knowledge_base_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetKnowledgeBaseResult
def get_knowledge_base_output(knowledge_base_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetKnowledgeBaseResult]
    func LookupKnowledgeBase(ctx *Context, args *LookupKnowledgeBaseArgs, opts ...InvokeOption) (*LookupKnowledgeBaseResult, error)
func LookupKnowledgeBaseOutput(ctx *Context, args *LookupKnowledgeBaseOutputArgs, opts ...InvokeOption) LookupKnowledgeBaseResultOutput

    > Note: This function is named LookupKnowledgeBase in the Go SDK.

    public static class GetKnowledgeBase 
{
    public static Task<GetKnowledgeBaseResult> InvokeAsync(GetKnowledgeBaseArgs args, InvokeOptions? opts = null)
    public static Output<GetKnowledgeBaseResult> Invoke(GetKnowledgeBaseInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetKnowledgeBaseResult> getKnowledgeBase(GetKnowledgeBaseArgs args, InvokeOptions options)
public static Output<GetKnowledgeBaseResult> getKnowledgeBase(GetKnowledgeBaseArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:wisdom:getKnowledgeBase
  arguments:
    # arguments dictionary

    The following arguments are supported:

    KnowledgeBaseId string
    The ID of the knowledge base.
    KnowledgeBaseId string
    The ID of the knowledge base.
    knowledgeBaseId String
    The ID of the knowledge base.
    knowledgeBaseId string
    The ID of the knowledge base.
    knowledge_base_id str
    The ID of the knowledge base.
    knowledgeBaseId String
    The ID of the knowledge base.

    getKnowledgeBase Result

    The following output properties are available:

    KnowledgeBaseArn string
    The Amazon Resource Name (ARN) of the knowledge base.
    KnowledgeBaseId string
    The ID of the knowledge base.
    RenderingConfiguration Pulumi.AwsNative.Wisdom.Outputs.KnowledgeBaseRenderingConfiguration
    Information about how to render the content.
    VectorIngestionConfiguration Pulumi.AwsNative.Wisdom.Outputs.KnowledgeBaseVectorIngestionConfiguration
    Contains details about how to ingest the documents in a data source.
    KnowledgeBaseArn string
    The Amazon Resource Name (ARN) of the knowledge base.
    KnowledgeBaseId string
    The ID of the knowledge base.
    RenderingConfiguration KnowledgeBaseRenderingConfiguration
    Information about how to render the content.
    VectorIngestionConfiguration KnowledgeBaseVectorIngestionConfiguration
    Contains details about how to ingest the documents in a data source.
    knowledgeBaseArn String
    The Amazon Resource Name (ARN) of the knowledge base.
    knowledgeBaseId String
    The ID of the knowledge base.
    renderingConfiguration KnowledgeBaseRenderingConfiguration
    Information about how to render the content.
    vectorIngestionConfiguration KnowledgeBaseVectorIngestionConfiguration
    Contains details about how to ingest the documents in a data source.
    knowledgeBaseArn string
    The Amazon Resource Name (ARN) of the knowledge base.
    knowledgeBaseId string
    The ID of the knowledge base.
    renderingConfiguration KnowledgeBaseRenderingConfiguration
    Information about how to render the content.
    vectorIngestionConfiguration KnowledgeBaseVectorIngestionConfiguration
    Contains details about how to ingest the documents in a data source.
    knowledge_base_arn str
    The Amazon Resource Name (ARN) of the knowledge base.
    knowledge_base_id str
    The ID of the knowledge base.
    rendering_configuration KnowledgeBaseRenderingConfiguration
    Information about how to render the content.
    vector_ingestion_configuration KnowledgeBaseVectorIngestionConfiguration
    Contains details about how to ingest the documents in a data source.
    knowledgeBaseArn String
    The Amazon Resource Name (ARN) of the knowledge base.
    knowledgeBaseId String
    The ID of the knowledge base.
    renderingConfiguration Property Map
    Information about how to render the content.
    vectorIngestionConfiguration Property Map
    Contains details about how to ingest the documents in a data source.

    Supporting Types

    KnowledgeBaseBedrockFoundationModelConfiguration

    ModelArn string
    The model ARN of the Bedrock foundation model.
    ParsingPrompt Pulumi.AwsNative.Wisdom.Inputs.KnowledgeBaseBedrockFoundationModelConfigurationParsingPromptProperties
    The parsing prompt of the Bedrock foundation model configuration.
    ModelArn string
    The model ARN of the Bedrock foundation model.
    ParsingPrompt KnowledgeBaseBedrockFoundationModelConfigurationParsingPromptProperties
    The parsing prompt of the Bedrock foundation model configuration.
    modelArn String
    The model ARN of the Bedrock foundation model.
    parsingPrompt KnowledgeBaseBedrockFoundationModelConfigurationParsingPromptProperties
    The parsing prompt of the Bedrock foundation model configuration.
    modelArn string
    The model ARN of the Bedrock foundation model.
    parsingPrompt KnowledgeBaseBedrockFoundationModelConfigurationParsingPromptProperties
    The parsing prompt of the Bedrock foundation model configuration.
    model_arn str
    The model ARN of the Bedrock foundation model.
    parsing_prompt KnowledgeBaseBedrockFoundationModelConfigurationParsingPromptProperties
    The parsing prompt of the Bedrock foundation model configuration.
    modelArn String
    The model ARN of the Bedrock foundation model.
    parsingPrompt Property Map
    The parsing prompt of the Bedrock foundation model configuration.

    KnowledgeBaseBedrockFoundationModelConfigurationParsingPromptProperties

    KnowledgeBaseFixedSizeChunkingConfiguration

    MaxTokens double
    The maximum number of tokens to include in a chunk.
    OverlapPercentage double
    The percentage of overlap between adjacent chunks of a data source.
    MaxTokens float64
    The maximum number of tokens to include in a chunk.
    OverlapPercentage float64
    The percentage of overlap between adjacent chunks of a data source.
    maxTokens Double
    The maximum number of tokens to include in a chunk.
    overlapPercentage Double
    The percentage of overlap between adjacent chunks of a data source.
    maxTokens number
    The maximum number of tokens to include in a chunk.
    overlapPercentage number
    The percentage of overlap between adjacent chunks of a data source.
    max_tokens float
    The maximum number of tokens to include in a chunk.
    overlap_percentage float
    The percentage of overlap between adjacent chunks of a data source.
    maxTokens Number
    The maximum number of tokens to include in a chunk.
    overlapPercentage Number
    The percentage of overlap between adjacent chunks of a data source.

    KnowledgeBaseHierarchicalChunkingConfiguration

    LevelConfigurations List<Pulumi.AwsNative.Wisdom.Inputs.KnowledgeBaseHierarchicalChunkingLevelConfiguration>
    Token settings for each layer.
    OverlapTokens double
    The number of tokens to repeat across chunks in the same layer.
    LevelConfigurations []KnowledgeBaseHierarchicalChunkingLevelConfiguration
    Token settings for each layer.
    OverlapTokens float64
    The number of tokens to repeat across chunks in the same layer.
    levelConfigurations List<KnowledgeBaseHierarchicalChunkingLevelConfiguration>
    Token settings for each layer.
    overlapTokens Double
    The number of tokens to repeat across chunks in the same layer.
    levelConfigurations KnowledgeBaseHierarchicalChunkingLevelConfiguration[]
    Token settings for each layer.
    overlapTokens number
    The number of tokens to repeat across chunks in the same layer.
    level_configurations Sequence[KnowledgeBaseHierarchicalChunkingLevelConfiguration]
    Token settings for each layer.
    overlap_tokens float
    The number of tokens to repeat across chunks in the same layer.
    levelConfigurations List<Property Map>
    Token settings for each layer.
    overlapTokens Number
    The number of tokens to repeat across chunks in the same layer.

    KnowledgeBaseHierarchicalChunkingLevelConfiguration

    MaxTokens double
    The maximum number of tokens that a chunk can contain in this layer.
    MaxTokens float64
    The maximum number of tokens that a chunk can contain in this layer.
    maxTokens Double
    The maximum number of tokens that a chunk can contain in this layer.
    maxTokens number
    The maximum number of tokens that a chunk can contain in this layer.
    max_tokens float
    The maximum number of tokens that a chunk can contain in this layer.
    maxTokens Number
    The maximum number of tokens that a chunk can contain in this layer.

    KnowledgeBaseRenderingConfiguration

    TemplateUri string

    A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:

    • Salesforce: Id , ArticleNumber , VersionNumber , Title , PublishStatus , or IsDeleted
    • ServiceNow: number , short_description , sys_mod_count , workflow_state , or active
    • Zendesk: id , title , updated_at , or draft

    The variable is replaced with the actual value for a piece of content when calling GetContent .

    TemplateUri string

    A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:

    • Salesforce: Id , ArticleNumber , VersionNumber , Title , PublishStatus , or IsDeleted
    • ServiceNow: number , short_description , sys_mod_count , workflow_state , or active
    • Zendesk: id , title , updated_at , or draft

    The variable is replaced with the actual value for a piece of content when calling GetContent .

    templateUri String

    A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:

    • Salesforce: Id , ArticleNumber , VersionNumber , Title , PublishStatus , or IsDeleted
    • ServiceNow: number , short_description , sys_mod_count , workflow_state , or active
    • Zendesk: id , title , updated_at , or draft

    The variable is replaced with the actual value for a piece of content when calling GetContent .

    templateUri string

    A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:

    • Salesforce: Id , ArticleNumber , VersionNumber , Title , PublishStatus , or IsDeleted
    • ServiceNow: number , short_description , sys_mod_count , workflow_state , or active
    • Zendesk: id , title , updated_at , or draft

    The variable is replaced with the actual value for a piece of content when calling GetContent .

    template_uri str

    A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:

    • Salesforce: Id , ArticleNumber , VersionNumber , Title , PublishStatus , or IsDeleted
    • ServiceNow: number , short_description , sys_mod_count , workflow_state , or active
    • Zendesk: id , title , updated_at , or draft

    The variable is replaced with the actual value for a piece of content when calling GetContent .

    templateUri String

    A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:

    • Salesforce: Id , ArticleNumber , VersionNumber , Title , PublishStatus , or IsDeleted
    • ServiceNow: number , short_description , sys_mod_count , workflow_state , or active
    • Zendesk: id , title , updated_at , or draft

    The variable is replaced with the actual value for a piece of content when calling GetContent .

    KnowledgeBaseSemanticChunkingConfiguration

    BreakpointPercentileThreshold double
    The dissimilarity threshold for splitting chunks.
    BufferSize double
    The buffer size.
    MaxTokens double
    The maximum number of tokens that a chunk can contain.
    BreakpointPercentileThreshold float64
    The dissimilarity threshold for splitting chunks.
    BufferSize float64
    The buffer size.
    MaxTokens float64
    The maximum number of tokens that a chunk can contain.
    breakpointPercentileThreshold Double
    The dissimilarity threshold for splitting chunks.
    bufferSize Double
    The buffer size.
    maxTokens Double
    The maximum number of tokens that a chunk can contain.
    breakpointPercentileThreshold number
    The dissimilarity threshold for splitting chunks.
    bufferSize number
    The buffer size.
    maxTokens number
    The maximum number of tokens that a chunk can contain.
    breakpoint_percentile_threshold float
    The dissimilarity threshold for splitting chunks.
    buffer_size float
    The buffer size.
    max_tokens float
    The maximum number of tokens that a chunk can contain.
    breakpointPercentileThreshold Number
    The dissimilarity threshold for splitting chunks.
    bufferSize Number
    The buffer size.
    maxTokens Number
    The maximum number of tokens that a chunk can contain.

    KnowledgeBaseVectorIngestionConfiguration

    ChunkingConfiguration Pulumi.AwsNative.Wisdom.Inputs.KnowledgeBaseVectorIngestionConfigurationChunkingConfigurationProperties
    Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
    ParsingConfiguration Pulumi.AwsNative.Wisdom.Inputs.KnowledgeBaseVectorIngestionConfigurationParsingConfigurationProperties
    A custom parser for data source documents.
    ChunkingConfiguration KnowledgeBaseVectorIngestionConfigurationChunkingConfigurationProperties
    Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
    ParsingConfiguration KnowledgeBaseVectorIngestionConfigurationParsingConfigurationProperties
    A custom parser for data source documents.
    chunkingConfiguration KnowledgeBaseVectorIngestionConfigurationChunkingConfigurationProperties
    Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
    parsingConfiguration KnowledgeBaseVectorIngestionConfigurationParsingConfigurationProperties
    A custom parser for data source documents.
    chunkingConfiguration KnowledgeBaseVectorIngestionConfigurationChunkingConfigurationProperties
    Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
    parsingConfiguration KnowledgeBaseVectorIngestionConfigurationParsingConfigurationProperties
    A custom parser for data source documents.
    chunking_configuration KnowledgeBaseVectorIngestionConfigurationChunkingConfigurationProperties
    Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
    parsing_configuration KnowledgeBaseVectorIngestionConfigurationParsingConfigurationProperties
    A custom parser for data source documents.
    chunkingConfiguration Property Map
    Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
    parsingConfiguration Property Map
    A custom parser for data source documents.

    KnowledgeBaseVectorIngestionConfigurationChunkingConfigurationProperties

    KnowledgeBaseVectorIngestionConfigurationChunkingConfigurationPropertiesChunkingStrategy

    KnowledgeBaseVectorIngestionConfigurationParsingConfigurationProperties

    KnowledgeBaseVectorIngestionConfigurationParsingConfigurationPropertiesParsingStrategy

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-aws-native