AiCollabErrorResponse Interface
An error response from the AI collaboration.
To use, import via @fluidframework/ai-collab/alpha.
For more information about our API support guarantees, see here.
Signature
export interface AiCollabErrorResponse
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| diffs | Alpha | readonly | readonly Diff[] | A list of diffs that represent the changes made by the AI collaboration. |
| errorMessage | Alpha | readonly | "tokenLimitExceeded" | "tooManyErrors" | "tooManyModelCalls" | "aborted" | "unexpectedError" | The type of known error that occured - 'tokenLimitExceeded' indicates that the LLM exceeded the token limits set by the user - 'tooManyErrors' indicates that the LLM made too many errors in a row - 'tooManyModelCalls' indicates that the LLM made too many model calls - 'aborted' indicates that the AI collaboration was aborted by the user or a limiter - 'unexpectedError' indicates that an unexpected error occured |
| status | Alpha | readonly | "failure" | "partial-failure" | The status of the Ai Collaboration. - A 'partial-failure' status indicates that the AI collaboration was partially successful, but was aborted due to a limiter or other error - A "failure" status indicates that the AI collaboration was not successful at creating any changes. |
| tokensUsed | Alpha | readonly | TokenUsage | Total usage of tokens by an LLM. |
Property Details
diffs
A list of diffs that represent the changes made by the AI collaboration.
For more information about our API support guarantees, see here.
Signature
readonly diffs: readonly Diff[];
Type: readonly Diff[]
errorMessage
The type of known error that occured - 'tokenLimitExceeded' indicates that the LLM exceeded the token limits set by the user - 'tooManyErrors' indicates that the LLM made too many errors in a row - 'tooManyModelCalls' indicates that the LLM made too many model calls - 'aborted' indicates that the AI collaboration was aborted by the user or a limiter - 'unexpectedError' indicates that an unexpected error occured
For more information about our API support guarantees, see here.
Signature
readonly errorMessage: "tokenLimitExceeded" | "tooManyErrors" | "tooManyModelCalls" | "aborted" | "unexpectedError";
Type: "tokenLimitExceeded" | "tooManyErrors" | "tooManyModelCalls" | "aborted" | "unexpectedError"
status
The status of the Ai Collaboration. - A 'partial-failure' status indicates that the AI collaboration was partially successful, but was aborted due to a limiter or other error - A "failure" status indicates that the AI collaboration was not successful at creating any changes.
For more information about our API support guarantees, see here.
Signature
readonly status: "failure" | "partial-failure";
Type: "failure" | "partial-failure"
tokensUsed
Total usage of tokens by an LLM.
For more information about our API support guarantees, see here.
Signature
readonly tokensUsed: TokenUsage;
Type: TokenUsage