AISearchIndexResource Class

Package:

com.azure.ai.agents.persistent.models

Maven Artifact:

com.azure:azure-ai-agents-persistent:1.0.0-beta.2

• java.lang.Object
• • com.azure.ai.agents.persistent.models.AISearchIndexResource

Implements

JsonSerializable<AISearchIndexResource>

public final class AISearchIndexResource
implements JsonSerializable<AISearchIndexResource>

A AI Search Index resource.

Constructor Summary

Constructor	Description
AISearchIndexResource()	Creates an instance of AISearchIndexResource class.

Method Summary

Modifier and Type	Method and Description
static AISearchIndexResource	fromJson(JsonReader jsonReader) Reads an instance of AISearchIndexResource from the JsonReader.
String	getFilter() Get the filter property: filter string for search resource.
String	getIndexAssetId() Get the indexAssetId property: Index asset id for search resource.
String	getIndexConnectionId() Get the indexConnectionId property: An index connection id in an IndexResource attached to this agent.
String	getIndexName() Get the indexName property: The name of an index in an IndexResource attached to this agent.
AzureAISearchQueryType	getQueryType() Get the queryType property: Type of query in an AIIndexResource attached to this agent.
Integer	getTopK() Get the topK property: Number of documents to retrieve from search and present to the model.
AISearchIndexResource	setFilter(String filter) Set the filter property: filter string for search resource.
AISearchIndexResource	setIndexAssetId(String indexAssetId) Set the indexAssetId property: Index asset id for search resource.
AISearchIndexResource	setIndexConnectionId(String indexConnectionId) Set the indexConnectionId property: An index connection id in an IndexResource attached to this agent.
AISearchIndexResource	setIndexName(String indexName) Set the indexName property: The name of an index in an IndexResource attached to this agent.
AISearchIndexResource	setQueryType(AzureAISearchQueryType queryType) Set the queryType property: Type of query in an AIIndexResource attached to this agent.
AISearchIndexResource	setTopK(Integer topK) Set the topK property: Number of documents to retrieve from search and present to the model.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AISearchIndexResource

public AISearchIndexResource()

Creates an instance of AISearchIndexResource class.

Method Details

fromJson

public static AISearchIndexResource fromJson(JsonReader jsonReader)

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.

getFilter

public String getFilter()

Get the filter property: filter string for search resource.

Returns:

the filter value.

getIndexAssetId

public String getIndexAssetId()

Get the indexAssetId property: Index asset id for search resource.

Returns:

the indexAssetId value.

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.

getTopK

public Integer getTopK()

Get the topK property: Number of documents to retrieve from search and present to the model.

Returns:

the topK 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.

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.

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.

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.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException