Share via

SearchIndexKnowledgeSourceParameters Class

Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:11.9.0-beta.1
  • java.lang.Object
    • com.azure.search.documents.indexes.models.SearchIndexKnowledgeSourceParameters

Implements

JsonSerializable<SearchIndexKnowledgeSourceParameters>

public final class SearchIndexKnowledgeSourceParameters
implements JsonSerializable<SearchIndexKnowledgeSourceParameters>

Parameters for search index knowledge source.

Constructor Summary

Constructor Description
SearchIndexKnowledgeSourceParameters(String searchIndexName)

Creates an instance of SearchIndexKnowledgeSourceParameters class.

Method Summary

Modifier and Type Method and Description
static SearchIndexKnowledgeSourceParameters fromJson(JsonReader jsonReader)

Reads an instance of SearchIndexKnowledgeSourceParameters from the JsonReader.
List<SearchIndexFieldReference> getSearchFields()

Get the searchFields property: Used to restrict which fields to search on the search index.
String getSearchIndexName()

Get the searchIndexName property: The name of the Search index.
String getSemanticConfigurationName()

Get the semanticConfigurationName property: Used to specify a different semantic configuration on the target search index other than the default one.
List<SearchIndexFieldReference> getSourceDataFields()

Get the sourceDataFields property: Used to request additional fields for referenced source data.
SearchIndexKnowledgeSourceParameters setSearchFields(List<SearchIndexFieldReference> searchFields)

Set the searchFields property: Used to restrict which fields to search on the search index.
SearchIndexKnowledgeSourceParameters setSemanticConfigurationName(String semanticConfigurationName)

Set the semanticConfigurationName property: Used to specify a different semantic configuration on the target search index other than the default one.
SearchIndexKnowledgeSourceParameters setSourceDataFields(List<SearchIndexFieldReference> sourceDataFields)

Set the sourceDataFields property: Used to request additional fields for referenced source data.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SearchIndexKnowledgeSourceParameters

public SearchIndexKnowledgeSourceParameters(String searchIndexName)

Creates an instance of SearchIndexKnowledgeSourceParameters class.

Parameters:

searchIndexName - the searchIndexName value to set.

Method Details

fromJson

public static SearchIndexKnowledgeSourceParameters fromJson(JsonReader jsonReader)

Reads an instance of SearchIndexKnowledgeSourceParameters from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SearchIndexKnowledgeSourceParameters if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getSearchFields

public List<SearchIndexFieldReference> getSearchFields()

Get the searchFields property: Used to restrict which fields to search on the search index.

Returns:

the searchFields value.

getSearchIndexName

public String getSearchIndexName()

Get the searchIndexName property: The name of the Search index.

Returns:

the searchIndexName value.

getSemanticConfigurationName

public String getSemanticConfigurationName()

Get the semanticConfigurationName property: Used to specify a different semantic configuration on the target search index other than the default one.

Returns:

the semanticConfigurationName value.

getSourceDataFields

public List<SearchIndexFieldReference> getSourceDataFields()

Get the sourceDataFields property: Used to request additional fields for referenced source data.

Returns:

the sourceDataFields value.

setSearchFields

public SearchIndexKnowledgeSourceParameters setSearchFields(List<SearchIndexFieldReference> searchFields)

Set the searchFields property: Used to restrict which fields to search on the search index.

Parameters:

searchFields - the searchFields value to set.

Returns:

the SearchIndexKnowledgeSourceParameters object itself.

setSemanticConfigurationName

public SearchIndexKnowledgeSourceParameters setSemanticConfigurationName(String semanticConfigurationName)

Set the semanticConfigurationName property: Used to specify a different semantic configuration on the target search index other than the default one.

Parameters:

semanticConfigurationName - the semanticConfigurationName value to set.

Returns:

the SearchIndexKnowledgeSourceParameters object itself.

setSourceDataFields

public SearchIndexKnowledgeSourceParameters setSourceDataFields(List<SearchIndexFieldReference> sourceDataFields)

Set the sourceDataFields property: Used to request additional fields for referenced source data.

Parameters:

sourceDataFields - the sourceDataFields value to set.

Returns:

the SearchIndexKnowledgeSourceParameters object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to