Package com.azure.ai.agents.persistent.models

Class BingGroundingSearchConfiguration

java.lang.Object
com.azure.ai.agents.persistent.models.BingGroundingSearchConfiguration
All Implemented Interfaces:
com.azure.json.JsonSerializable<BingGroundingSearchConfiguration>
public final class BingGroundingSearchConfiguration extends Object implements com.azure.json.JsonSerializable<BingGroundingSearchConfiguration>
Search configuration for Bing Grounding.

  • Constructor Details

    • BingGroundingSearchConfiguration

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

  • Method Details

    • getConnectionId

      public String getConnectionId()
      Get the connectionId property: Connection id for grounding with bing search.
      Returns:
      the connectionId value.

    • getMarket

      public String getMarket()
      Get the market property: The market where the results come from.
      Returns:
      the market value.

    • setMarket

      public BingGroundingSearchConfiguration setMarket(String market)
      Set the market property: The market where the results come from.
      Parameters:
      market - the market value to set.
      Returns:
      the BingGroundingSearchConfiguration object itself.

    • getSetLang

      public String getSetLang()
      Get the setLang property: The language to use for user interface strings when calling Bing API.
      Returns:
      the setLang value.

    • setSetLang

      public BingGroundingSearchConfiguration setSetLang(String setLang)
      Set the setLang property: The language to use for user interface strings when calling Bing API.
      Parameters:
      setLang - the setLang value to set.
      Returns:
      the BingGroundingSearchConfiguration object itself.

    • getCount

      public Long getCount()
      Get the count property: The number of search results to return in the bing api response.
      Returns:
      the count value.

    • setCount

      public BingGroundingSearchConfiguration setCount(Long count)
      Set the count property: The number of search results to return in the bing api response.
      Parameters:
      count - the count value to set.
      Returns:
      the BingGroundingSearchConfiguration object itself.

    • getFreshness

      public String getFreshness()
      Get the freshness property: Filter search results by a specific time range. Accepted values: https://learn.microsoft.com/bing/search-apis/bing-web-search/reference/query-parameters.
      Returns:
      the freshness value.

    • setFreshness

      public BingGroundingSearchConfiguration setFreshness(String freshness)
      Set the freshness property: Filter search results by a specific time range. Accepted values: https://learn.microsoft.com/bing/search-apis/bing-web-search/reference/query-parameters.
      Parameters:
      freshness - the freshness value to set.
      Returns:
      the BingGroundingSearchConfiguration 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<BingGroundingSearchConfiguration>
      Throws:
      IOException

    • fromJson

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