Package com.azure.ai.openai.assistants.models

Class VectorStoreOptions

java.lang.Object
com.azure.ai.openai.assistants.models.VectorStoreOptions
All Implemented Interfaces:
com.azure.json.JsonSerializable<VectorStoreOptions>
public final class VectorStoreOptions extends Object implements com.azure.json.JsonSerializable<VectorStoreOptions>
Request object for creating a vector store.

  • Constructor Details

    • VectorStoreOptions

      public VectorStoreOptions()
      Creates an instance of VectorStoreOptions class.

  • Method Details

    • getFileIds

      public List<String> getFileIds()
      Get the fileIds property: A list of file IDs that the vector store should use. Useful for tools like `file_search` that can access files.
      Returns:
      the fileIds value.

    • setFileIds

      public VectorStoreOptions setFileIds(List<String> fileIds)
      Set the fileIds property: A list of file IDs that the vector store should use. Useful for tools like `file_search` that can access files.
      Parameters:
      fileIds - the fileIds value to set.
      Returns:
      the VectorStoreOptions object itself.

    • getName

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

    • setName

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

    • getExpiresAfter

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

    • setExpiresAfter

      public VectorStoreOptions setExpiresAfter(VectorStoreExpirationPolicy expiresAfter)
      Set the expiresAfter property: Details on when this vector store expires.
      Parameters:
      expiresAfter - the expiresAfter value to set.
      Returns:
      the VectorStoreOptions 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 VectorStoreOptions 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 VectorStoreOptions 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<VectorStoreOptions>
      Throws:
      IOException

    • fromJson

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

    • getChunkingStrategy

      public VectorStoreChunkingStrategyRequest getChunkingStrategy()
      Get the chunkingStrategy property: The chunking strategy used to chunk the file(s). If not set, will use the auto strategy. Only applicable if file_ids is non-empty.
      Returns:
      the chunkingStrategy value.

    • setChunkingStrategy

      public VectorStoreOptions setChunkingStrategy(VectorStoreChunkingStrategyRequest chunkingStrategy)
      Set the chunkingStrategy property: The chunking strategy used to chunk the file(s). If not set, will use the auto strategy. Only applicable if file_ids is non-empty.
      Parameters:
      chunkingStrategy - the chunkingStrategy value to set.
      Returns:
      the VectorStoreOptions object itself.