AISearchIndexResource Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A AI Search Index resource.
public class AISearchIndexResource : Azure.AI.AgentServer.Contracts.Generated.Common.IUtf8JsonSerializable, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.AISearchIndexResource>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.AISearchIndexResource>type AISearchIndexResource = class
interface IUtf8JsonSerializable
interface IJsonModel<AISearchIndexResource>
interface IPersistableModel<AISearchIndexResource>Public Class AISearchIndexResource
Implements IJsonModel(Of AISearchIndexResource), IPersistableModel(Of AISearchIndexResource), IUtf8JsonSerializable- Inheritance
-
AISearchIndexResource
- Implements
Constructors
| Name | Description |
|---|---|
| AISearchIndexResource() |
Initializes a new instance of AISearchIndexResource for deserialization. |
| AISearchIndexResource(String, String, Nullable<AzureAISearchQueryType>, Nullable<Int32>, String, String, IDictionary<String,BinaryData>) |
Initializes a new instance of AISearchIndexResource. |
| AISearchIndexResource(String) |
Initializes a new instance of AISearchIndexResource. |
Properties
| Name | Description |
|---|---|
| Filter |
filter string for search resource. Learn more from here: https://learn.microsoft.com/azure/search/search-filters. |
| IndexAssetId |
Index asset id for search resource. |
| IndexName |
The name of an index in an IndexResource attached to this agent. |
| ProjectConnectionId |
An index connection ID in an IndexResource attached to this agent. |
| QueryType |
Type of query in an AIIndexResource attached to this agent. |
| TopK |
Number of documents to retrieve from search and present to the model. |
Methods
| Name | Description |
|---|---|
| DeserializeAISearchIndexResource(JsonElement, ModelReaderWriterOptions) | |
| FromResponse(Response) |
Deserializes the model from a raw response. |
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | |
| ToRequestContent() |
Convert into a RequestContent. |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<AISearchIndexResource>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<AISearchIndexResource>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<AISearchIndexResource>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<AISearchIndexResource>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<AISearchIndexResource>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
| IUtf8JsonSerializable.Write(Utf8JsonWriter) | |
