Class VectorStoreUpdateOptions

java.lang.Object
com.azure.ai.openai.assistants.models.VectorStoreUpdateOptions
All Implemented Interfaces:
com.azure.json.JsonSerializable<VectorStoreUpdateOptions>

public final class VectorStoreUpdateOptions extends Object implements com.azure.json.JsonSerializable<VectorStoreUpdateOptions>
Request object for updating a vector store.
  • Constructor Details

    • VectorStoreUpdateOptions

      public VectorStoreUpdateOptions()
      Creates an instance of VectorStoreUpdateOptions class.
  • Method Details

    • getName

      public String getName()
      Get the name property: The name of the vector store.
      Returns:
      the name value.
    • setName

      public VectorStoreUpdateOptions setName(String name)
      Set the name property: The name of the vector store.
      Parameters:
      name - the name value to set.
      Returns:
      the VectorStoreUpdateOptions object itself.
    • getExpiresAfter

      public VectorStoreExpirationPolicy getExpiresAfter()
      Get the expiresAfter property: Details on when this vector store expires.
      Returns:
      the expiresAfter value.
    • setExpiresAfter

      public VectorStoreUpdateOptions setExpiresAfter(VectorStoreExpirationPolicy expiresAfter)
      Set the expiresAfter property: Details on when this vector store expires.
      Parameters:
      expiresAfter - the expiresAfter value to set.
      Returns:
      the VectorStoreUpdateOptions object itself.
    • getMetadata

      public Map<String,String> getMetadata()
      Get the metadata property: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.
      Returns:
      the metadata value.
    • setMetadata

      public VectorStoreUpdateOptions setMetadata(Map<String,String> metadata)
      Set the metadata property: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.
      Parameters:
      metadata - the metadata value to set.
      Returns:
      the VectorStoreUpdateOptions 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<VectorStoreUpdateOptions>
      Throws:
      IOException
    • fromJson

      public static VectorStoreUpdateOptions fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of VectorStoreUpdateOptions from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of VectorStoreUpdateOptions 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 VectorStoreUpdateOptions.