类的使用
io.agentscope.core.model.GenerateOptions

使用GenerateOptions的程序包

程序包	说明
io.agentscope.core
io.agentscope.core.agent
io.agentscope.core.formatter
io.agentscope.core.formatter.anthropic
io.agentscope.core.formatter.dashscope
io.agentscope.core.formatter.gemini
io.agentscope.core.formatter.ollama
io.agentscope.core.formatter.openai
io.agentscope.core.hook
io.agentscope.core.model
io.agentscope.core.model.ollama
io.agentscope.core.tracing

io.agentscope.core中GenerateOptions的使用

返回GenerateOptions的io.agentscope.core中的方法

修饰符和类型	方法	说明
protected GenerateOptions	ReActAgent.buildGenerateOptions()

io.agentscope.core.agent中GenerateOptions的使用

返回GenerateOptions的io.agentscope.core.agent中的方法

修饰符和类型	方法	说明
protected abstract GenerateOptions	StructuredOutputCapableAgent.buildGenerateOptions()	Build generate options for model calls.

参数类型为GenerateOptions的io.agentscope.core.agent中的构造器

限定符	构造器	说明
	StructuredOutputHook(StructuredOutputReminder reminderMode, GenerateOptions baseOptions, Memory memory)	Creates a new StructuredOutputHook.

io.agentscope.core.formatter中GenerateOptions的使用

参数类型为GenerateOptions的io.agentscope.core.formatter中的方法

修饰符和类型	方法	说明
void	Formatter.applyOptions(TParams paramsBuilder, GenerateOptions options, GenerateOptions defaultOptions)	Apply generation options to provider-specific request parameters.
protected <T> T	AbstractBaseFormatter.getOptionOrDefault(GenerateOptions options, GenerateOptions defaultOptions, Function<GenerateOptions,T> getter)	Get an option value from options or fall back to defaultOptions.

类型变量类型为GenerateOptions的io.agentscope.core.formatter中的方法参数

修饰符和类型	方法	说明
protected <T> T	AbstractBaseFormatter.getOptionOrDefault(GenerateOptions options, GenerateOptions defaultOptions, Function<GenerateOptions,T> getter)	Get an option value from options or fall back to defaultOptions.

io.agentscope.core.formatter.anthropic中GenerateOptions的使用

参数类型为GenerateOptions的io.agentscope.core.formatter.anthropic中的方法

修饰符和类型	方法	说明
void	AnthropicBaseFormatter.applyOptions(com.anthropic.models.messages.MessageCreateParams.Builder paramsBuilder, GenerateOptions options, GenerateOptions defaultOptions)	Apply generation options to Anthropic request parameters.
static void	AnthropicToolsHelper.applyOptions(com.anthropic.models.messages.MessageCreateParams.Builder builder, GenerateOptions options, GenerateOptions defaultOptions)	Apply generation options to the builder.
static void	AnthropicToolsHelper.applyTools(com.anthropic.models.messages.MessageCreateParams.Builder builder, List<ToolSchema> tools, GenerateOptions options)	Apply tools to the message create params builder.

io.agentscope.core.formatter.dashscope中GenerateOptions的使用

参数类型为GenerateOptions的io.agentscope.core.formatter.dashscope中的方法

修饰符和类型	方法	说明
void	DashScopeChatFormatter.applyOptions(DashScopeRequest request, GenerateOptions options, GenerateOptions defaultOptions)
void	DashScopeMultiAgentFormatter.applyOptions(DashScopeRequest request, GenerateOptions options, GenerateOptions defaultOptions)
void	DashScopeToolsHelper.applyOptions(DashScopeParameters params, GenerateOptions options, GenerateOptions defaultOptions)	Apply GenerateOptions to DashScopeParameters.
DashScopeRequest	DashScopeChatFormatter.buildRequest(String model, List<DashScopeMessage> messages, boolean stream, GenerateOptions options, GenerateOptions defaultOptions, List<ToolSchema> tools, ToolChoice toolChoice)	Build a complete DashScopeRequest with full configuration.
Map<String,Object>	DashScopeToolsHelper.mergeAdditionalBodyParams(GenerateOptions options, GenerateOptions defaultOptions)	Merge additional body parameters from options and default options.
Map<String,String>	DashScopeToolsHelper.mergeAdditionalHeaders(GenerateOptions options, GenerateOptions defaultOptions)	Merge additional headers from options and default options.
Map<String,String>	DashScopeToolsHelper.mergeAdditionalQueryParams(GenerateOptions options, GenerateOptions defaultOptions)	Merge additional query parameters from options and default options.

