DashScopeSearchOptions
@JsonInclude(JsonInclude.Include.NON_NULL) public class DashScopeSearchOptionsio/agentscope/extensions/model/dashscope/dto/DashScopeSearchOptions.java:40–241DashScope 搜索选项，保存相关配置项。位于 io.agentscope.extensions.model.dashscope.dto 包。核心成员包括 getEnableSource、setEnableSource、getEnableCitation、setEnableCitation、getCitationFormat、setCitationFormat。
DashScope search options DTO.
This class represents the search strategy configuration in a DashScope API request. It is used to control internet search behavior when enable_search is true.
Example JSON:
`{
"enable_source": true,
"enable_citation": true,
"citation_format": "[<number>]",
"forced_search": false,
"search_strategy": "turbo",
"enable_search_extension": false,
"prepend_search_result": false
}
`
嵌套类摘要Nested Class Summary
| 类Class | 类型Kind | 说明Description |
|---|---|---|
SearchStrategy | 枚举enum | 定义搜索 Strategy相关取值的枚举。 A enum in io.agentscope.extensions.model.dashscope.dto that defines enum values used when components talks to model services and returns generated or embedded output. |
Builder | 类class | 构建器，用于构建并配置目标实例。 A class in io.agentscope.extensions.model.dashscope.dto that talks to model services and returns generated or embedded output. |
构造器摘要Constructor Summary
| 构造器Constructor | 说明Description |
|---|---|
public DashScopeSearchOptions() | 初始化 `DashScopeSearchOptions` 实例。 Creates a new instance. |
方法摘要Method Summary
构造器详情Constructor Detail
DashScopeSearchOptions
public DashScopeSearchOptions()初始化 DashScopeSearchOptions 实例。
Creates a new instance.
io/agentscope/extensions/model/dashscope/dto/DashScopeSearchOptions.java:99方法详情Method Detail
getEnableSource
public Boolean getEnableSource()获取启用来源。
Returns the enable source.
Booleanio/agentscope/extensions/model/dashscope/dto/DashScopeSearchOptions.java:101–103setEnableSource
public void setEnableSource(Boolean enableSource)设置启用来源。
Sets the enable source.
| 名称Name | 类型Type | 说明Description |
|---|---|---|
enableSource | Boolean | 启用来源（类型 `Boolean`）。The enable source. |
io/agentscope/extensions/model/dashscope/dto/DashScopeSearchOptions.java:105–107getEnableCitation
public Boolean getEnableCitation()获取 getEnableCitation。
Returns the enable citation.
Booleanio/agentscope/extensions/model/dashscope/dto/DashScopeSearchOptions.java:109–111setEnableCitation
public void setEnableCitation(Boolean enableCitation)设置 setEnableCitation。
Sets the enable citation.
| 名称Name | 类型Type | 说明Description |
|---|---|---|
enableCitation | Boolean | 启用 Citation（类型 `Boolean`）。The enable citation. |
io/agentscope/extensions/model/dashscope/dto/DashScopeSearchOptions.java:113–115getCitationFormat
public String getCitationFormat()获取 getCitationFormat。
Returns the citation format.
Stringio/agentscope/extensions/model/dashscope/dto/DashScopeSearchOptions.java:117–119setCitationFormat
public void setCitationFormat(String citationFormat)设置 setCitationFormat。
Sets the citation format.
| 名称Name | 类型Type | 说明Description |
|---|---|---|
citationFormat | String | citation 格式（类型 `String`）。The citation format. |
io/agentscope/extensions/model/dashscope/dto/DashScopeSearchOptions.java:121–123getForcedSearch
public Boolean getForcedSearch()获取 getForcedSearch。
Returns the forced search.
Booleanio/agentscope/extensions/model/dashscope/dto/DashScopeSearchOptions.java:125–127setForcedSearch
public void setForcedSearch(Boolean forcedSearch)设置 setForcedSearch。
Sets the forced search.
| 名称Name | 类型Type | 说明Description |
|---|---|---|
forcedSearch | Boolean | forced 搜索（类型 `Boolean`）。The forced search. |
io/agentscope/extensions/model/dashscope/dto/DashScopeSearchOptions.java:129–131getSearchStrategy
public SearchStrategy getSearchStrategy()获取 getSearchStrategy。
Returns the search strategy.
SearchStrategyio/agentscope/extensions/model/dashscope/dto/DashScopeSearchOptions.java:133–135setSearchStrategy
public void setSearchStrategy(SearchStrategy searchStrategy)设置 setSearchStrategy。
Sets the search strategy.
| 名称Name | 类型Type | 说明Description |
|---|---|---|
searchStrategy | SearchStrategy | 搜索 Strategy（类型 `SearchStrategy`）。The search strategy. |
io/agentscope/extensions/model/dashscope/dto/DashScopeSearchOptions.java:137–139getEnableSearchExtension
public Boolean getEnableSearchExtension()获取启用搜索扩展。
Returns the enable search extension.
Booleanio/agentscope/extensions/model/dashscope/dto/DashScopeSearchOptions.java:141–143setEnableSearchExtension
public void setEnableSearchExtension(Boolean enableSearchExtension)设置启用搜索扩展。
Sets the enable search extension.
| 名称Name | 类型Type | 说明Description |
|---|---|---|
enableSearchExtension | Boolean | 启用搜索扩展（类型 `Boolean`）。The enable search extension. |
io/agentscope/extensions/model/dashscope/dto/DashScopeSearchOptions.java:145–147getPrependSearchResult
public Boolean getPrependSearchResult()获取 getPrependSearchResult。
Returns the prepend search result.
Booleanio/agentscope/extensions/model/dashscope/dto/DashScopeSearchOptions.java:149–151setPrependSearchResult
public void setPrependSearchResult(Boolean prependSearchResult)设置 setPrependSearchResult。
Sets the prepend search result.
| 名称Name | 类型Type | 说明Description |
|---|---|---|
prependSearchResult | Boolean | prepend 搜索结果（类型 `Boolean`）。The prepend search result. |
io/agentscope/extensions/model/dashscope/dto/DashScopeSearchOptions.java:153–155builder
public static Builder builder()返回构建器实例。
Returns the builder.
Builderio/agentscope/extensions/model/dashscope/dto/DashScopeSearchOptions.java:195–197嵌套类详情Nested Class Detail
SearchStrategy
public enum SearchStrategy定义搜索 Strategy相关取值的枚举。位于 io.agentscope.extensions.model.dashscope.dto 包。核心成员包括 TURBO、MAX、AGENT、AGENT_MAX。
A enum in io.agentscope.extensions.model.dashscope.dto that defines enum values used when components talks to model services and returns generated or embedded output. Declared in io.agentscope.extensions.model.dashscope.dto.
Builder
public static class Builder构建器，用于构建并配置目标实例。位于 io.agentscope.extensions.model.dashscope.dto 包。核心成员包括 enableSource、enableCitation、citationFormat、forcedSearch、searchStrategy、enableSearchExtension。
A class in io.agentscope.extensions.model.dashscope.dto that talks to model services and returns generated or embedded output. Declared in io.agentscope.extensions.model.dashscope.dto.