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

261 строка
22 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.search.documents.indexes.models.SplitSkill"
fullName: "com.azure.search.documents.indexes.models.SplitSkill"
name: "SplitSkill"
nameWithType: "SplitSkill"
summary: "A skill to split a string into chunks of text."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill&text=SearchIndexerSkill\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.fromJson(com.azure.json.JsonReader)?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.fromJson&text=fromJson\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getContext()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getContext&text=getContext\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getDescription()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getDescription&text=getDescription\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getInputs()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getInputs&text=getInputs\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getName()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getName&text=getName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getOdataType()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getOdataType&text=getOdataType\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getOutputs()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getOutputs&text=getOutputs\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.setContext(java.lang.String)?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.setContext&text=setContext\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.setDescription(java.lang.String)?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.setDescription&text=setDescription\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.setName(java.lang.String)?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.setName&text=setName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.toJson(com.azure.json.JsonWriter)?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.toJson&text=toJson\" data-throw-if-not-resolved=\"False\" />"
- 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 **SplitSkill**</br> extends <xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill&text=SearchIndexerSkill\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.azure.search.documents.indexes.models.SplitSkill.SplitSkill(java.util.List<com.azure.search.documents.indexes.models.InputFieldMappingEntry>,java.util.List<com.azure.search.documents.indexes.models.OutputFieldMappingEntry>)"
fullName: "com.azure.search.documents.indexes.models.SplitSkill.SplitSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)"
name: "SplitSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)"
nameWithType: "SplitSkill.SplitSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)"
summary: "Creates an instance of Split<wbr>Skill class."
parameters:
- description: "the inputs value to set."
name: "inputs"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.documents.indexes.models.InputFieldMappingEntry?alt=com.azure.search.documents.indexes.models.InputFieldMappingEntry&text=InputFieldMappingEntry\" data-throw-if-not-resolved=\"False\" />&gt;"
- description: "the outputs value to set."
name: "outputs"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.documents.indexes.models.OutputFieldMappingEntry?alt=com.azure.search.documents.indexes.models.OutputFieldMappingEntry&text=OutputFieldMappingEntry\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public SplitSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)"
desc: "Creates an instance of SplitSkill class."
methods:
- uid: "com.azure.search.documents.indexes.models.SplitSkill.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.search.documents.indexes.models.SplitSkill.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "SplitSkill.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Split<wbr>Skill from the Json<wbr>Reader."
modifiers:
- "static"
parameters:
- description: "The JsonReader being read."
name: "jsonReader"
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static SplitSkill fromJson(JsonReader jsonReader)"
exceptions:
- description: "If the deserialized JSON object was missing any required properties."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Reads an instance of SplitSkill from the JsonReader."
returns:
description: "An instance of SplitSkill if the JsonReader was pointing to an instance of it, or null if it was pointing\n to JSON null."
type: "<xref href=\"com.azure.search.documents.indexes.models.SplitSkill?alt=com.azure.search.documents.indexes.models.SplitSkill&text=SplitSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SplitSkill.getDefaultLanguageCode()"
fullName: "com.azure.search.documents.indexes.models.SplitSkill.getDefaultLanguageCode()"
name: "getDefaultLanguageCode()"
nameWithType: "SplitSkill.getDefaultLanguageCode()"
summary: "Get the default<wbr>Language<wbr>Code property: A value indicating which language code to use."
syntax: "public SplitSkillLanguage getDefaultLanguageCode()"
desc: "Get the defaultLanguageCode property: A value indicating which language code to use. Default is \\`en\\`."
returns:
description: "the defaultLanguageCode value."
type: "<xref href=\"com.azure.search.documents.indexes.models.SplitSkillLanguage?alt=com.azure.search.documents.indexes.models.SplitSkillLanguage&text=SplitSkillLanguage\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SplitSkill.getMaximumPageLength()"
fullName: "com.azure.search.documents.indexes.models.SplitSkill.getMaximumPageLength()"
name: "getMaximumPageLength()"
nameWithType: "SplitSkill.getMaximumPageLength()"
summary: "Get the maximum<wbr>Page<wbr>Length property: The desired maximum page length."
syntax: "public Integer getMaximumPageLength()"
desc: "Get the maximumPageLength property: The desired maximum page length. Default is 10000."
returns:
description: "the maximumPageLength value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.search.documents.indexes.models.SplitSkill.getMaximumPagesToTake()"
fullName: "com.azure.search.documents.indexes.models.SplitSkill.getMaximumPagesToTake()"
name: "getMaximumPagesToTake()"
nameWithType: "SplitSkill.getMaximumPagesToTake()"
summary: "Get the maximum<wbr>Pages<wbr>ToTake property: Only applicable when text<wbr>Split<wbr>Mode is set to 'pages'."
syntax: "public Integer getMaximumPagesToTake()"
desc: "Get the maximumPagesToTake property: Only applicable when textSplitMode is set to 'pages'. If specified, the SplitSkill will discontinue splitting after processing the first 'maximumPagesToTake' pages, in order to improve performance when only a few initial pages are needed from each document."
returns:
description: "the maximumPagesToTake value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.search.documents.indexes.models.SplitSkill.getOdataType()"
fullName: "com.azure.search.documents.indexes.models.SplitSkill.getOdataType()"
name: "getOdataType()"
nameWithType: "SplitSkill.getOdataType()"
summary: "Get the odata<wbr>Type property: A URI fragment specifying the type of skill."
overridden: "com.azure.search.documents.indexes.models.SearchIndexerSkill.getOdataType()"
syntax: "public String getOdataType()"
desc: "Get the odataType property: A URI fragment specifying the type of skill."
returns:
description: "the odataType value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.documents.indexes.models.SplitSkill.getPageOverlapLength()"
fullName: "com.azure.search.documents.indexes.models.SplitSkill.getPageOverlapLength()"
name: "getPageOverlapLength()"
nameWithType: "SplitSkill.getPageOverlapLength()"
summary: "Get the page<wbr>Overlap<wbr>Length property: Only applicable when text<wbr>Split<wbr>Mode is set to 'pages'."
syntax: "public Integer getPageOverlapLength()"
desc: "Get the pageOverlapLength property: Only applicable when textSplitMode is set to 'pages'. If specified, n+1th chunk will start with this number of characters/tokens from the end of the nth chunk."
returns:
description: "the pageOverlapLength value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.search.documents.indexes.models.SplitSkill.getTextSplitMode()"
fullName: "com.azure.search.documents.indexes.models.SplitSkill.getTextSplitMode()"
name: "getTextSplitMode()"
nameWithType: "SplitSkill.getTextSplitMode()"
summary: "Get the text<wbr>Split<wbr>Mode property: A value indicating which split mode to perform."
syntax: "public TextSplitMode getTextSplitMode()"
desc: "Get the textSplitMode property: A value indicating which split mode to perform."
returns:
description: "the textSplitMode value."
type: "<xref href=\"com.azure.search.documents.indexes.models.TextSplitMode?alt=com.azure.search.documents.indexes.models.TextSplitMode&text=TextSplitMode\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SplitSkill.setContext(java.lang.String)"
fullName: "com.azure.search.documents.indexes.models.SplitSkill.setContext(String context)"
name: "setContext(String context)"
nameWithType: "SplitSkill.setContext(String context)"
summary: "Set the context property: Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content)."
overridden: "com.azure.search.documents.indexes.models.SearchIndexerSkill.setContext(java.lang.String)"
parameters:
- name: "context"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public SplitSkill setContext(String context)"
desc: "Set the context property: Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document."
returns:
type: "<xref href=\"com.azure.search.documents.indexes.models.SplitSkill?alt=com.azure.search.documents.indexes.models.SplitSkill&text=SplitSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SplitSkill.setDefaultLanguageCode(com.azure.search.documents.indexes.models.SplitSkillLanguage)"
fullName: "com.azure.search.documents.indexes.models.SplitSkill.setDefaultLanguageCode(SplitSkillLanguage defaultLanguageCode)"
name: "setDefaultLanguageCode(SplitSkillLanguage defaultLanguageCode)"
nameWithType: "SplitSkill.setDefaultLanguageCode(SplitSkillLanguage defaultLanguageCode)"
summary: "Set the default<wbr>Language<wbr>Code property: A value indicating which language code to use."
parameters:
- description: "the defaultLanguageCode value to set."
name: "defaultLanguageCode"
type: "<xref href=\"com.azure.search.documents.indexes.models.SplitSkillLanguage?alt=com.azure.search.documents.indexes.models.SplitSkillLanguage&text=SplitSkillLanguage\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SplitSkill setDefaultLanguageCode(SplitSkillLanguage defaultLanguageCode)"
desc: "Set the defaultLanguageCode property: A value indicating which language code to use. Default is \\`en\\`."
returns:
description: "the SplitSkill object itself."
type: "<xref href=\"com.azure.search.documents.indexes.models.SplitSkill?alt=com.azure.search.documents.indexes.models.SplitSkill&text=SplitSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SplitSkill.setDescription(java.lang.String)"
fullName: "com.azure.search.documents.indexes.models.SplitSkill.setDescription(String description)"
name: "setDescription(String description)"
nameWithType: "SplitSkill.setDescription(String description)"
summary: "Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill."
overridden: "com.azure.search.documents.indexes.models.SearchIndexerSkill.setDescription(java.lang.String)"
parameters:
- name: "description"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public SplitSkill setDescription(String description)"
desc: "Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill."
returns:
type: "<xref href=\"com.azure.search.documents.indexes.models.SplitSkill?alt=com.azure.search.documents.indexes.models.SplitSkill&text=SplitSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SplitSkill.setMaximumPageLength(java.lang.Integer)"
fullName: "com.azure.search.documents.indexes.models.SplitSkill.setMaximumPageLength(Integer maximumPageLength)"
name: "setMaximumPageLength(Integer maximumPageLength)"
nameWithType: "SplitSkill.setMaximumPageLength(Integer maximumPageLength)"
summary: "Set the maximum<wbr>Page<wbr>Length property: The desired maximum page length."
parameters:
- description: "the maximumPageLength value to set."
name: "maximumPageLength"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public SplitSkill setMaximumPageLength(Integer maximumPageLength)"
desc: "Set the maximumPageLength property: The desired maximum page length. Default is 10000."
returns:
description: "the SplitSkill object itself."
type: "<xref href=\"com.azure.search.documents.indexes.models.SplitSkill?alt=com.azure.search.documents.indexes.models.SplitSkill&text=SplitSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SplitSkill.setMaximumPagesToTake(java.lang.Integer)"
fullName: "com.azure.search.documents.indexes.models.SplitSkill.setMaximumPagesToTake(Integer maximumPagesToTake)"
name: "setMaximumPagesToTake(Integer maximumPagesToTake)"
nameWithType: "SplitSkill.setMaximumPagesToTake(Integer maximumPagesToTake)"
summary: "Set the maximum<wbr>Pages<wbr>ToTake property: Only applicable when text<wbr>Split<wbr>Mode is set to 'pages'."
parameters:
- description: "the maximumPagesToTake value to set."
name: "maximumPagesToTake"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public SplitSkill setMaximumPagesToTake(Integer maximumPagesToTake)"
desc: "Set the maximumPagesToTake property: Only applicable when textSplitMode is set to 'pages'. If specified, the SplitSkill will discontinue splitting after processing the first 'maximumPagesToTake' pages, in order to improve performance when only a few initial pages are needed from each document."
returns:
description: "the SplitSkill object itself."
type: "<xref href=\"com.azure.search.documents.indexes.models.SplitSkill?alt=com.azure.search.documents.indexes.models.SplitSkill&text=SplitSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SplitSkill.setName(java.lang.String)"
fullName: "com.azure.search.documents.indexes.models.SplitSkill.setName(String name)"
name: "setName(String name)"
nameWithType: "SplitSkill.setName(String name)"
summary: "Set the name property: The name of the skill which uniquely identifies it within the skillset."
overridden: "com.azure.search.documents.indexes.models.SearchIndexerSkill.setName(java.lang.String)"
parameters:
- name: "name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public SplitSkill setName(String name)"
desc: "Set the name property: The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '\\#'."
returns:
type: "<xref href=\"com.azure.search.documents.indexes.models.SplitSkill?alt=com.azure.search.documents.indexes.models.SplitSkill&text=SplitSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SplitSkill.setPageOverlapLength(java.lang.Integer)"
fullName: "com.azure.search.documents.indexes.models.SplitSkill.setPageOverlapLength(Integer pageOverlapLength)"
name: "setPageOverlapLength(Integer pageOverlapLength)"
nameWithType: "SplitSkill.setPageOverlapLength(Integer pageOverlapLength)"
summary: "Set the page<wbr>Overlap<wbr>Length property: Only applicable when text<wbr>Split<wbr>Mode is set to 'pages'."
parameters:
- description: "the pageOverlapLength value to set."
name: "pageOverlapLength"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public SplitSkill setPageOverlapLength(Integer pageOverlapLength)"
desc: "Set the pageOverlapLength property: Only applicable when textSplitMode is set to 'pages'. If specified, n+1th chunk will start with this number of characters/tokens from the end of the nth chunk."
returns:
description: "the SplitSkill object itself."
type: "<xref href=\"com.azure.search.documents.indexes.models.SplitSkill?alt=com.azure.search.documents.indexes.models.SplitSkill&text=SplitSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SplitSkill.setTextSplitMode(com.azure.search.documents.indexes.models.TextSplitMode)"
fullName: "com.azure.search.documents.indexes.models.SplitSkill.setTextSplitMode(TextSplitMode textSplitMode)"
name: "setTextSplitMode(TextSplitMode textSplitMode)"
nameWithType: "SplitSkill.setTextSplitMode(TextSplitMode textSplitMode)"
summary: "Set the text<wbr>Split<wbr>Mode property: A value indicating which split mode to perform."
parameters:
- description: "the textSplitMode value to set."
name: "textSplitMode"
type: "<xref href=\"com.azure.search.documents.indexes.models.TextSplitMode?alt=com.azure.search.documents.indexes.models.TextSplitMode&text=TextSplitMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SplitSkill setTextSplitMode(TextSplitMode textSplitMode)"
desc: "Set the textSplitMode property: A value indicating which split mode to perform."
returns:
description: "the SplitSkill object itself."
type: "<xref href=\"com.azure.search.documents.indexes.models.SplitSkill?alt=com.azure.search.documents.indexes.models.SplitSkill&text=SplitSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SplitSkill.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.search.documents.indexes.models.SplitSkill.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "SplitSkill.toJson(JsonWriter jsonWriter)"
overridden: "com.azure.search.documents.indexes.models.SearchIndexerSkill.toJson(com.azure.json.JsonWriter)"
parameters:
- name: "jsonWriter"
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns:
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "A skill to split a string into chunks of text."
metadata: {}
package: "com.azure.search.documents.indexes.models"
artifact: com.azure:azure-search-documents:11.7.3