ai

Documentation

Index

• func AiStudioDeploymentLink(tenantId string, subscriptionId string, resourceGroup string, ...) string
• func AiStudioWorkspaceLink(tenantId string, subscriptionId string, resourceGroup string, ...) string
• func ParseConfig[T comparable](config any) (*T, error)
• type ComponentConfig
• type DeploymentConfig
• type EndpointDeploymentConfig
• type Flow
• type PythonBridge
  • func NewPythonBridge(azdCtx *azdcontext.AzdContext, pythonCli *python.Cli) PythonBridge
• type Scope
  • func NewScope(subscriptionId string, resourceGroup string, workspace string) *Scope
  • func (s *Scope) ResourceGroup() string
  • func (s *Scope) SubscriptionId() string
  • func (s *Scope) Workspace() string
• type ScriptPath

Functions

func AiStudioDeploymentLink

func AiStudioDeploymentLink(
	tenantId string,
	subscriptionId string,
	resourceGroup string,
	workspaceName string,
	endpointName string,
	deploymentName string,
) string

AzureAiStudioDeploymentLink returns a link to the Azure AI Studio deployment page

func AiStudioWorkspaceLink

func AiStudioWorkspaceLink(tenantId string, subscriptionId string, resourceGroup string, workspaceName string) string

AiStudioWorkspaceLink returns a link to the Azure AI Studio workspace page

func ParseConfig

func ParseConfig[T comparable](config any) (*T, error)

ParseConfig parses a config from a generic interface.

Types

type ComponentConfig

type ComponentConfig struct {
	Name      osutil.ExpandableString            `yaml:"name,omitempty"`
	Path      string                             `yaml:"path,omitempty"`
	Overrides map[string]osutil.ExpandableString `yaml:"overrides,omitempty"`
}

ComponentConfig is a base configuration structure used by multiple AI components

type DeploymentConfig

type DeploymentConfig struct {
	ComponentConfig `yaml:",inline"`
	// A map of environment variables to set for the deployment
	Environment map[string]osutil.ExpandableString `yaml:"environment,omitempty"`
}

type EndpointDeploymentConfig

type EndpointDeploymentConfig struct {
	Workspace   osutil.ExpandableString `yaml:"workspace,omitempty"`
	Environment *ComponentConfig        `yaml:"environment,omitempty"`
	Model       *ComponentConfig        `yaml:"model,omitempty"`
	Flow        *ComponentConfig        `yaml:"flow,omitempty"`
	Deployment  *DeploymentConfig       `yaml:"deployment,omitempty"`
}

EndpointDeploymentConfig is a configuration structure for an ML online endpoint deployment

type Flow

type Flow struct {
	Name        string            `json:"name"`
	Description string            `json:"description"`
	Type        string            `json:"type"`
	Path        string            `json:"path"`
	DisplayName string            `json:"display_name"`
	Tags        map[string]string `json:"tags"`
}

Flow is a configuration to defined a Prompt flow component

type PythonBridge

type PythonBridge interface {
	Initialize(ctx context.Context) error
	RequiredExternalTools(ctx context.Context) []tools.ExternalTool
	Run(ctx context.Context, scriptName ScriptPath, args ...string) (*exec.RunResult, error)
}

PythonBridge is an interface to execute python components from the embedded AI resources project

func NewPythonBridge

func NewPythonBridge(
	azdCtx *azdcontext.AzdContext,
	pythonCli *python.Cli,
) PythonBridge

NewPythonBridge creates a new PythonBridge instance

type Scope

type Scope struct {
	// contains filtered or unexported fields
}

Scope is a context based structure to define the Azure scope of a AI component

func NewScope

func NewScope(subscriptionId string, resourceGroup string, workspace string) *Scope

NewScope creates a new Scope instance

func (*Scope) ResourceGroup

func (s *Scope) ResourceGroup() string

ResourceGroup returns the resource group from the scope

func (*Scope) SubscriptionId

func (s *Scope) SubscriptionId() string

SubscriptionId returns the subscription ID from the scope

func (*Scope) Workspace

func (s *Scope) Workspace() string

Workspace returns the workspace from the scope

type ScriptPath

type ScriptPath string

ScriptPath is a type to represent the path of a Python script

const (
	// PromptFlowClient is the path to the PromptFlow Client Python script
	PromptFlowClient ScriptPath = "pf_client.py"
	// MLClient is the path to the ML Client Python script
	MLClient ScriptPath = "ml_client.py"
)