AiCollabSuccessResponse Interface
A successful response from the AI collaboration.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/ai-collab/alpha.
For more information about our API support guarantees, see here.
Signature
export interface AiCollabSuccessResponse
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| diffs | Alpha | readonly | readonly Diff[] | A list of diffs that represent the changes made by the AI collaboration. |
| status | Alpha | readonly | "success" | The status of the Ai Collaboration. A 'success' status indicates that the AI collaboration was successful at creating 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.
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
readonly diffs: readonly Diff[];
Type: readonly Diff[]
status
The status of the Ai Collaboration. A 'success' status indicates that the AI collaboration was successful at creating changes.
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
readonly status: "success";
Type: "success"
tokensUsed
Total usage of tokens by an LLM.
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
readonly tokensUsed: TokenUsage;
Type: TokenUsage