AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Q Connect CreateKnowledgeBase API operation.

Syntax

New-QCKnowledgeBase
-KnowledgeBaseType <KnowledgeBaseType>
-AppIntegrations_AppIntegrationArn <String>
-SemanticChunkingConfiguration_BreakpointPercentileThreshold <Int32>
-SemanticChunkingConfiguration_BufferSize <Int32>
-ChunkingConfiguration_ChunkingStrategy <ChunkingStrategy>
-Description <String>
-WebCrawlerConfiguration_ExclusionFilter <String[]>
-WebCrawlerConfiguration_InclusionFilter <String[]>
-ServerSideEncryptionConfiguration_KmsKeyId <String>
-HierarchicalChunkingConfiguration_LevelConfiguration <HierarchicalChunkingLevelConfiguration[]>
-FixedSizeChunkingConfiguration_MaxToken <Int32>
-SemanticChunkingConfiguration_MaxToken <Int32>
-BedrockFoundationModelConfiguration_ModelArn <String>
-Name <String>
-AppIntegrations_ObjectField <String[]>
-FixedSizeChunkingConfiguration_OverlapPercentage <Int32>
-HierarchicalChunkingConfiguration_OverlapToken <Int32>
-ParsingPrompt_ParsingPromptText <String>
-ParsingConfiguration_ParsingStrategy <ParsingStrategy>
-CrawlerLimits_RateLimit <Int32>
-WebCrawlerConfiguration_Scope <WebScopeType>
-UrlConfiguration_SeedUrl <SeedUrl[]>
-Tag <Hashtable>
-RenderingConfiguration_TemplateUri <String>
-ClientToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonQConnectConfig>

Description

Creates a knowledge base. When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an InvalidRequestException error. For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:
  1. Call DeleteKnowledgeBase.
  2. Call DeleteDataIntegration.
  3. Call CreateDataIntegration to recreate the DataIntegration or a create different one.
  4. Call CreateKnowledgeBase.

Parameters

-AppIntegrations_AppIntegrationArn <String>
The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
  • For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted as source fields.
  • For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number, short_description, sys_mod_count, workflow_state, and active as source fields.
  • For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id, title, updated_at, and draft as source fields.
  • For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx, pdf, html, htm, and txt.
  • For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name.The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal app-integrations.amazonaws.com to perform s3:ListBucket, s3:GetObject, and s3:GetBucketLocation against the bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceConfiguration_AppIntegrations_AppIntegrationArn
-AppIntegrations_ObjectField <String[]>
The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration.
  • For Salesforce, you must include at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted.
  • For ServiceNow, you must include at least number, short_description, sys_mod_count, workflow_state, and active.
  • For Zendesk, you must include at least id, title, updated_at, and draft.
Make sure to include additional fields. These fields are indexed and used to source recommendations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceConfiguration_AppIntegrations_ObjectFields
-BedrockFoundationModelConfiguration_ModelArn <String>
The ARN of the foundation model.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVectorIngestionConfiguration_ParsingConfiguration_BedrockFoundationModelConfiguration_ModelArn
-ChunkingConfiguration_ChunkingStrategy <ChunkingStrategy>
Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVectorIngestionConfiguration_ChunkingConfiguration_ChunkingStrategy
-ClientConfig <AmazonQConnectConfig>
Amazon.PowerShell.Cmdlets.QC.AmazonQConnectClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CrawlerLimits_RateLimit <Int32>
Rate of web URLs retrieved per minute.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceConfiguration_ManagedSourceConfiguration_WebCrawlerConfiguration_CrawlerLimits_RateLimit
-Description <String>
The description.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FixedSizeChunkingConfiguration_MaxToken <Int32>
The maximum number of tokens to include in a chunk.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVectorIngestionConfiguration_ChunkingConfiguration_FixedSizeChunkingConfiguration_MaxTokens
-FixedSizeChunkingConfiguration_OverlapPercentage <Int32>
The percentage of overlap between adjacent chunks of a data source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVectorIngestionConfiguration_ChunkingConfiguration_FixedSizeChunkingConfiguration_OverlapPercentage
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HierarchicalChunkingConfiguration_LevelConfiguration <HierarchicalChunkingLevelConfiguration[]>
Token settings for each layer.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVectorIngestionConfiguration_ChunkingConfiguration_HierarchicalChunkingConfiguration_LevelConfigurations
-HierarchicalChunkingConfiguration_OverlapToken <Int32>
The number of tokens to repeat across chunks in the same layer.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVectorIngestionConfiguration_ChunkingConfiguration_HierarchicalChunkingConfiguration_OverlapTokens
-KnowledgeBaseType <KnowledgeBaseType>
The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Name <String>
The name of the knowledge base.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ParsingConfiguration_ParsingStrategy <ParsingStrategy>
The parsing strategy for the data source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVectorIngestionConfiguration_ParsingConfiguration_ParsingStrategy
-ParsingPrompt_ParsingPromptText <String>
Instructions for interpreting the contents of a document.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVectorIngestionConfiguration_ParsingConfiguration_BedrockFoundationModelConfiguration_ParsingPrompt_ParsingPromptText
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the KnowledgeBaseType parameter. The -PassThru parameter is deprecated, use -Select '^KnowledgeBaseType' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RenderingConfiguration_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'KnowledgeBase'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.CreateKnowledgeBaseResponse). Specifying the name of a property of type Amazon.QConnect.Model.CreateKnowledgeBaseResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SemanticChunkingConfiguration_BreakpointPercentileThreshold <Int32>
The dissimilarity threshold for splitting chunks.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVectorIngestionConfiguration_ChunkingConfiguration_SemanticChunkingConfiguration_BreakpointPercentileThreshold
-SemanticChunkingConfiguration_BufferSize <Int32>
The buffer size.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVectorIngestionConfiguration_ChunkingConfiguration_SemanticChunkingConfiguration_BufferSize
-SemanticChunkingConfiguration_MaxToken <Int32>
The maximum number of tokens that a chunk can contain.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVectorIngestionConfiguration_ChunkingConfiguration_SemanticChunkingConfiguration_MaxTokens
-ServerSideEncryptionConfiguration_KmsKeyId <String>
The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
The tags used to organize, track, or control access for this resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-UrlConfiguration_SeedUrl <SeedUrl[]>
List of URLs for crawling.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceConfiguration_ManagedSourceConfiguration_WebCrawlerConfiguration_UrlConfiguration_SeedUrls
-WebCrawlerConfiguration_ExclusionFilter <String[]>
A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceConfiguration_ManagedSourceConfiguration_WebCrawlerConfiguration_ExclusionFilters
-WebCrawlerConfiguration_InclusionFilter <String[]>
A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceConfiguration_ManagedSourceConfiguration_WebCrawlerConfiguration_InclusionFilters
-WebCrawlerConfiguration_Scope <WebScopeType>
The scope of what is crawled for your URLs. You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL https://docs.aws.amazon.com/bedrock/latest/userguide/ and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain aws.amazon.com can also include sub domain docs.aws.amazon.com.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceConfiguration_ManagedSourceConfiguration_WebCrawlerConfiguration_Scope

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.QConnect.Model.KnowledgeBaseData or Amazon.QConnect.Model.CreateKnowledgeBaseResponse
This cmdlet returns an Amazon.QConnect.Model.KnowledgeBaseData object. The service call response (type Amazon.QConnect.Model.CreateKnowledgeBaseResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z