KnowledgeBase interface

Instructions considered by the knowledge base when generating answers.

Options to control Cross-Origin Resource Sharing (CORS) for the knowledge base.

The description of the knowledge base.

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.

The ETag of the knowledge base.

Knowledge sources referenced by this knowledge base.

Contains configuration options on how to connect to AI models.

The name of the knowledge base.

The output mode for the knowledge base.

Instructions considered by the knowledge base when developing the query plan.

The retrieval reasoning effort configuration applied at retrieval time.

Persisted request-wide retrieve defaults for this knowledge base. These values apply to retrieve requests that omit the corresponding fields; request-time values take precedence when present.

User-defined metadata for organizing the knowledge base. Tags do not control billing attribution or retrieval behavior.