azure-docs-sdk-java/docs-ref-autogen/com.azure.search.documents....

86 строки
6.4 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.search.documents.models.SearchResult"
fullName: "com.azure.search.documents.models.SearchResult"
name: "SearchResult"
nameWithType: "SearchResult"
summary: "Contains a document found by a search query, plus associated metadata."
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 **SearchResult**"
constructors:
- uid: "com.azure.search.documents.models.SearchResult.SearchResult(double)"
fullName: "com.azure.search.documents.models.SearchResult.SearchResult(double score)"
name: "SearchResult(double score)"
nameWithType: "SearchResult.SearchResult(double score)"
summary: "Constructor of <xref uid=\"com.azure.search.documents.models.SearchResult\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchResult\"></xref>."
parameters:
- description: "The relevance score of the document compared to other documents returned by the query."
name: "score"
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SearchResult(double score)"
desc: "Constructor of <xref uid=\"com.azure.search.documents.models.SearchResult\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchResult\"></xref>."
methods:
- uid: "com.azure.search.documents.models.SearchResult.<T>getDocument(java.lang.Class<T>)"
fullName: "com.azure.search.documents.models.SearchResult.getDocument(Class<T> modelClass)"
name: "getDocument(Class<T> modelClass)"
nameWithType: "SearchResult.getDocument(Class<T> modelClass)"
summary: "Get the additional<wbr>Properties property: Unmatched properties from the message are deserialized this collection."
parameters:
- description: "The model class converts to."
name: "modelClass"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html\">Class</a>&lt;<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public T <T>getDocument(Class<T> modelClass)"
desc: "Get the additionalProperties property: Unmatched properties from the message are deserialized this collection."
returns:
description: "the additionalProperties value."
type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.models.SearchResult.getHighlights()"
fullName: "com.azure.search.documents.models.SearchResult.getHighlights()"
name: "getHighlights()"
nameWithType: "SearchResult.getHighlights()"
summary: "Get the highlights property: Text fragments from the document that indicate the matching search terms, organized by each applicable field; null if hit highlighting was not enabled for the query."
syntax: "public Map<String,List<String>> getHighlights()"
desc: "Get the highlights property: Text fragments from the document that indicate the matching search terms, organized by each applicable field; null if hit highlighting was not enabled for the query."
returns:
description: "the highlights value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;&gt;"
- uid: "com.azure.search.documents.models.SearchResult.getScore()"
fullName: "com.azure.search.documents.models.SearchResult.getScore()"
name: "getScore()"
nameWithType: "SearchResult.getScore()"
summary: "Get the score property: The relevance score of the document compared to other documents returned by the query."
syntax: "public double getScore()"
desc: "Get the score property: The relevance score of the document compared to other documents returned by the query."
returns:
description: "the score value."
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.models.SearchResult.getSemanticSearch()"
fullName: "com.azure.search.documents.models.SearchResult.getSemanticSearch()"
name: "getSemanticSearch()"
nameWithType: "SearchResult.getSemanticSearch()"
summary: "Get the semantic<wbr>Search<wbr>Result property: The semantic search results based on the search request."
syntax: "public SemanticSearchResult getSemanticSearch()"
desc: "Get the semanticSearchResult property: The semantic search results based on the search request.\n\nIf semantic search wasn't requested this will return a <xref uid=\"com.azure.search.documents.models.SemanticSearchResult\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SemanticSearchResult\"></xref> with no values."
returns:
description: "the semanticSearchResult value."
type: "<xref href=\"com.azure.search.documents.models.SemanticSearchResult?alt=com.azure.search.documents.models.SemanticSearchResult&text=SemanticSearchResult\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Contains a document found by a search query, plus associated metadata."
metadata: {}
package: "com.azure.search.documents.models"
artifact: com.azure:azure-search-documents:11.7.1