Skip to main content

OpenAiClientOptions Interface

OpenAI client options for the AiCollabOptions interface.

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 OpenAiClientOptions

Properties

PropertyAlertsModifiersTypeDescription
clientAlphaOpenAIThe OpenAI client to use for the AI collaboration.
modelNameAlphaoptionalstringThe name of the target OpenAI model to use for the AI collaboration.

Property Details

client

The OpenAI client to use for 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

client: OpenAI;

Type: OpenAI

modelName

The name of the target OpenAI model to use for 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

modelName?: string;

Type: string