promptflow.contracts.types module

class promptflow.contracts.types.AssistantDefinition(model: str, instructions: str, tools: List)

Bases: object

This class is used to define an assistant definition.

static deserialize(data: dict) → AssistantDefinition

instructions: str

model: str

serialize()

tools: List

class promptflow.contracts.types.AttrDict

Bases: dict

A dictionary that allows attribute access to its keys.

class promptflow.contracts.types.FilePath

Bases: str

This class is used to hint a parameter is a file path.

class promptflow.contracts.types.PromptTemplate

Bases: str

This class is used to hint a parameter is a prompt template.

class promptflow.contracts.types.Secret

Bases: str

This class is used to hint a parameter is a secret to load.

set_secret_name(name)

Set the secret_name attribute for the Secret instance.

Parameters:

name (str) – The name of the secret.