Share via

AzureSearchIndexFieldMappingOptions Class

Package:
com.azure.ai.openai.models
Maven Artifact:
com.azure:azure-ai-openai:1.0.0-beta.16
  • java.lang.Object
    • com.azure.ai.openai.models.AzureSearchIndexFieldMappingOptions

Implements

JsonSerializable<AzureSearchIndexFieldMappingOptions>

public final class AzureSearchIndexFieldMappingOptions
implements JsonSerializable<AzureSearchIndexFieldMappingOptions>

Optional settings to control how fields are processed when using a configured Azure Search resource.

Constructor Summary

Constructor Description
AzureSearchIndexFieldMappingOptions()

Creates an instance of AzureSearchIndexFieldMappingOptions class.

Method Summary

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

Reads an instance of AzureSearchIndexFieldMappingOptions from the JsonReader.
List<String> getContentFields()

Get the contentFields property: The names of index fields that should be treated as content.
String getContentFieldsSeparator()

Get the contentFieldsSeparator property: The separator pattern that content fields should use.
String getFilepathField()

Get the filepathField property: The name of the index field to use as a filepath.
List<String> getImageVectorFields()

Get the imageVectorFields property: The names of fields that represent image vector data.
String getTitleField()

Get the titleField property: The name of the index field to use as a title.
String getUrlField()

Get the urlField property: The name of the index field to use as a URL.
List<String> getVectorFields()

Get the vectorFields property: The names of fields that represent vector data.
AzureSearchIndexFieldMappingOptions setContentFields(List<String> contentFields)

Set the contentFields property: The names of index fields that should be treated as content.
AzureSearchIndexFieldMappingOptions setContentFieldsSeparator(String contentFieldsSeparator)

Set the contentFieldsSeparator property: The separator pattern that content fields should use.
AzureSearchIndexFieldMappingOptions setFilepathField(String filepathField)

Set the filepathField property: The name of the index field to use as a filepath.
AzureSearchIndexFieldMappingOptions setImageVectorFields(List<String> imageVectorFields)

Set the imageVectorFields property: The names of fields that represent image vector data.
AzureSearchIndexFieldMappingOptions setTitleField(String titleField)

Set the titleField property: The name of the index field to use as a title.
AzureSearchIndexFieldMappingOptions setUrlField(String urlField)

Set the urlField property: The name of the index field to use as a URL.
AzureSearchIndexFieldMappingOptions setVectorFields(List<String> vectorFields)

Set the vectorFields property: The names of fields that represent vector data.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AzureSearchIndexFieldMappingOptions

public AzureSearchIndexFieldMappingOptions()

Creates an instance of AzureSearchIndexFieldMappingOptions class.

Method Details

fromJson

public static AzureSearchIndexFieldMappingOptions fromJson(JsonReader jsonReader)

Reads an instance of AzureSearchIndexFieldMappingOptions from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

 - If an error occurs while reading the AzureSearchIndexFieldMappingOptions.

getContentFields

public List<String> getContentFields()

Get the contentFields property: The names of index fields that should be treated as content.

Returns:

the contentFields value.

getContentFieldsSeparator

public String getContentFieldsSeparator()

Get the contentFieldsSeparator property: The separator pattern that content fields should use.

Returns:

the contentFieldsSeparator value.

getFilepathField

public String getFilepathField()

Get the filepathField property: The name of the index field to use as a filepath.

Returns:

the filepathField value.

getImageVectorFields

public List<String> getImageVectorFields()

Get the imageVectorFields property: The names of fields that represent image vector data.

Returns:

the imageVectorFields value.

getTitleField

public String getTitleField()

Get the titleField property: The name of the index field to use as a title.

Returns:

the titleField value.

getUrlField

public String getUrlField()

Get the urlField property: The name of the index field to use as a URL.

Returns:

the urlField value.

getVectorFields

public List<String> getVectorFields()

Get the vectorFields property: The names of fields that represent vector data.

Returns:

the vectorFields value.

setContentFields

public AzureSearchIndexFieldMappingOptions setContentFields(List<String> contentFields)

Set the contentFields property: The names of index fields that should be treated as content.

Parameters:

contentFields - the contentFields value to set.

Returns:

the AzureSearchIndexFieldMappingOptions object itself.

setContentFieldsSeparator

public AzureSearchIndexFieldMappingOptions setContentFieldsSeparator(String contentFieldsSeparator)

Set the contentFieldsSeparator property: The separator pattern that content fields should use.

Parameters:

contentFieldsSeparator - the contentFieldsSeparator value to set.

Returns:

the AzureSearchIndexFieldMappingOptions object itself.

setFilepathField

public AzureSearchIndexFieldMappingOptions setFilepathField(String filepathField)

Set the filepathField property: The name of the index field to use as a filepath.

Parameters:

filepathField - the filepathField value to set.

Returns:

the AzureSearchIndexFieldMappingOptions object itself.

setImageVectorFields

public AzureSearchIndexFieldMappingOptions setImageVectorFields(List<String> imageVectorFields)

Set the imageVectorFields property: The names of fields that represent image vector data.

Parameters:

imageVectorFields - the imageVectorFields value to set.

Returns:

the AzureSearchIndexFieldMappingOptions object itself.

setTitleField

public AzureSearchIndexFieldMappingOptions setTitleField(String titleField)

Set the titleField property: The name of the index field to use as a title.

Parameters:

titleField - the titleField value to set.

Returns:

the AzureSearchIndexFieldMappingOptions object itself.

setUrlField

public AzureSearchIndexFieldMappingOptions setUrlField(String urlField)

Set the urlField property: The name of the index field to use as a URL.

Parameters:

urlField - the urlField value to set.

Returns:

the AzureSearchIndexFieldMappingOptions object itself.

setVectorFields

public AzureSearchIndexFieldMappingOptions setVectorFields(List<String> vectorFields)

Set the vectorFields property: The names of fields that represent vector data.

Parameters:

vectorFields - the vectorFields value to set.

Returns:

the AzureSearchIndexFieldMappingOptions object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to