promptflow.contracts.tool Modul#

class promptflow.contracts.tool.ConnectionType#

Basiert auf: object

Diese Klasse bietet Methoden zur Interaktion mit Verbindungstypen.

static get_connection_class(type_name: str) → Optional[type]#

Verbindungstyp nach Typnamen abrufen.

Parameter:

type_name (str) – Der Typname der Verbindung

Gibt zurück:

Der Verbindungstyp

Rückgabetyp:

type

static is_connection_class_name(type_name: str) → bool#

Prüfen, ob der angegebene Typname ein Verbindungstyp ist.

Parameter:

type_name (str) – Der Typname der Verbindung

Gibt zurück:

Ob der angegebene Typname ein Verbindungstyp ist

Rückgabetyp:

bool

static is_connection_value(val: Any) → bool#

Prüfen, ob der angegebene Wert eine Verbindung ist.

Parameter:

val (Any) – Der zu prüfende Wert

Gibt zurück:

Ob der angegebene Wert eine Verbindung ist

Rückgabetyp:

bool

static is_custom_strong_type(val: Any) → bool#

Prüfen, ob der angegebene Wert eine benutzerdefinierte starke Typverbindung ist.

Parameter:

val (Any) – Der zu prüfende Wert

Gibt zurück:

Ob der angegebene Wert ein benutzerdefinierter starker Typ ist

Rückgabetyp:

bool

static serialize_conn(connection: Any) → dict#

Die angegebene Verbindung serialisieren.

Parameter:

connection (Any) – Die zu serialisierende Verbindung

Gibt zurück:

Eine Wörterbuchdarstellung der Verbindung.

Rückgabetyp:

dict

class promptflow.contracts.tool.InputDefinition(type: List[ValueType], default: Optional[str] = None, description: Optional[str] = None, enum: Optional[List[str]] = None, custom_type: Optional[List[str]] = None)#

Basiert auf: object

Eingabedefinition.

custom_type: List[str] = None#
default: str = None#
description: str = None#
static deserialize(data: dict) → InputDefinition#

Dictionary zu Eingabedefinition deserialisieren.

Parameter:

data (dict) – Das zu deserialisierende Wörterbuch

Gibt zurück:

Die deserialisierte Eingabedefinition

Rückgabetyp:

InputDefinition

enum: List[str] = None#
serialize() → dict#

Eingabedefinition zu Dictionary serialisieren.

Gibt zurück:

Die serialisierte Eingabedefinition

Rückgabetyp:

dict

to_flow_input_definition()#

Wird für einen eifrigen Flow verwendet, um die Eingabedefinition in eine Flow-Eingabedefinition zu konvertieren.

type: List[ValueType]#
class promptflow.contracts.tool.OutputDefinition(type: List[ValueType], description: str = '', is_property: bool = False)#

Basiert auf: object

Ausgabedefinition.

description: str = ''#
static deserialize(data: dict) → OutputDefinition#

Dictionary zu Ausgabedefinition deserialisieren.

Parameter:

data (dict) – Das zu deserialisierende Wörterbuch

Gibt zurück:

Die deserialisierte Ausgabedefinition

Rückgabetyp:

OutputDefinition

is_property: bool = False#
serialize() → dict#

Ausgabedefinition zu Dictionary serialisieren.

Gibt zurück:

Die serialisierte Ausgabedefinition

Rückgabetyp:

dict

type: List[ValueType]#
class promptflow.contracts.tool.Tool(name: str, type: ToolType, inputs: Dict[str, InputDefinition], outputs: Optional[Dict[str, OutputDefinition]] = None, description: Optional[str] = None, module: Optional[str] = None, class_name: Optional[str] = None, source: Optional[str] = None, code: Optional[str] = None, function: Optional[str] = None, connection_type: Optional[List[str]] = None, is_builtin: Optional[bool] = None, stage: Optional[str] = None, enable_kwargs: Optional[bool] = False, deprecated_tools: Optional[List[str]] = None)#

Basiert auf: object

Werkzeugdefinition.

