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

### YamlMime:JavaType
uid: "com.azure.search.documents.models.QueryCaption"
fullName: "com.azure.search.documents.models.QueryCaption"
name: "QueryCaption"
nameWithType: "QueryCaption"
summary: "Configuration for how semantic search captions search results."
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 **QueryCaption**"
constructors:
- uid: "com.azure.search.documents.models.QueryCaption.QueryCaption(com.azure.search.documents.models.QueryCaptionType)"
  fullName: "com.azure.search.documents.models.QueryCaption.QueryCaption(QueryCaptionType captionType)"
  name: "QueryCaption(QueryCaptionType captionType)"
  nameWithType: "QueryCaption.QueryCaption(QueryCaptionType captionType)"
  summary: "Creates a new instance of <xref uid=\"com.azure.search.documents.models.QueryCaption\" data-throw-if-not-resolved=\"false\" data-raw-source=\"QueryCaption\"></xref>."
  parameters:
  - description: "The type of captions to generate."
    name: "captionType"
    type: "<xref href=\"com.azure.search.documents.models.QueryCaptionType?alt=com.azure.search.documents.models.QueryCaptionType&text=QueryCaptionType\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public QueryCaption(QueryCaptionType captionType)"
  desc: "Creates a new instance of <xref uid=\"com.azure.search.documents.models.QueryCaption\" data-throw-if-not-resolved=\"false\" data-raw-source=\"QueryCaption\"></xref>."
methods:
- uid: "com.azure.search.documents.models.QueryCaption.getCaptionType()"
  fullName: "com.azure.search.documents.models.QueryCaption.getCaptionType()"
  name: "getCaptionType()"
  nameWithType: "QueryCaption.getCaptionType()"
  summary: "Gets the type of captions to generate."
  syntax: "public QueryCaptionType getCaptionType()"
  desc: "Gets the type of captions to generate."
  returns:
    description: "The type of captions to generate."
    type: "<xref href=\"com.azure.search.documents.models.QueryCaptionType?alt=com.azure.search.documents.models.QueryCaptionType&text=QueryCaptionType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.models.QueryCaption.isHighlightEnabled()"
  fullName: "com.azure.search.documents.models.QueryCaption.isHighlightEnabled()"
  name: "isHighlightEnabled()"
  nameWithType: "QueryCaption.isHighlightEnabled()"
  summary: "Whether to highlight the captioned text in the result."
  syntax: "public Boolean isHighlightEnabled()"
  desc: "Whether to highlight the captioned text in the result."
  returns:
    description: "Whether to highlight the captioned text in the result."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.search.documents.models.QueryCaption.setHighlightEnabled(java.lang.Boolean)"
  fullName: "com.azure.search.documents.models.QueryCaption.setHighlightEnabled(Boolean highlightEnabled)"
  name: "setHighlightEnabled(Boolean highlightEnabled)"
  nameWithType: "QueryCaption.setHighlightEnabled(Boolean highlightEnabled)"
  summary: "Sets whether to highlight the captioned text in the result."
  parameters:
  - description: "Whether to highlight the captioned text in the result."
    name: "highlightEnabled"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
  syntax: "public QueryCaption setHighlightEnabled(Boolean highlightEnabled)"
  desc: "Sets whether to highlight the captioned text in the result."
  returns:
    description: "The QueryCaption object itself."
    type: "<xref href=\"com.azure.search.documents.models.QueryCaption?alt=com.azure.search.documents.models.QueryCaption&text=QueryCaption\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Configuration for how semantic search captions search results."
metadata: {}
package: "com.azure.search.documents.models"
artifact: com.azure:azure-search-documents:11.7.3