Package com.azure.ai.openai.models

Class AzureSearchIndexFieldMappingOptions

java.lang.Object
com.azure.ai.openai.models.AzureSearchIndexFieldMappingOptions
All Implemented Interfaces:
com.azure.json.JsonSerializable<AzureSearchIndexFieldMappingOptions>
public final class AzureSearchIndexFieldMappingOptions extends Object implements com.azure.json.JsonSerializable<AzureSearchIndexFieldMappingOptions>
Optional settings to control how fields are processed when using a configured Azure Search resource.

  • Constructor Details

    • AzureSearchIndexFieldMappingOptions

      public AzureSearchIndexFieldMappingOptions()
      Creates an instance of AzureSearchIndexFieldMappingOptions class.

  • Method Details

    • getTitleField

      public String getTitleField()
      Get the titleField property: The name of the index field to use as a title.
      Returns:
      the titleField value.

    • 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.

    • getUrlField

      public String getUrlField()
      Get the urlField property: The name of the index field to use as a URL.
      Returns:
      the urlField value.

    • 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.

    • getFilepathField

      public String getFilepathField()
      Get the filepathField property: The name of the index field to use as a filepath.
      Returns:
      the filepathField value.

    • 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.

    • getContentFields

      public List<String> getContentFields()
      Get the contentFields property: The names of index fields that should be treated as content.
      Returns:
      the contentFields 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.

    • getContentFieldsSeparator

      public String getContentFieldsSeparator()
      Get the contentFieldsSeparator property: The separator pattern that content fields should use.
      Returns:
      the contentFieldsSeparator value.

    • 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.

    • getVectorFields

      public List<String> getVectorFields()
      Get the vectorFields property: The names of fields that represent vector data.
      Returns:
      the vectorFields value.

    • 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.

    • getImageVectorFields

      public List<String> getImageVectorFields()
      Get the imageVectorFields property: The names of fields that represent image vector data.
      Returns:
      the imageVectorFields value.

    • 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.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<AzureSearchIndexFieldMappingOptions>
      Throws:
      IOException

    • fromJson

      public static AzureSearchIndexFieldMappingOptions fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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.