io.agentscope.core.formatter.gemini中GenerateOptions的使用

参数类型为GenerateOptions的io.agentscope.core.formatter.gemini中的方法

修饰符和类型	方法	说明
void	GeminiChatFormatter.applyOptions(com.google.genai.types.GenerateContentConfig.Builder configBuilder, GenerateOptions options, GenerateOptions defaultOptions)
void	GeminiMultiAgentFormatter.applyOptions(com.google.genai.types.GenerateContentConfig.Builder configBuilder, GenerateOptions options, GenerateOptions defaultOptions)

io.agentscope.core.formatter.ollama中GenerateOptions的使用

参数类型为GenerateOptions的io.agentscope.core.formatter.ollama中的方法

修饰符和类型	方法	说明
void	OllamaChatFormatter.applyOptions(OllamaRequest request, GenerateOptions options, GenerateOptions defaultOptions)
void	OllamaMultiAgentFormatter.applyOptions(OllamaRequest request, GenerateOptions options, GenerateOptions defaultOptions)
void	OllamaToolsHelper.applyOptions(OllamaRequest request, GenerateOptions options, GenerateOptions defaultOptions)	Apply GenerateOptions to OllamaRequest.

io.agentscope.core.formatter.openai中GenerateOptions的使用

参数类型为GenerateOptions的io.agentscope.core.formatter.openai中的方法

修饰符和类型	方法	说明
protected void	OpenAIChatFormatter.applyAdditionalBodyParams(OpenAIRequest request, GenerateOptions opts)	Apply additional body parameters from GenerateOptions to OpenAI request.
protected void	OpenAIChatFormatter.applyMaxTokens(OpenAIRequest request, GenerateOptions options, GenerateOptions defaultOptions)
abstract void	OpenAIBaseFormatter.applyOptions(OpenAIRequest request, GenerateOptions options, GenerateOptions defaultOptions)	Apply generation options to the request.
void	OpenAIChatFormatter.applyOptions(OpenAIRequest request, GenerateOptions options, GenerateOptions defaultOptions)
OpenAIRequest	OpenAIBaseFormatter.buildRequest(String model, List<OpenAIMessage> messages, boolean stream, GenerateOptions options, GenerateOptions defaultOptions, List<ToolSchema> tools, ToolChoice toolChoice)	Build a complete OpenAIRequest with full configuration.

io.agentscope.core.hook中GenerateOptions的使用

返回GenerateOptions的io.agentscope.core.hook中的方法

修饰符和类型	方法	说明
GenerateOptions	PreReasoningEvent.getEffectiveGenerateOptions()	Get the effective generation options.
GenerateOptions	PreSummaryEvent.getEffectiveGenerateOptions()	Get the effective generation options.
final GenerateOptions	ReasoningEvent.getGenerateOptions()	Get the generation options.
final GenerateOptions	SummaryEvent.getGenerateOptions()	Get the generation options.

参数类型为GenerateOptions的io.agentscope.core.hook中的方法

修饰符和类型	方法	说明
void	PreReasoningEvent.setGenerateOptions(GenerateOptions generateOptions)	Set custom generation options for this reasoning call.
void	PreSummaryEvent.setGenerateOptions(GenerateOptions generateOptions)	Set custom generation options for this summary call.

参数类型为GenerateOptions的io.agentscope.core.hook中的构造器

