All Classes and Interfaces
Class
Description
Parent advisor interface for all advisors.
Defines the context for executing a chain of advisors as part of processing a chat
request.
Context used to store metadata for chat client advisors.
Builder for
AdvisorObservationContext.Interface for an
ObservationConvention for chat client advisors.AI Advisor observation documentation.
High cardinality key names.
Low cardinality key names.
Configuration options for the ChatClient request.
Utilities to work with advisors.
Base advisor that implements common aspects of the
CallAdvisor and
StreamAdvisor, reducing the boilerplate code needed to implement an advisor.A base interface for advisor chains that can be used to chain multiple advisors
together, both for call and stream advisors.
Builder for creating a
BaseAdvisorChain instance.Base interface for chat memory advisors.
Advisor for execution flows ultimately resulting in a call to an AI model
A chain of
CallAdvisor instances orchestrating the execution of a
ChatClientRequest on the next CallAdvisor in the chain.Client to perform stateless requests to an AI Model, using a fluent API.
A mutable builder for creating a
ChatClient.Configures optional behaviour for
entity(...) calls.Specification for a prompt system.
Common attributes used in
ChatClient context.Callback interface that can be used to customize a
ChatClient.Builder.Handler for emitting the chat client completion content to logs.
Deprecated, for removal: This API element is subject to removal in a future version.
Helper that for streaming chat responses, aggregate the chat response messages into a
single AssistantMessage.
Context used to store metadata for chat client workflows.
Interface for an
ObservationConvention for chat client workflows.Documented conventions for chat client observations.
Handler for emitting the chat client prompt content to logs.
Represents a request processed by a
ChatClient that ultimately is used to build
a Prompt to be sent to an AI model.Represents a response returned by a
ChatClient.A
CallAdvisor that uses a ChatModel to generate a response.A
StreamAdvisor that uses a ChatModel to generate a streaming response.Default implementation of the
AdvisorObservationConvention.Default implementation for the
BaseAdvisorChain.The default implementation of
ChatClient as created by the
ChatClient.Builder.build() } method.Default implementation of
ChatClient.EntityParamSpec.DefaultChatClientBuilder is a builder class for creating a ChatClient.
Default conventions to populate observations for chat client workflows.
Implementation of
Evaluator used to evaluate the factual accuracy of Large
Language Model (LLM) responses against provided context.Returns a new list of content (e.g list of messages of list of documents) that is a
subset of the input list of contents and complies with the max token size constraint.
Marker interface for advisors that own the memory lifecycle.
Memory is retrieved added as a collection of messages to the prompt
Evaluates the relevancy of a response to a query based on the context provided.
Represents a
Model response that includes the
entire response along with the specified response entity type.An advisor that blocks the call to the model provider if the user input contains any of
the sensitive words.
A simple logger advisor that logs the request and response messages.
Advisor for execution flows ultimately resulting in a streaming call to an AI model.
A chain of
StreamAdvisor instances orchestrating the execution of a
ChatClientRequest on the next StreamAdvisor in the chain.Advisor that validates the structured JSON output of a chat client response against a
JSON schema derived from the configured output type or a pre-supplied schema string.
Builder for
StructuredOutputValidationAdvisor.Marker interface for advisors that own the tool-call lifecycle.
Deprecated, for removal: This API element is subject to removal in a future version.
since 2.0.0 in favor of
ToolCallingAdvisor.Deprecated, for removal: This API element is subject to removal in a future version.
since 2.0.0 in favor of
ToolCallingAdvisor.Builder.Recursive Advisor that disables the internal tool execution flow and instead implements
the tool calling loop as part of the advisor chain.
Builder for creating instances of ToolCallingAdvisor.
ChatClientBuilderCustomizer