Share via


KnowledgeAgent Class

Definition

The KnowledgeAgent.

public class KnowledgeAgent
type KnowledgeAgent = class
Public Class KnowledgeAgent
Inheritance
KnowledgeAgent

Constructors

KnowledgeAgent(String, IEnumerable<KnowledgeAgentModel>, IEnumerable<KnowledgeAgentTargetIndex>)

Initializes a new instance of KnowledgeAgent.

Properties

Description

The description of the agent.

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 agent definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your agent 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 agent 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 KnowledgeAgent.

Models

Contains configuration options on how to connect to AI models. Please note KnowledgeAgentModel is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include KnowledgeAgentAzureOpenAIModel.

Name

The name of the knowledge agent.

RequestLimits

Guardrails to limit how much resources are utilized for a single agent retrieval request.

TargetIndexes

Gets the target indexes.

Applies to