KnowledgeBase interface
Properties
| answer |
Instructions considered by the knowledge base when generating answers. |
| cors |
Options to control Cross-Origin Resource Sharing (CORS) for the knowledge base. |
| description | The description of the knowledge base. |
| encryption |
A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your knowledge base definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your knowledge base definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your knowledge base definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. |
| etag | The ETag of the knowledge base. |
| knowledge |
Knowledge sources referenced by this knowledge base. |
| models | Contains configuration options on how to connect to AI models. |
| name | The name of the knowledge base. |
| output |
The output mode for the knowledge base. |
| retrieval |
Instructions considered by the knowledge base when developing the query plan. |
| retrieval |
The retrieval reasoning effort configuration applied at retrieval time. |
Property Details
answerInstructions
Instructions considered by the knowledge base when generating answers.
answerInstructions?: stringProperty Value
string
corsOptions
Options to control Cross-Origin Resource Sharing (CORS) for the knowledge base.
corsOptions?: CorsOptionsProperty Value
description
The description of the knowledge base.
description?: stringProperty Value
string
encryptionKey
A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your knowledge base definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your knowledge base definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your knowledge base definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.
encryptionKey?: SearchResourceEncryptionKeyProperty Value
etag
The ETag of the knowledge base.
etag?: stringProperty Value
string
knowledgeSources
Knowledge sources referenced by this knowledge base.
knowledgeSources: KnowledgeSourceReference[]Property Value
models
Contains configuration options on how to connect to AI models.
models?: KnowledgeBaseAzureOpenAIModel[]Property Value
name
The name of the knowledge base.
name: stringProperty Value
string
outputMode
The output mode for the knowledge base.
outputMode?: stringProperty Value
string
retrievalInstructions
Instructions considered by the knowledge base when developing the query plan.
retrievalInstructions?: stringProperty Value
string
retrievalReasoningEffort
The retrieval reasoning effort configuration applied at retrieval time.
retrievalReasoningEffort?: KnowledgeRetrievalReasoningEffortUnion