/** * The root of the declarative agent manifest document is a JSON object that contains * members that describe the declarative agent. */ export interface DeclarativeAgentManifestV1D2 { /** * Required. Not localizable. The version of the schema this manifest is using. */ version: "v1.2"; /** * Optional. Not localizable. */ id?: string; /** * Required. Localizable. The name of the declarative agent. It MUST contain at least one * nonwhitespace character and MUST be 100 characters or less. */ name: string; /** * Required. Localizable. The description of the declarative agent. It MUST contain at least * one nonwhitespace character and MUST be 1,000 characters or less. */ description: string; /** * Optional. Not localizable. The detailed instructions or guidelines on how the declarative * agent should behave, its functions, and any behaviors to avoid. It MUST contain at least * one nonwhitespace character and MUST be 8,000 characters or less. */ instructions?: string; /** * Optional. Contains an array of objects that define capabilities of the declarative agent. */ capabilities?: CapabilityElement[]; /** * Optional. A list of examples of questions that the declarative agent can answer. There * MUST NOT be more than six objects in the array. */ conversation_starters?: ConversationStarterElement[]; /** * Optional. A list of objects that identify API plugins that provide actions accessible to * the declarative agent. */ actions?: ActionElement[]; [property: string]: any; } /** * Identifies an API plugin manifest for a plugin used as an action by the declarative agent. */ export interface ActionElement { /** * Required. Not localizable. A unique identifier for the action. It MAY be represented by a * GUID. */ id: string; /** * Required. Not localizable. A path to the API plugin manifest for this action. */ file: string; [property: string]: any; } /** * Represents a base capability object. * * Indicates that the declarative agent can search the web for grounding information. * * Indicates that the declarative agent can search a user's SharePoint and OneDrive for * grounding information. * * Indicates that the declarative agent can search selected Microsoft Graph connectors for * grounding information. * * Indicates that the declarative agent can generate and execute code. * * Indicates that the declarative agent can images and art based on the text input from the * user. */ export interface CapabilityElement { /** * Required. The name of the capability. Allowed values are WebSearch, CodeInterpreter, * OneDriveAndSharePoint, GraphConnectors, and GraphicArt. * * Required. Must be set to WebSearch. * * Required. Must be set to OneDriveAndSharePoint. * * Required. Must be set to GraphConnectors. * * Required. Must be set to CodeInterpreter. * * Required. Must be set to GraphicArt. */ name: Name; /** * Optional. An array of sites used to constrain the content accessible to the DA to just * the content identified via the items of array. */ sites?: SiteElement[]; /** * Optional. An array of objects that identify SharePoint or OneDrive sources using IDs. */ items_by_sharepoint_ids?: ItemsBySharepointIDElement[]; /** * Optional. An array of objects that identify SharePoint or OneDrive sources by URL. */ items_by_url?: ItemsByURLElement[]; /** * Optional. An array of objects that identify the Microsoft Graph connectors available to * the declarative agent */ connections?: ConnectionElement[]; [property: string]: any; } /** * Identifies a Microsoft Graph connector. */ export interface ConnectionElement { /** * Required. Not localizable The unique identifier of the Microsoft Graph connector. */ connection_id: string; [property: string]: any; } /** * Contains one or more object identifiers that identify a SharePoint or OneDrive resource. */ export interface ItemsBySharepointIDElement { /** * Optional. Not localizable. The GUID identifier of a SharePoint or OneDrive site. */ site_id?: string; /** * Optional. Not localizable. The GUID identifier of a SharePoint or OneDrive web. */ web_id?: string; /** * Optional. Not localizable. The GUID identifier of a SharePoint or OneDrive list. */ list_id?: string; /** * Optional. Not localizable. The GUID identifier of a SharePoint or OneDrive item. */ unique_id?: string; } /** * Represents the URL of a SharePoint or OneDrive resource. */ export interface ItemsByURLElement { /** * Optional. Not localizable. An absolute URL to a SharePoint or OneDrive resource. */ url?: string; } export type Name = "WebSearch" | "CodeInterpreter" | "OneDriveAndSharePoint" | "GraphConnectors" | "GraphicArt"; /** * An object that identifies a site used to constrain the content accessible to the * declarative agent. */ export interface SiteElement { /** * An absolute URL to a site. */ url: string; [property: string]: any; } /** * Contains hints that are displayed to the user to demonstrate how they can get started * using the declarative agent. */ export interface ConversationStarterElement { /** * Required. Localizable. A suggestion that the user can use to obtain the desired result * from the DC. It MUST contain at least one nonwhitespace character. */ text: string; /** * Optional. Localizable. A unique title for the conversation starter. It MUST contain at * least one nonwhitespace character. */ title?: string; [property: string]: any; } export declare class Convert { static toDeclarativeAgentManifestV1D2(json: string): DeclarativeAgentManifestV1D2; static declarativeAgentManifestV1D2ToJson(value: DeclarativeAgentManifestV1D2): string; }