langchain.callbacks.streaming_stdout_final_only
.FinalStreamingStdOutCallbackHandler¶
- class langchain.callbacks.streaming_stdout_final_only.FinalStreamingStdOutCallbackHandler(*, answer_prefix_tokens: Optional[List[str]] = None, strip_tokens: bool = True, stream_prefix: bool = False)[source]¶
代理流处理程序的回调函数。 仅适用于支持流式处理的LLM代理。
仅代理的最终输出将被流式传输。
实例化FinalStreamingStdOutCallbackHandler。
- 参数:
- answer_prefix_tokens:前缀答案的标记序列。
默认值为[“Final”, “Answer”, “:”]
strip_tokens:在比较answer_prefix_tokens和最后一个标记时,是否忽略空格和换行符? stream_prefix:答案前缀本身是否也应该被流式传输?
Attributes
ignore_agent
是否忽略代理回调。
ignore_chain
是否忽略链式回调。
ignore_chat_model
是否忽略聊天模型的回调。
ignore_llm
是否忽略LLM回调。
ignore_retriever
是否忽略检索器回调函数。
ignore_retry
是否忽略重试回调。
raise_error
run_inline
Methods
__init__
(*[, answer_prefix_tokens, ...])实例化FinalStreamingStdOutCallbackHandler。
append_to_last_tokens
(token)on_agent_action
(action, **kwargs)在代理程序上运行的操作。
on_agent_finish
(finish, **kwargs)在代理端运行。
on_chain_end
(outputs, **kwargs)当链结束运行时运行。
on_chain_error
(error, **kwargs)当链式错误时运行。
on_chain_start
(serialized, inputs, **kwargs)当链开始运行时运行。
on_chat_model_start
(serialized, messages, ...)LLM 开始运行时运行。
on_llm_end
(response, **kwargs)当LLM运行结束时运行。
on_llm_error
(error, **kwargs)当LLM出现错误时运行。
on_llm_new_token
(token, **kwargs)在新的LLM令牌上运行。仅在流式处理启用时可用。
on_llm_start
(serialized, prompts, **kwargs)LLM 开始运行时运行。
on_retriever_end
(documents, *, run_id[, ...])当Retriever运行结束时运行。
on_retriever_error
(error, *, run_id[, ...])当Retriever出错时运行。
on_retriever_start
(serialized, query, *, run_id)当Retriever开始运行时运行。
on_retry
(retry_state, *, run_id[, parent_run_id])在重试事件上运行。
on_text
(text, **kwargs)在任意文本上运行。
on_tool_end
(output, **kwargs)当工具运行结束时运行。
on_tool_error
(error, **kwargs)当工具出现错误时运行。
on_tool_start
(serialized, input_str, **kwargs)当工具开始运行时运行。
- Parameters
answer_prefix_tokens (Optional[List[str]]) –
strip_tokens (bool) –
stream_prefix (bool) –
- Return type
None
- __init__(*, answer_prefix_tokens: Optional[List[str]] = None, strip_tokens: bool = True, stream_prefix: bool = False) None [source]¶
实例化FinalStreamingStdOutCallbackHandler。
- 参数:
- answer_prefix_tokens:前缀答案的标记序列。
默认值为[“Final”, “Answer”, “:”]
strip_tokens:在比较answer_prefix_tokens和最后一个标记时,是否忽略空格和换行符? stream_prefix:答案前缀本身是否也应该被流式传输?
- Parameters
answer_prefix_tokens (Optional[List[str]]) –
strip_tokens (bool) –
stream_prefix (bool) –
- Return type
None
- on_agent_action(action: AgentAction, **kwargs: Any) Any ¶
在代理程序上运行的操作。
- Parameters
action (AgentAction) –
kwargs (Any) –
- Return type
Any
- on_agent_finish(finish: AgentFinish, **kwargs: Any) None ¶
在代理端运行。
- Parameters
finish (AgentFinish) –
kwargs (Any) –
- Return type
None
- on_chain_end(outputs: Dict[str, Any], **kwargs: Any) None ¶
当链结束运行时运行。
- Parameters
outputs (Dict[str, Any]) –
kwargs (Any) –
- Return type
None
- on_chain_error(error: BaseException, **kwargs: Any) None ¶
当链式错误时运行。
- Parameters
error (BaseException) –
kwargs (Any) –
- Return type
None
- on_chain_start(serialized: Dict[str, Any], inputs: Dict[str, Any], **kwargs: Any) None ¶
当链开始运行时运行。
- Parameters
serialized (Dict[str, Any]) –
inputs (Dict[str, Any]) –
kwargs (Any) –
- Return type
None
- on_chat_model_start(serialized: Dict[str, Any], messages: List[List[BaseMessage]], **kwargs: Any) None ¶
LLM 开始运行时运行。
- Parameters
serialized (Dict[str, Any]) –
messages (List[List[BaseMessage]]) –
kwargs (Any) –
- Return type
None
- on_llm_end(response: LLMResult, **kwargs: Any) None ¶
当LLM运行结束时运行。
- Parameters
response (LLMResult) –
kwargs (Any) –
- Return type
None
- on_llm_error(error: BaseException, **kwargs: Any) None ¶
当LLM出现错误时运行。
- Parameters
error (BaseException) –
kwargs (Any) –
- Return type
None
- on_llm_new_token(token: str, **kwargs: Any) None [source]¶
在新的LLM令牌上运行。仅在流式处理启用时可用。
- Parameters
token (str) –
kwargs (Any) –
- Return type
None
- on_llm_start(serialized: Dict[str, Any], prompts: List[str], **kwargs: Any) None [source]¶
LLM 开始运行时运行。
- Parameters
serialized (Dict[str, Any]) –
prompts (List[str]) –
kwargs (Any) –
- Return type
None
- on_retriever_end(documents: Sequence[Document], *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) Any ¶
当Retriever运行结束时运行。
- Parameters
documents (Sequence[Document]) –
run_id (UUID) –
parent_run_id (Optional[UUID]) –
kwargs (Any) –
- Return type
Any
- on_retriever_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) Any ¶
当Retriever出错时运行。
- Parameters
error (BaseException) –
run_id (UUID) –
parent_run_id (Optional[UUID]) –
kwargs (Any) –
- Return type
Any
- on_retriever_start(serialized: Dict[str, Any], query: str, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) Any ¶
当Retriever开始运行时运行。
- Parameters
serialized (Dict[str, Any]) –
query (str) –
run_id (UUID) –
parent_run_id (Optional[UUID]) –
tags (Optional[List[str]]) –
metadata (Optional[Dict[str, Any]]) –
kwargs (Any) –
- Return type
Any
- on_retry(retry_state: RetryCallState, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) Any ¶
在重试事件上运行。
- Parameters
retry_state (RetryCallState) –
run_id (UUID) –
parent_run_id (Optional[UUID]) –
kwargs (Any) –
- Return type
Any
- on_text(text: str, **kwargs: Any) None ¶
在任意文本上运行。
- Parameters
text (str) –
kwargs (Any) –
- Return type
None
- on_tool_end(output: Any, **kwargs: Any) None ¶
当工具运行结束时运行。
- Parameters
output (Any) –
kwargs (Any) –
- Return type
None
- on_tool_error(error: BaseException, **kwargs: Any) None ¶
当工具出现错误时运行。
- Parameters
error (BaseException) –
kwargs (Any) –
- Return type
None
- on_tool_start(serialized: Dict[str, Any], input_str: str, **kwargs: Any) None ¶
当工具开始运行时运行。
- Parameters
serialized (Dict[str, Any]) –
input_str (str) –
kwargs (Any) –
- Return type
None