Parameter:

  • name (str) – Der Name des Werkzeugs

  • type (ToolType) – Der Typ des Werkzeugs

  • inputs (Dict[str, InputDefinition]) – Die Eingaben des Werkzeugs

  • outputs (Optional[Dict[str, OutputDefinition]]) – Die Ausgaben des Werkzeugs

  • description (Optional[str]) – Die Beschreibung des Werkzeugs

  • module (Optional[str]) – Das Modul des Werkzeugs

  • class_name (Optional[str]) – Der Klassenname des Werkzeugs

  • source (Optional[str]) – Die Quelle des Werkzeugs

  • code (Optional[str]) – Der Code des Werkzeugs

  • function (Optional[str]) – Die Funktion des Werkzeugs

  • connection_type (Optional[List[str]]) – Der Verbindungstyp des Werkzeugs

  • is_builtin (Optional[bool]) – Ob das Werkzeug ein integriertes Werkzeug ist

  • stage (Optional[str]) – Die Phase des Werkzeugs

  • enable_kwargs (Optional[bool]) – Ob kwargs aktiviert werden sollen, nur verfügbar für benutzerdefinierte Python-Werkzeuge

  • deprecated_tools (Optional[List[str]]) – Eine Liste alter Werkzeug-IDs, die der aktuellen Werkzeug-ID zugeordnet sind.

class_name: Optional[str] = None#
code: Optional[str] = None#
connection_type: Optional[List[str]] = None#
deprecated_tools: Optional[List[str]] = None#
description: Optional[str] = None#
static deserialize(data: dict) → Tool#

Dictionary zu Werkzeug deserialisieren.

Parameter:

data (dict) – Das zu deserialisierende Wörterbuch

Gibt zurück:

Das deserialisierte Werkzeug

Rückgabetyp:

Werkzeug

enable_kwargs: Optional[bool] = False#
function: Optional[str] = None#
inputs: Dict[str, InputDefinition]#
is_builtin: Optional[bool] = None#
module: Optional[str] = None#
name: str#
outputs: Optional[Dict[str, OutputDefinition]] = None#
serialize() → dict#

Werkzeug zu Dictionary serialisieren und Felder mit dem Wert None überspringen.

Gibt zurück:

Das serialisierte Werkzeug

Rückgabetyp:

dict

source: Optional[str] = None#
stage: Optional[str] = None#
type: ToolType#
class promptflow.contracts.tool.ToolFuncCallScenario(value)#

Bases: str, Enum

Eine Aufzählung.

DYNAMIC_LIST = 'dynamic_list'#
GENERATED_BY = 'generated_by'#
REVERSE_GENERATED_BY = 'reverse_generated_by'#
class promptflow.contracts.tool.ToolType(value)#

Bases: str, Enum

Werkzeugtypen.

CSHARP = 'csharp'#
CUSTOM_LLM = 'custom_llm'#
LLM = 'llm'#
PROMPT = 'prompt'#
PYTHON = 'python'#
class promptflow.contracts.tool.ValueType(value)#

Bases: str, Enum

Werttypen.

ASSISTANT_DEFINITION = 'assistant_definition'#
BOOL = 'bool'#
DOUBLE = 'double'#
FILE_PATH = 'file_path'#
IMAGE = 'image'#
INT = 'int'#
LIST = 'list'#
OBJECT = 'object'#
PROMPT_TEMPLATE = 'prompt_template'#
SECRET = 'secret'#
STRING = 'string'#
static from_type(t: type) → ValueType#

Hole ValueType nach Typ.

Parameter:

t (type) – Der Typ, der seinen ValueType benötigt

Gibt zurück:

Der ValueType des gegebenen Typs

Rückgabetyp:

ValueType

static from_value(t: Any) → ValueType#

Hole ValueType nach Wert.

Parameter:

t (Any) – Der Wert, der seinen ValueType benötigt

Gibt zurück:

Der ValueType des gegebenen Werts

Rückgabetyp:

ValueType

parse(v: Any) → Any#

Wert in den gegebenen ValueType parsen.

Parameter:

v (Any) – Der Wert, der in den gegebenen ValueType geparst werden soll

Gibt zurück:

Der geparste Wert

Rückgabetyp:

Any