Package com.azure.ai.openai.models

Class PineconeFieldMappingOptions

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

  • Constructor Details

    • PineconeFieldMappingOptions

      public PineconeFieldMappingOptions(List<String> contentFields)
      Creates an instance of PineconeFieldMappingOptions class.
      Parameters:
      contentFields - the contentFields value to set.

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

    • getContentFieldsSeparator

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

    • setContentFieldsSeparator

      public PineconeFieldMappingOptions setContentFieldsSeparator(String contentFieldsSeparator)
      Set the contentFieldsSeparator property: The separator pattern that content fields should use.
      Parameters:
      contentFieldsSeparator - the contentFieldsSeparator value to set.
      Returns:
      the PineconeFieldMappingOptions 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<PineconeFieldMappingOptions>
      Throws:
      IOException

    • fromJson

      public static PineconeFieldMappingOptions fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of PineconeFieldMappingOptions from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of PineconeFieldMappingOptions if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the PineconeFieldMappingOptions.