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

Class CreateFileSearchToolResourceVectorStoreOptions

java.lang.Object
com.azure.ai.openai.assistants.models.CreateFileSearchToolResourceVectorStoreOptions
All Implemented Interfaces:
com.azure.json.JsonSerializable<CreateFileSearchToolResourceVectorStoreOptions>
public final class CreateFileSearchToolResourceVectorStoreOptions extends Object implements com.azure.json.JsonSerializable<CreateFileSearchToolResourceVectorStoreOptions>
File IDs associated to the vector store to be passed to the helper.

  • Constructor Details

    • CreateFileSearchToolResourceVectorStoreOptions

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

    • CreateFileSearchToolResourceVectorStoreOptions

      public CreateFileSearchToolResourceVectorStoreOptions(List<String> fileIds, VectorStoreChunkingStrategyRequest chunkingStrategy)
      Creates an instance of CreateFileSearchToolResourceVectorStoreOptions class.
      Parameters:
      fileIds - the fileIds value to set.
      chunkingStrategy - the chunkingStrategy value to set.

  • Method Details

    • getFileIds

      public List<String> getFileIds()
      Get the fileIds property: A list of file IDs to add to the vector store. There can be a maximum of 10000 files in a vector store.
      Returns:
      the fileIds value.

    • 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 CreateFileSearchToolResourceVectorStoreOptions 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 CreateFileSearchToolResourceVectorStoreOptions 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<CreateFileSearchToolResourceVectorStoreOptions>
      Throws:
      IOException

    • fromJson

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

    • 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.
      Returns:
      the chunkingStrategy value.