Share via

ProjectsOpenAIModelFactory.AzureAISearchToolIndex Method

Definition

Namespace:
Azure.AI.Projects.OpenAI
Assembly:
Azure.AI.Projects.OpenAI.dll
Package:
Azure.AI.Projects.OpenAI v1.0.0-beta.4
Source:
ProjectsOpenAIModelFactory.cs

A AI Search Index resource.

public static Azure.AI.Projects.OpenAI.AzureAISearchToolIndex AzureAISearchToolIndex(string projectConnectionId = default, string indexName = default, Azure.AI.Projects.OpenAI.AzureAISearchQueryType? queryType = default, int? topK = default, string filter = default, string indexAssetId = default);
static member AzureAISearchToolIndex : string * string * Nullable<Azure.AI.Projects.OpenAI.AzureAISearchQueryType> * Nullable<int> * string * string -> Azure.AI.Projects.OpenAI.AzureAISearchToolIndex
Public Shared Function AzureAISearchToolIndex (Optional projectConnectionId As String = Nothing, Optional indexName As String = Nothing, Optional queryType As Nullable(Of AzureAISearchQueryType) = Nothing, Optional topK As Nullable(Of Integer) = Nothing, Optional filter As String = Nothing, Optional indexAssetId As String = Nothing) As AzureAISearchToolIndex

Parameters

projectConnectionId
String

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

indexName
String

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

queryType
Nullable<AzureAISearchQueryType>

Type of query in an AIIndexResource attached to this agent.

topK
Nullable<Int32>

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

filter
String

filter string for search resource. Learn more here.

indexAssetId
String

Index asset id for search resource.

Returns

AzureAISearchToolIndex

A new AzureAISearchToolIndex instance for mocking.

Applies to