DataSourceOutputContexts Enum

  • Reference

Definition

Namespace:
Azure.AI.OpenAI.Chat
Assembly:
Azure.AI.OpenAI.dll
Package:
Azure.AI.OpenAI v2.0.0
Package:
Azure.AI.OpenAI v2.1.0-beta.1

The include_context flags to request for an On Your Data retrieval result, which control what information will be available on ChatMessageContext instances in the response.

This enumeration supports a bitwise combination of its member values.

[System.Flags]
public enum DataSourceOutputContexts
[<System.Flags>]
type DataSourceOutputContexts = 
Public Enum DataSourceOutputContexts
Inheritance
Enum
DataSourceOutputContexts
Attributes
FlagsAttribute

Fields

Intent 1
Citations 2
AllRetrievedDocuments 4

Remarks

By default, intent and citations will be requested.

This value is provided as a bitmask flag. For example, to request intent and all_retrieved_documents contexts, use the bitwise OR operator by assigning Intent | AllRetrievedDocuments.

Applies to