AzureMachineLearningParameters 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.
Specifies the properties for connecting to an AML vectorizer.
public class AzureMachineLearningParameters : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.AzureMachineLearningParameters>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.AzureMachineLearningParameters>type AzureMachineLearningParameters = class
interface IJsonModel<AzureMachineLearningParameters>
interface IPersistableModel<AzureMachineLearningParameters>Public Class AzureMachineLearningParameters
Implements IJsonModel(Of AzureMachineLearningParameters), IPersistableModel(Of AzureMachineLearningParameters)- Inheritance
-
AzureMachineLearningParameters
- Implements
Constructors
| Name | Description |
|---|---|
| AzureMachineLearningParameters(Uri) |
Initializes a new instance of AzureMachineLearningParameters. |
Properties
| Name | Description |
|---|---|
| AuthenticationKey |
(Required for key authentication) The key for the AML service. |
| ModelName |
The name of the embedding model from the Azure AI Foundry Catalog that is deployed at the provided endpoint. |
| Region |
(Optional for token authentication). The region the AML service is deployed in. |
| ResourceId |
(Required for token authentication). The Azure Resource Manager resource ID of the AML service. It should be in the format subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}. |
| ScoringUri |
(Required for no authentication or key authentication) The scoring URI of the AML service to which the JSON payload will be sent. Only the https URI scheme is allowed. |
| Timeout |
(Optional) When specified, indicates the timeout for the http client making the API call. |
Methods
| Name | Description |
|---|---|
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<AzureMachineLearningParameters>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<AzureMachineLearningParameters>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<AzureMachineLearningParameters>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<AzureMachineLearningParameters>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<AzureMachineLearningParameters>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
