AISearchIndexResource interface

Package:

@azure/ai-projects

A AI Search Index resource.

Properties

filter	filter string for search resource. Learn more here.
index_asset_id	Index asset id for search resource.
index_name	The name of an index in an IndexResource attached to this agent.
project_connection_id	An index connection ID in an IndexResource attached to this agent.
query_type	Type of query in an AIIndexResource attached to this agent.
top_k	Number of documents to retrieve from search and present to the model.

Property Details

filter

filter string for search resource. Learn more here.

filter?: string

Property Value

string

index_asset_id

Index asset id for search resource.

index_asset_id?: string

Property Value

string

index_name

The name of an index in an IndexResource attached to this agent.

index_name?: string

Property Value

string

project_connection_id

An index connection ID in an IndexResource attached to this agent.

project_connection_id?: string

Property Value

string

query_type

Type of query in an AIIndexResource attached to this agent.

query_type?: AzureAISearchQueryType

Property Value

AzureAISearchQueryType

top_k

Number of documents to retrieve from search and present to the model.

top_k?: number

Property Value

number