限定符	构造器	说明
	PostReasoningEvent(Agent agent, String modelName, GenerateOptions generateOptions, Msg reasoningMessage)	Constructor for PostReasoningEvent.
	PostSummaryEvent(Agent agent, String modelName, GenerateOptions generateOptions, Msg summaryMessage)	Constructor for PostSummaryEvent.
	PreReasoningEvent(Agent agent, String modelName, GenerateOptions generateOptions, List<Msg> inputMessages)	Constructor for PreReasoningEvent.
	PreSummaryEvent(Agent agent, String modelName, GenerateOptions generateOptions, List<Msg> inputMessages, int maxIterations, int currentIteration)	Constructor for PreSummaryEvent.
	ReasoningChunkEvent(Agent agent, String modelName, GenerateOptions generateOptions, Msg incrementalChunk, Msg accumulated)	Constructor for ReasoningChunkEvent.
protected	ReasoningEvent(HookEventType type, Agent agent, String modelName, GenerateOptions generateOptions)	Constructor for ReasoningEvent.
	SummaryChunkEvent(Agent agent, String modelName, GenerateOptions generateOptions, Msg incrementalChunk, Msg accumulated)	Constructor for SummaryChunkEvent.
protected	SummaryEvent(HookEventType type, Agent agent, String modelName, GenerateOptions generateOptions)	Constructor for SummaryEvent.

io.agentscope.core.model中GenerateOptions的使用

返回GenerateOptions的io.agentscope.core.model中的方法

修饰符和类型	方法	说明
GenerateOptions	GenerateOptions.Builder.build()	Builds a new GenerateOptions instance with the set values.
static GenerateOptions	ModelUtils.ensureDefaultExecutionConfig(GenerateOptions options)	Ensures GenerateOptions has MODEL_DEFAULTS for executionConfig applied.
static GenerateOptions	GenerateOptions.mergeOptions(GenerateOptions primary, GenerateOptions fallback)	Merges two GenerateOptions instances, with primary options taking precedence.

参数类型为GenerateOptions的io.agentscope.core.model中的方法

修饰符和类型	方法	说明
static reactor.core.publisher.Flux<ChatResponse>	ModelUtils.applyTimeoutAndRetry(reactor.core.publisher.Flux<ChatResponse> responseFlux, GenerateOptions options, GenerateOptions defaultOptions, String modelName, String provider)	Applies timeout and retry configuration to a model response Flux.
OpenAIResponse	OpenAIClient.call(String apiKey, String baseUrl, OpenAIRequest request, GenerateOptions options)	Make a synchronous API call with options.
String	OpenAIClient.callApi(String apiKey, String baseUrl, String endpoint, Object requestBody, GenerateOptions options)	Make a generic API call to any OpenAI endpoint with JSON request body and custom options.
ChatResponse	OllamaChatModel.chat(List<Msg> messages, GenerateOptions options)	Chat with the model using default options.
AnthropicChatModel.Builder	AnthropicChatModel.Builder.defaultOptions(GenerateOptions defaultOptions)	Sets default generation options.
DashScopeChatModel.Builder	DashScopeChatModel.Builder.defaultOptions(GenerateOptions options)	Sets the default generation options.
GeminiChatModel.Builder	GeminiChatModel.Builder.defaultOptions(GenerateOptions defaultOptions)	Sets the default generation options.
protected reactor.core.publisher.Flux<ChatResponse>	AnthropicChatModel.doStream(List<Msg> messages, List<ToolSchema> tools, GenerateOptions options)	Stream chat completion responses from Anthropic's API.
protected abstract reactor.core.publisher.Flux<ChatResponse>	ChatModelBase.doStream(List<Msg> messages, List<ToolSchema> tools, GenerateOptions options)	Internal implementation for streaming chat completion responses.
protected reactor.core.publisher.Flux<ChatResponse>	DashScopeChatModel.doStream(List<Msg> messages, List<ToolSchema> tools, GenerateOptions options)	Stream chat completion responses from DashScope's API.
protected reactor.core.publisher.Flux<ChatResponse>	GeminiChatModel.doStream(List<Msg> messages, List<ToolSchema> tools, GenerateOptions options)	Stream chat completion responses from Gemini's API.
protected reactor.core.publisher.Flux<ChatResponse>	OllamaChatModel.doStream(List<Msg> messages, List<ToolSchema> tools, GenerateOptions options)
protected reactor.core.publisher.Flux<ChatResponse>	OpenAIChatModel.doStream(List<Msg> messages, List<ToolSchema> tools, GenerateOptions options)
protected reactor.core.publisher.Flux<ChatResponse>	OpenAIChatModel.doStream0(List<Msg> messages, List<ToolSchema> tools, GenerateOptions options)
static GenerateOptions	ModelUtils.ensureDefaultExecutionConfig(GenerateOptions options)	Ensures GenerateOptions has MODEL_DEFAULTS for executionConfig applied.
OpenAIChatModel.Builder	OpenAIChatModel.Builder.generateOptions(GenerateOptions options)	Sets the default generation options.
static GenerateOptions	GenerateOptions.mergeOptions(GenerateOptions primary, GenerateOptions fallback)	Merges two GenerateOptions instances, with primary options taking precedence.
final reactor.core.publisher.Flux<ChatResponse>	ChatModelBase.stream(List<Msg> messages, List<ToolSchema> tools, GenerateOptions options)	Stream chat completion responses.
reactor.core.publisher.Flux<ChatResponse>	Model.stream(List<Msg> messages, List<ToolSchema> tools, GenerateOptions options)	Stream chat completion responses.
reactor.core.publisher.Flux<OpenAIResponse>	OpenAIClient.stream(String apiKey, String baseUrl, OpenAIRequest request, GenerateOptions options)	Make a streaming API call with options for headers and query params.

