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

Class AssistantCreationOptions

java.lang.Object
com.azure.ai.openai.assistants.models.AssistantCreationOptions
All Implemented Interfaces:
com.azure.json.JsonSerializable<AssistantCreationOptions>
public final class AssistantCreationOptions extends Object implements com.azure.json.JsonSerializable<AssistantCreationOptions>
The request details to use when creating a new assistant.

  • Constructor Details

    • AssistantCreationOptions

      public AssistantCreationOptions(String model)
      Creates an instance of AssistantCreationOptions class.
      Parameters:
      model - the model value to set.

  • Method Details

    • getModel

      public String getModel()
      Get the model property: The ID of the model to use.
      Returns:
      the model value.

    • getName

      public String getName()
      Get the name property: The name of the new assistant.
      Returns:
      the name value.

    • setName

      public AssistantCreationOptions setName(String name)
      Set the name property: The name of the new assistant.
      Parameters:
      name - the name value to set.
      Returns:
      the AssistantCreationOptions object itself.

    • getDescription

      public String getDescription()
      Get the description property: The description of the new assistant.
      Returns:
      the description value.

    • setDescription

      public AssistantCreationOptions setDescription(String description)
      Set the description property: The description of the new assistant.
      Parameters:
      description - the description value to set.
      Returns:
      the AssistantCreationOptions object itself.

    • getInstructions

      public String getInstructions()
      Get the instructions property: The system instructions for the new assistant to use.
      Returns:
      the instructions value.

    • setInstructions

      public AssistantCreationOptions setInstructions(String instructions)
      Set the instructions property: The system instructions for the new assistant to use.
      Parameters:
      instructions - the instructions value to set.
      Returns:
      the AssistantCreationOptions object itself.

    • getTools

      public List<ToolDefinition> getTools()
      Get the tools property: The collection of tools to enable for the new assistant.
      Returns:
      the tools value.

    • setTools

      public AssistantCreationOptions setTools(List<ToolDefinition> tools)
      Set the tools property: The collection of tools to enable for the new assistant.
      Parameters:
      tools - the tools value to set.
      Returns:
      the AssistantCreationOptions object itself.

    • getToolResources

      public CreateToolResourcesOptions getToolResources()
      Get the toolResources property: A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.
      Returns:
      the toolResources value.

    • setToolResources

      public AssistantCreationOptions setToolResources(CreateToolResourcesOptions toolResources)
      Set the toolResources property: A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.
      Parameters:
      toolResources - the toolResources value to set.
      Returns:
      the AssistantCreationOptions object itself.

    • getTemperature

      public Double getTemperature()
      Get the temperature property: What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.
      Returns:
      the temperature value.

    • setTemperature

      public AssistantCreationOptions setTemperature(Double temperature)
      Set the temperature property: What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.
      Parameters:
      temperature - the temperature value to set.
      Returns:
      the AssistantCreationOptions object itself.

    • getTopP

      public Double getTopP()
      Get the topP property: An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both.
      Returns:
      the topP value.

    • setTopP

      public AssistantCreationOptions setTopP(Double topP)
      Set the topP property: An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both.
      Parameters:
      topP - the topP value to set.
      Returns:
      the AssistantCreationOptions object itself.

    • getResponseFormat

      public AssistantsApiResponseFormatOption getResponseFormat()
      Get the responseFormat property: The response format of the tool calls used by this assistant.
      Returns:
      the responseFormat value.

    • setResponseFormat

      public AssistantCreationOptions setResponseFormat(AssistantsApiResponseFormatOption responseFormat)
      Set the responseFormat property: The response format of the tool calls used by this assistant.
      Parameters:
      responseFormat - the responseFormat value to set.
      Returns:
      the AssistantCreationOptions 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 AssistantCreationOptions 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 AssistantCreationOptions 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<AssistantCreationOptions>
      Throws:
      IOException

    • fromJson

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