Share via


IndexResource interface

A Index resource.

Properties

filter

Odata filter string for search resource.

indexConnectionId

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

indexName

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

queryType

Type of query in an AIIndexResource attached to this agent.

Possible values: "simple", "semantic", "vector", "vector_simple_hybrid", "vector_semantic_hybrid"

topK

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

Property Details

filter

Odata filter string for search resource.

filter?: string

Property Value

string

indexConnectionId

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

indexConnectionId: string

Property Value

string

indexName

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

indexName: string

Property Value

string

queryType

Type of query in an AIIndexResource attached to this agent.

Possible values: "simple", "semantic", "vector", "vector_simple_hybrid", "vector_semantic_hybrid"

queryType?: string

Property Value

string

topK

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

topK?: number

Property Value

number