参数类型为GenerateOptions的io.agentscope.core.model中的构造器

限定符	构造器	说明
	AnthropicChatModel(String baseUrl, String apiKey, String modelName, boolean streamEnabled, GenerateOptions defaultOptions, AnthropicBaseFormatter formatter)	Creates a new Anthropic chat model instance.
	DashScopeChatModel(String apiKey, String modelName, boolean stream, Boolean enableThinking, Boolean enableSearch, EndpointType endpointType, GenerateOptions defaultOptions, String baseUrl, Formatter<DashScopeMessage,DashScopeResponse,DashScopeRequest> formatter, HttpTransport httpTransport, String publicKeyId, String publicKey)	Creates a new DashScope chat model instance with explicit API type.
	DashScopeChatModel(String apiKey, String modelName, boolean stream, Boolean enableThinking, Boolean enableSearch, GenerateOptions defaultOptions, String baseUrl, Formatter<DashScopeMessage,DashScopeResponse,DashScopeRequest> formatter, HttpTransport httpTransport, String publicKeyId, String publicKey)	Creates a new DashScope chat model instance with automatic API type detection.
	GeminiChatModel(String apiKey, String modelName, boolean streamEnabled, String project, String location, Boolean vertexAI, com.google.genai.types.HttpOptions httpOptions, com.google.auth.oauth2.GoogleCredentials credentials, com.google.genai.types.ClientOptions clientOptions, GenerateOptions defaultOptions, Formatter<com.google.genai.types.Content,com.google.genai.types.GenerateContentResponse,com.google.genai.types.GenerateContentConfig.Builder> formatter)	Creates a new Gemini chat model instance.

io.agentscope.core.model.ollama中GenerateOptions的使用

返回GenerateOptions的io.agentscope.core.model.ollama中的方法

修饰符和类型	方法	说明
GenerateOptions	OllamaOptions.toGenerateOptions()	Converts this OllamaOptions to generic GenerateOptions.

参数类型为GenerateOptions的io.agentscope.core.model.ollama中的方法

修饰符和类型	方法	说明
static OllamaOptions	OllamaOptions.fromGenerateOptions(GenerateOptions genOptions)	Converts generic GenerateOptions to OllamaOptions.
OllamaOptions	OllamaOptions.merge(GenerateOptions other)	Merges the given GenerateOptions into a new instance, with the given options taking precedence.

io.agentscope.core.tracing中GenerateOptions的使用

参数类型为GenerateOptions的io.agentscope.core.tracing中的方法

修饰符和类型	方法	说明
default reactor.core.publisher.Flux<ChatResponse>	Tracer.callModel(ChatModelBase instance, List<Msg> inputMessages, List<ToolSchema> toolSchemas, GenerateOptions options, Supplier<reactor.core.publisher.Flux<ChatResponse>> modelCall)