Response Synthesizer

class llama_index.indices.query.response_synthesis.ResponseSynthesizer(response_builder: Optional[BaseResponseBuilder], response_mode: ResponseMode, response_kwargs: Optional[Dict] = None, optimizer: Optional[BaseTokenUsageOptimizer] = None, node_postprocessors: Optional[List[BaseNodePostprocessor]] = None, verbose: bool = False)

Response synthesize class.

This class is responsible for synthesizing a response given a list of nodes. The way in which the response is synthesized depends on the response mode.

Parameters

  • response_builder (Optional[BaseResponseBuilder]) – A response builder object.

  • response_mode (ResponseMode) – A response mode.

  • response_kwargs (Optional[Dict]) – A dictionary of response kwargs.

  • optimizer (Optional[BaseTokenUsageOptimizer]) – A token usage optimizer.

  • node_postprocessors (Optional[List[BaseNodePostprocessor]]) – A list of node postprocessors.

  • verbose (bool) – Whether to print debug statements.

classmethod from_args(service_context: Optional[ServiceContext] = None, streaming: bool = False, use_async: bool = False, text_qa_template: Optional[QuestionAnswerPrompt] = None, refine_template: Optional[RefinePrompt] = None, simple_template: Optional[SimpleInputPrompt] = None, response_mode: ResponseMode = ResponseMode.COMPACT, response_kwargs: Optional[Dict] = None, node_postprocessors: Optional[List[BaseNodePostprocessor]] = None, optimizer: Optional[BaseTokenUsageOptimizer] = None, verbose: bool = False) → ResponseSynthesizer

Initialize response synthesizer from args.

Parameters

  • service_context (Optional[ServiceContext]) – A service context.

  • streaming (bool) – Whether to stream the response.

  • use_async (bool) – Whether to use async.

  • text_qa_template (Optional[QuestionAnswerPrompt]) – A text QA template.

  • refine_template (Optional[RefinePrompt]) – A refine template.

  • simple_template (Optional[SimpleInputPrompt]) – A simple template.

  • response_mode (ResponseMode) – A response mode.

  • response_kwargs (Optional[Dict]) – A dictionary of response kwargs.

  • node_postprocessors (Optional[List[BaseNodePostprocessor]]) – A list of node postprocessors.

  • optimizer (Optional[BaseTokenUsageOptimizer]) – A token usage optimizer.

  • verbose (bool) – Whether to print debug statements.