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

Class AISearchIndexResource

java.lang.Object
com.azure.ai.agents.persistent.models.AISearchIndexResource
All Implemented Interfaces:
com.azure.json.JsonSerializable<AISearchIndexResource>
public final class AISearchIndexResource extends Object implements com.azure.json.JsonSerializable<AISearchIndexResource>
A AI Search Index resource.

  • Constructor Details

    • AISearchIndexResource

      public AISearchIndexResource()
      Creates an instance of AISearchIndexResource class.

  • Method Details

    • getIndexConnectionId

      public String getIndexConnectionId()
      Get the indexConnectionId property: An index connection id in an IndexResource attached to this agent.
      Returns:
      the indexConnectionId value.

    • getIndexName

      public String getIndexName()
      Get the indexName property: The name of an index in an IndexResource attached to this agent.
      Returns:
      the indexName value.

    • getQueryType

      public AzureAISearchQueryType getQueryType()
      Get the queryType property: Type of query in an AIIndexResource attached to this agent.
      Returns:
      the queryType value.

    • setQueryType

      public AISearchIndexResource setQueryType(AzureAISearchQueryType queryType)
      Set the queryType property: Type of query in an AIIndexResource attached to this agent.
      Parameters:
      queryType - the queryType value to set.
      Returns:
      the AISearchIndexResource object itself.

    • getTopK

      public Integer getTopK()
      Get the topK property: Number of documents to retrieve from search and present to the model.
      Returns:
      the topK value.

    • setTopK

      public AISearchIndexResource setTopK(Integer topK)
      Set the topK property: Number of documents to retrieve from search and present to the model.
      Parameters:
      topK - the topK value to set.
      Returns:
      the AISearchIndexResource object itself.

    • getFilter

      public String getFilter()
      Get the filter property: filter string for search resource.
      Returns:
      the filter value.

    • setFilter

      public AISearchIndexResource setFilter(String filter)
      Set the filter property: filter string for search resource.
      Parameters:
      filter - the filter value to set.
      Returns:
      the AISearchIndexResource object itself.

    • getIndexAssetId

      public String getIndexAssetId()
      Get the indexAssetId property: Index asset id for search resource.
      Returns:
      the indexAssetId value.

    • setIndexAssetId

      public AISearchIndexResource setIndexAssetId(String indexAssetId)
      Set the indexAssetId property: Index asset id for search resource.
      Parameters:
      indexAssetId - the indexAssetId value to set.
      Returns:
      the AISearchIndexResource 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<AISearchIndexResource>
      Throws:
      IOException

    • fromJson

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

    • setIndexConnectionId

      public AISearchIndexResource setIndexConnectionId(String indexConnectionId)
      Set the indexConnectionId property: An index connection id in an IndexResource attached to this agent.
      Parameters:
      indexConnectionId - the indexConnectionId value to set.
      Returns:
      the AISearchIndexResource object itself.

    • setIndexName

      public AISearchIndexResource setIndexName(String indexName)
      Set the indexName property: The name of an index in an IndexResource attached to this agent.
      Parameters:
      indexName - the indexName value to set.
      Returns:
      the AISearchIndexResource object itself.