TypeSafeAiDecisionModel
Namespace: Vercel.AI.TypeSafeAi
public class TypeSafeAiDecisionModel : IEvaluationDecisionCaller, IDecisionCaller, IEvaluationCallerAnswers questions through the TypeSafe /systemone route.
Inheritance: object
Implements: IEvaluationDecisionCaller, IDecisionCaller, IEvaluationCaller
Derived: TypeSafeAiEvaluationModel
Constructors
Section titled “Constructors”TypeSafeAiDecisionModel(string, TypeSafeAiDecisionModelConfig?)
Section titled “TypeSafeAiDecisionModel(string, TypeSafeAiDecisionModelConfig?)”public TypeSafeAiDecisionModel(string modelId, TypeSafeAiDecisionModelConfig? config = null)Creates a decision model. <code class=“paramref”>modelId</code> may be a model id this library does not know yet.
Parameters
| Name | Type | Description |
|---|---|---|
modelId |
string | |
config |
TypeSafeAiDecisionModelConfig |
Properties
Section titled “Properties”ModelId
Section titled “ModelId”public string ModelId { get; }Model id.
Value: string
Provider
Section titled “Provider”public string Provider { get; }Provider id.
Value: string
SpecificationVersion
Section titled “SpecificationVersion”public string SpecificationVersion { get; }Specification version. Only v4 is accepted.
Value: string
SupportedQuestionTypes
Section titled “SupportedQuestionTypes”public IReadOnlyList<string> SupportedQuestionTypes { get; }Question types this model can answer.
Value: IReadOnlyList<string>
Methods
Section titled “Methods”Deserialize(SerializedModelOptions, HttpClient?)
Section titled “Deserialize(SerializedModelOptions, HttpClient?)”public static TypeSafeAiDecisionModel Deserialize(SerializedModelOptions options, HttpClient? httpClient = null)Restores a model from Serialize(). When no headers were serialized, authentication is read from
TYPESAFE_AI_API_KEY at call time. The HTTP client is not serialized, so pass one to use a custom handler.
Parameters
| Name | Type | Description |
|---|---|---|
options |
SerializedModelOptions | |
httpClient |
HttpClient |
Returns: TypeSafeAiDecisionModel
DoDecideAsync(DecisionModelCall, CancellationToken)
Section titled “DoDecideAsync(DecisionModelCall, CancellationToken)”public Task<DecisionModelResult> DoDecideAsync(DecisionModelCall call, CancellationToken cancellationToken)Decides every question in one call.
Parameters
| Name | Type | Description |
|---|---|---|
call |
DecisionModelCall | |
cancellationToken |
CancellationToken |
Returns: Task<DecisionModelResult>
DoEvaluateAsync(EvaluationModelCall, CancellationToken)
Section titled “DoEvaluateAsync(EvaluationModelCall, CancellationToken)”[Obsolete("Use DoDecideAsync instead.")]public Task<EvaluationModelResult> DoEvaluateAsync(EvaluationModelCall call, CancellationToken cancellationToken)Deprecated. Use CancellationToken).
Parameters
| Name | Type | Description |
|---|---|---|
call |
EvaluationModelCall | |
cancellationToken |
CancellationToken |
Returns: Task<EvaluationModelResult>
Serialize()
Section titled “Serialize()”public SerializedModelOptions Serialize()Serializes the model id and the JSON-serializable part of the config for a workflow boundary.
Returns: SerializedModelOptions
Apache-2.0 · Copyright 2023 Vercel, Inc. · unofficial community port, not an official Vercel product