182 строки
17 KiB
YAML
182 строки
17 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.search.documents.models.SemanticSearchOptions"
|
|
fullName: "com.azure.search.documents.models.SemanticSearchOptions"
|
|
name: "SemanticSearchOptions"
|
|
nameWithType: "SemanticSearchOptions"
|
|
summary: "Parameters for performing vector searches."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **SemanticSearchOptions**"
|
|
constructors:
|
|
- uid: "com.azure.search.documents.models.SemanticSearchOptions.SemanticSearchOptions()"
|
|
fullName: "com.azure.search.documents.models.SemanticSearchOptions.SemanticSearchOptions()"
|
|
name: "SemanticSearchOptions()"
|
|
nameWithType: "SemanticSearchOptions.SemanticSearchOptions()"
|
|
summary: "Creates a new instance of <xref uid=\"com.azure.search.documents.models.SemanticSearchOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SemanticSearchOptions\"></xref>."
|
|
syntax: "public SemanticSearchOptions()"
|
|
desc: "Creates a new instance of <xref uid=\"com.azure.search.documents.models.SemanticSearchOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SemanticSearchOptions\"></xref>."
|
|
methods:
|
|
- uid: "com.azure.search.documents.models.SemanticSearchOptions.getErrorMode()"
|
|
fullName: "com.azure.search.documents.models.SemanticSearchOptions.getErrorMode()"
|
|
name: "getErrorMode()"
|
|
nameWithType: "SemanticSearchOptions.getErrorMode()"
|
|
summary: "Get the semantic<wbr>Error<wbr>Handling property: Allows the user to choose whether a semantic call should fail completely, or to return partial results."
|
|
syntax: "public SemanticErrorMode getErrorMode()"
|
|
desc: "Get the semanticErrorHandling property: Allows the user to choose whether a semantic call should fail completely, or to return partial results."
|
|
returns:
|
|
description: "the semanticErrorHandling value."
|
|
type: "<xref href=\"com.azure.search.documents.models.SemanticErrorMode?alt=com.azure.search.documents.models.SemanticErrorMode&text=SemanticErrorMode\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.models.SemanticSearchOptions.getMaxWaitDuration()"
|
|
fullName: "com.azure.search.documents.models.SemanticSearchOptions.getMaxWaitDuration()"
|
|
name: "getMaxWaitDuration()"
|
|
nameWithType: "SemanticSearchOptions.getMaxWaitDuration()"
|
|
summary: "Get the semantic<wbr>Max<wbr>Wait<wbr>InMilliseconds property: Allows the user to set an upper bound on the amount of time it takes for semantic enrichment to finish processing before the request fails."
|
|
syntax: "public Duration getMaxWaitDuration()"
|
|
desc: "Get the semanticMaxWaitInMilliseconds property: Allows the user to set an upper bound on the amount of time it takes for semantic enrichment to finish processing before the request fails."
|
|
returns:
|
|
description: "the semanticMaxWaitDuration value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.azure.search.documents.models.SemanticSearchOptions.getQueryAnswer()"
|
|
fullName: "com.azure.search.documents.models.SemanticSearchOptions.getQueryAnswer()"
|
|
name: "getQueryAnswer()"
|
|
nameWithType: "SemanticSearchOptions.getQueryAnswer()"
|
|
summary: "Get the answers property: This parameter is only valid if the query type is 'semantic'."
|
|
syntax: "public QueryAnswer getQueryAnswer()"
|
|
desc: "Get the answers property: This parameter is only valid if the query type is 'semantic'. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character '|' followed by the 'count-<number of answers>' option after the answers parameter value, such as 'extractive|count-3'. Default count is 1. The confidence threshold can be configured by appending the pipe character '|' followed by the 'threshold-<confidence threshold>' option after the answers parameter value, such as 'extractive|threshold-0.9'. Default threshold is 0.7."
|
|
returns:
|
|
description: "the answers value."
|
|
type: "<xref href=\"com.azure.search.documents.models.QueryAnswer?alt=com.azure.search.documents.models.QueryAnswer&text=QueryAnswer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.models.SemanticSearchOptions.getQueryCaption()"
|
|
fullName: "com.azure.search.documents.models.SemanticSearchOptions.getQueryCaption()"
|
|
name: "getQueryCaption()"
|
|
nameWithType: "SemanticSearchOptions.getQueryCaption()"
|
|
summary: "Get the query caption property: This parameter is only valid if the query type is 'semantic'."
|
|
syntax: "public QueryCaption getQueryCaption()"
|
|
desc: "Get the query caption property: This parameter is only valid if the query type is 'semantic'. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to 'extractive', highlighting is enabled by default, and can be configured by appending the pipe character '|' followed by the 'highlight-<true/false>' option, such as 'extractive|highlight-true'. Defaults to 'None'."
|
|
returns:
|
|
description: "the query caption value."
|
|
type: "<xref href=\"com.azure.search.documents.models.QueryCaption?alt=com.azure.search.documents.models.QueryCaption&text=QueryCaption\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.models.SemanticSearchOptions.getSemanticConfigurationName()"
|
|
fullName: "com.azure.search.documents.models.SemanticSearchOptions.getSemanticConfigurationName()"
|
|
name: "getSemanticConfigurationName()"
|
|
nameWithType: "SemanticSearchOptions.getSemanticConfigurationName()"
|
|
summary: "Get the semantic<wbr>Configuration<wbr>Name property: The name of the semantic configuration that lists which fields should be used for semantic ranking, captions, highlights, and answers."
|
|
syntax: "public String getSemanticConfigurationName()"
|
|
desc: "Get the semanticConfigurationName property: The name of the semantic configuration that lists which fields should be used for semantic ranking, captions, highlights, and answers."
|
|
returns:
|
|
description: "the semanticConfigurationName value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.search.documents.models.SemanticSearchOptions.getSemanticQuery()"
|
|
fullName: "com.azure.search.documents.models.SemanticSearchOptions.getSemanticQuery()"
|
|
name: "getSemanticQuery()"
|
|
nameWithType: "SemanticSearchOptions.getSemanticQuery()"
|
|
summary: "Get the semantic<wbr>Query property: Allows setting a separate search query that will be solely used for semantic reranking, semantic captions and semantic answers."
|
|
syntax: "public String getSemanticQuery()"
|
|
desc: "Get the semanticQuery property: Allows setting a separate search query that will be solely used for semantic reranking, semantic captions and semantic answers. Is useful for scenarios where there is a need to use different queries between the base retrieval and ranking phase, and the L2 semantic phase."
|
|
returns:
|
|
description: "the semanticQuery value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.search.documents.models.SemanticSearchOptions.setErrorMode(com.azure.search.documents.models.SemanticErrorMode)"
|
|
fullName: "com.azure.search.documents.models.SemanticSearchOptions.setErrorMode(SemanticErrorMode errorMode)"
|
|
name: "setErrorMode(SemanticErrorMode errorMode)"
|
|
nameWithType: "SemanticSearchOptions.setErrorMode(SemanticErrorMode errorMode)"
|
|
summary: "Set the semantic<wbr>Error<wbr>Handling property: Allows the user to choose whether a semantic call should fail completely, or to return partial results."
|
|
parameters:
|
|
- description: "the semanticErrorHandling value to set."
|
|
name: "errorMode"
|
|
type: "<xref href=\"com.azure.search.documents.models.SemanticErrorMode?alt=com.azure.search.documents.models.SemanticErrorMode&text=SemanticErrorMode\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public SemanticSearchOptions setErrorMode(SemanticErrorMode errorMode)"
|
|
desc: "Set the semanticErrorHandling property: Allows the user to choose whether a semantic call should fail completely, or to return partial results."
|
|
returns:
|
|
description: "the SemanticSearchOptions object itself."
|
|
type: "<xref href=\"com.azure.search.documents.models.SemanticSearchOptions?alt=com.azure.search.documents.models.SemanticSearchOptions&text=SemanticSearchOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.models.SemanticSearchOptions.setMaxWaitDuration(java.time.Duration)"
|
|
fullName: "com.azure.search.documents.models.SemanticSearchOptions.setMaxWaitDuration(Duration maxWaitDuration)"
|
|
name: "setMaxWaitDuration(Duration maxWaitDuration)"
|
|
nameWithType: "SemanticSearchOptions.setMaxWaitDuration(Duration maxWaitDuration)"
|
|
summary: "Set the semantic<wbr>Max<wbr>Wait<wbr>Duration property: Allows the user to set an upper bound on the amount of time it takes for semantic enrichment to finish processing before the request fails."
|
|
parameters:
|
|
- description: "the semanticMaxWaitInMilliseconds value to set."
|
|
name: "maxWaitDuration"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public SemanticSearchOptions setMaxWaitDuration(Duration maxWaitDuration)"
|
|
desc: "Set the semanticMaxWaitDuration property: Allows the user to set an upper bound on the amount of time it takes for semantic enrichment to finish processing before the request fails."
|
|
returns:
|
|
description: "the SemanticSearchOptions object itself."
|
|
type: "<xref href=\"com.azure.search.documents.models.SemanticSearchOptions?alt=com.azure.search.documents.models.SemanticSearchOptions&text=SemanticSearchOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.models.SemanticSearchOptions.setQueryAnswer(com.azure.search.documents.models.QueryAnswer)"
|
|
fullName: "com.azure.search.documents.models.SemanticSearchOptions.setQueryAnswer(QueryAnswer queryAnswer)"
|
|
name: "setQueryAnswer(QueryAnswer queryAnswer)"
|
|
nameWithType: "SemanticSearchOptions.setQueryAnswer(QueryAnswer queryAnswer)"
|
|
summary: "Set the answers property: This parameter is only valid if the query type is 'semantic'."
|
|
parameters:
|
|
- description: "the answers value to set."
|
|
name: "queryAnswer"
|
|
type: "<xref href=\"com.azure.search.documents.models.QueryAnswer?alt=com.azure.search.documents.models.QueryAnswer&text=QueryAnswer\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public SemanticSearchOptions setQueryAnswer(QueryAnswer queryAnswer)"
|
|
desc: "Set the answers property: This parameter is only valid if the query type is 'semantic'. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character '|' followed by the 'count-<number of answers>' option after the answers parameter value, such as 'extractive|count-3'. Default count is 1. The confidence threshold can be configured by appending the pipe character '|' followed by the 'threshold-<confidence threshold>' option after the answers parameter value, such as 'extractive|threshold-0.9'. Default threshold is 0.7."
|
|
returns:
|
|
description: "the SemanticSearchOptions object itself."
|
|
type: "<xref href=\"com.azure.search.documents.models.SemanticSearchOptions?alt=com.azure.search.documents.models.SemanticSearchOptions&text=SemanticSearchOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.models.SemanticSearchOptions.setQueryCaption(com.azure.search.documents.models.QueryCaption)"
|
|
fullName: "com.azure.search.documents.models.SemanticSearchOptions.setQueryCaption(QueryCaption queryCaption)"
|
|
name: "setQueryCaption(QueryCaption queryCaption)"
|
|
nameWithType: "SemanticSearchOptions.setQueryCaption(QueryCaption queryCaption)"
|
|
summary: "Set the query caption property: This parameter is only valid if the query type is 'semantic'."
|
|
parameters:
|
|
- description: "the query caption value to set."
|
|
name: "queryCaption"
|
|
type: "<xref href=\"com.azure.search.documents.models.QueryCaption?alt=com.azure.search.documents.models.QueryCaption&text=QueryCaption\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public SemanticSearchOptions setQueryCaption(QueryCaption queryCaption)"
|
|
desc: "Set the query caption property: This parameter is only valid if the query type is 'semantic'. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to 'extractive', highlighting is enabled by default, and can be configured by appending the pipe character '|' followed by the 'highlight-<true/false>' option, such as 'extractive|highlight-true'. Defaults to 'None'."
|
|
returns:
|
|
description: "the SemanticSearchOptions object itself."
|
|
type: "<xref href=\"com.azure.search.documents.models.SemanticSearchOptions?alt=com.azure.search.documents.models.SemanticSearchOptions&text=SemanticSearchOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.models.SemanticSearchOptions.setSemanticConfigurationName(java.lang.String)"
|
|
fullName: "com.azure.search.documents.models.SemanticSearchOptions.setSemanticConfigurationName(String semanticConfigurationName)"
|
|
name: "setSemanticConfigurationName(String semanticConfigurationName)"
|
|
nameWithType: "SemanticSearchOptions.setSemanticConfigurationName(String semanticConfigurationName)"
|
|
summary: "Set the semantic<wbr>Configuration<wbr>Name property: The name of the semantic configuration that lists which fields should be used for semantic ranking, captions, highlights, and answers."
|
|
parameters:
|
|
- description: "the semanticConfigurationName value to set."
|
|
name: "semanticConfigurationName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public SemanticSearchOptions setSemanticConfigurationName(String semanticConfigurationName)"
|
|
desc: "Set the semanticConfigurationName property: The name of the semantic configuration that lists which fields should be used for semantic ranking, captions, highlights, and answers."
|
|
returns:
|
|
description: "the SemanticSearchOptions object itself."
|
|
type: "<xref href=\"com.azure.search.documents.models.SemanticSearchOptions?alt=com.azure.search.documents.models.SemanticSearchOptions&text=SemanticSearchOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.models.SemanticSearchOptions.setSemanticQuery(java.lang.String)"
|
|
fullName: "com.azure.search.documents.models.SemanticSearchOptions.setSemanticQuery(String semanticQuery)"
|
|
name: "setSemanticQuery(String semanticQuery)"
|
|
nameWithType: "SemanticSearchOptions.setSemanticQuery(String semanticQuery)"
|
|
summary: "Set the semantic<wbr>Query property: Allows setting a separate search query that will be solely used for semantic reranking, semantic captions and semantic answers."
|
|
parameters:
|
|
- description: "the semanticQuery value to set."
|
|
name: "semanticQuery"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public SemanticSearchOptions setSemanticQuery(String semanticQuery)"
|
|
desc: "Set the semanticQuery property: Allows setting a separate search query that will be solely used for semantic reranking, semantic captions and semantic answers. Is useful for scenarios where there is a need to use different queries between the base retrieval and ranking phase, and the L2 semantic phase."
|
|
returns:
|
|
description: "the SemanticSearchOptions object itself."
|
|
type: "<xref href=\"com.azure.search.documents.models.SemanticSearchOptions?alt=com.azure.search.documents.models.SemanticSearchOptions&text=SemanticSearchOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Parameters for performing vector searches."
|
|
metadata: {}
|
|
package: "com.azure.search.documents.models"
|
|
artifact: com.azure:azure-search-documents:11.7.3
|