supervisoragents

type App struct {
	// App name
	Name string `json:"name"`
}

type CreateExampleRequest struct {
	// The example to create under the parent Supervisor Agent.
	Example Example `json:"example"`
	// Parent resource where this example will be created. Format:
	// supervisor-agents/{supervisor_agent_id}
	Parent string `json:"-" url:"-"`
}

type CreateSupervisorAgentRequest struct {
	// The Supervisor Agent to create.
	SupervisorAgent SupervisorAgent `json:"supervisor_agent"`
}

type CreateToolRequest struct {
	// Parent resource where this tool will be created. Format:
	// supervisor-agents/{supervisor_agent_id}
	Parent string `json:"-" url:"-"`

	Tool Tool `json:"tool"`
	// The ID to use for the tool, which will become the final component of the
	// tool's resource name.
	ToolId string `json:"-" url:"tool_id"`
}

type DeleteExampleRequest struct {
	// The resource name of the example to delete. Format:
	// supervisor-agents/{supervisor_agent_id}/examples/{example_id}
	Name string `json:"-" url:"-"`
}

type DeleteSupervisorAgentRequest struct {
	// The resource name of the Supervisor Agent. Format:
	// supervisor-agents/{supervisor_agent_id}
	Name string `json:"-" url:"-"`
}

type DeleteToolRequest struct {
	// The resource name of the Tool. Format:
	// supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
	Name string `json:"-" url:"-"`
}

type Example struct {
	// The universally unique identifier (UUID) of the example.
	ExampleId string `json:"example_id,omitempty"`
	// Guidelines for answering the question.
	Guidelines []string `json:"guidelines"`
	// Full resource name:
	// supervisor-agents/{supervisor_agent_id}/examples/{example_id}
	Name string `json:"name,omitempty"`
	// The example question.
	Question string `json:"question"`

	ForceSendFields []string `json:"-" url:"-"`
}

type GenieSpace struct {
	// Deprecated: use space_id instead. Still REQUIRED for backward
	// compatibility until a future API version removes it.
	Id string `json:"id"`
}

type GetExampleRequest struct {
	// The resource name of the example. Format:
	// supervisor-agents/{supervisor_agent_id}/examples/{example_id}
	Name string `json:"-" url:"-"`
}

type GetSupervisorAgentPermissionLevelsRequest struct {
	// The supervisor agent for which to get or manage permissions.
	SupervisorAgentId string `json:"-" url:"-"`
}

type GetSupervisorAgentPermissionLevelsResponse struct {
	// Specific permission levels
	PermissionLevels []SupervisorAgentPermissionsDescription `json:"permission_levels,omitempty"`
}

type GetSupervisorAgentPermissionsRequest struct {
	// The supervisor agent for which to get or manage permissions.
	SupervisorAgentId string `json:"-" url:"-"`
}

type GetSupervisorAgentRequest struct {
	// The resource name of the Supervisor Agent. Format:
	// supervisor-agents/{supervisor_agent_id}
	Name string `json:"-" url:"-"`
}

type GetToolRequest struct {
	// The resource name of the Tool. Format:
	// supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
	Name string `json:"-" url:"-"`
}

type KnowledgeAssistant struct {
	// The ID of the knowledge assistant.
	KnowledgeAssistantId string `json:"knowledge_assistant_id"`
	// Deprecated: use knowledge_assistant_id instead.
	ServingEndpointName string `json:"serving_endpoint_name,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type ListExamplesRequest struct {
	// The maximum number of examples to return. If unspecified, at most 100
	// examples will be returned. The maximum value is 100; values above 100
	// will be coerced to 100.
	PageSize int `json:"-" url:"page_size,omitempty"`
	// A page token, received from a previous `ListExamples` call. Provide this
	// to retrieve the subsequent page. If unspecified, the first page will be
	// returned.
	PageToken string `json:"-" url:"page_token,omitempty"`
	// Parent resource to list from. Format:
	// supervisor-agents/{supervisor_agent_id}
	Parent string `json:"-" url:"-"`

	ForceSendFields []string `json:"-" url:"-"`
}

type ListExamplesResponse struct {
	Examples []Example `json:"examples,omitempty"`

	NextPageToken string `json:"next_page_token,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type ListSupervisorAgentsRequest struct {
	// The maximum number of supervisor agents to return. If unspecified, at
	// most 100 supervisor agents will be returned. The maximum value is 100;
	// values above 100 will be coerced to 100.
	PageSize int `json:"-" url:"page_size,omitempty"`
	// A page token, received from a previous `ListSupervisorAgents` call.
	// Provide this to retrieve the subsequent page. If unspecified, the first
	// page will be returned.
	PageToken string `json:"-" url:"page_token,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type ListSupervisorAgentsResponse struct {
	// A token that can be sent as `page_token` to retrieve the next page. If
	// this field is omitted, there are no subsequent pages.
	NextPageToken string `json:"next_page_token,omitempty"`

	SupervisorAgents []SupervisorAgent `json:"supervisor_agents,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type ListToolsRequest struct {
	PageSize int `json:"-" url:"page_size,omitempty"`

	PageToken string `json:"-" url:"page_token,omitempty"`
	// Parent resource to list from. Format:
	// supervisor-agents/{supervisor_agent_id}
	Parent string `json:"-" url:"-"`

	ForceSendFields []string `json:"-" url:"-"`
}

type ListToolsResponse struct {
	NextPageToken string `json:"next_page_token,omitempty"`

	Tools []Tool `json:"tools,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type SupervisorAgent struct {
	// Creation timestamp.
	CreateTime *time.Time `json:"create_time,omitempty"`
	// The creator of the Supervisor Agent.
	Creator string `json:"creator,omitempty"`
	// Description of what this agent can do (user-facing).
	Description string `json:"description,omitempty"`
	// The display name of the Supervisor Agent, unique at workspace level.
	DisplayName string `json:"display_name"`
	// The name of the supervisor agent's serving endpoint.
	EndpointName string `json:"endpoint_name,omitempty"`
	// The MLflow experiment ID.
	ExperimentId string `json:"experiment_id,omitempty"`
	// Deprecated: Use supervisor_agent_id instead.
	Id string `json:"id,omitempty"`
	// Optional natural-language instructions for the supervisor agent.
	Instructions string `json:"instructions,omitempty"`
	// The resource name of the SupervisorAgent. Format:
	// supervisor-agents/{supervisor_agent_id}
	Name string `json:"name,omitempty"`
	// The universally unique identifier (UUID) of the Supervisor Agent.
	SupervisorAgentId string `json:"supervisor_agent_id,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type SupervisorAgentAccessControlRequest struct {
	// name of the group
	GroupName string `json:"group_name,omitempty"`

	PermissionLevel SupervisorAgentPermissionLevel `json:"permission_level,omitempty"`
	// application ID of a service principal
	ServicePrincipalName string `json:"service_principal_name,omitempty"`
	// name of the user
	UserName string `json:"user_name,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type SupervisorAgentAccessControlResponse struct {
	// All permissions.
	AllPermissions []SupervisorAgentPermission `json:"all_permissions,omitempty"`
	// Display name of the user or service principal.
	DisplayName string `json:"display_name,omitempty"`
	// name of the group
	GroupName string `json:"group_name,omitempty"`
	// Name of the service principal.
	ServicePrincipalName string `json:"service_principal_name,omitempty"`
	// name of the user
	UserName string `json:"user_name,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type SupervisorAgentPermission struct {
	Inherited bool `json:"inherited,omitempty"`

	InheritedFromObject []string `json:"inherited_from_object,omitempty"`

	PermissionLevel SupervisorAgentPermissionLevel `json:"permission_level,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type SupervisorAgentPermissionLevel string

type SupervisorAgentPermissions struct {
	AccessControlList []SupervisorAgentAccessControlResponse `json:"access_control_list,omitempty"`

	ObjectId string `json:"object_id,omitempty"`

	ObjectType string `json:"object_type,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type SupervisorAgentPermissionsDescription struct {
	Description string `json:"description,omitempty"`

	PermissionLevel SupervisorAgentPermissionLevel `json:"permission_level,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type SupervisorAgentPermissionsRequest struct {
	AccessControlList []SupervisorAgentAccessControlRequest `json:"access_control_list,omitempty"`
	// The supervisor agent for which to get or manage permissions.
	SupervisorAgentId string `json:"-" url:"-"`
}

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

type SupervisorAgentsInterface interface {

	// Creates an example for a Supervisor Agent.
	CreateExample(ctx context.Context, request CreateExampleRequest) (*Example, error)

	// Creates a new Supervisor Agent.
	CreateSupervisorAgent(ctx context.Context, request CreateSupervisorAgentRequest) (*SupervisorAgent, error)

	// Creates a Tool under a Supervisor Agent. Specify one of "genie_space",
	// "knowledge_assistant", "uc_function", "uc_connection", "app", "volume",
	// "dashboard", "table", "vector_search_index", "catalog", "schema",
	// "supervisor_agent", "web_search" in the request body. The legacy values
	// "lakeview_dashboard" and "uc_table" are also accepted and remain equivalent
	// to "dashboard" and "table" respectively.
	CreateTool(ctx context.Context, request CreateToolRequest) (*Tool, error)

	// Deletes an example from a Supervisor Agent.
	DeleteExample(ctx context.Context, request DeleteExampleRequest) error

	// Deletes a Supervisor Agent.
	DeleteSupervisorAgent(ctx context.Context, request DeleteSupervisorAgentRequest) error

	// Deletes a Tool.
	DeleteTool(ctx context.Context, request DeleteToolRequest) error

	// Gets an example from a Supervisor Agent.
	GetExample(ctx context.Context, request GetExampleRequest) (*Example, error)

	// Gets the permission levels that a user can have on an object.
	GetPermissionLevels(ctx context.Context, request GetSupervisorAgentPermissionLevelsRequest) (*GetSupervisorAgentPermissionLevelsResponse, error)

	// Gets the permission levels that a user can have on an object.
	GetPermissionLevelsBySupervisorAgentId(ctx context.Context, supervisorAgentId string) (*GetSupervisorAgentPermissionLevelsResponse, error)

	// Gets the permissions of a supervisor agent. Supervisor agents can inherit
	// permissions from their root object.
	GetPermissions(ctx context.Context, request GetSupervisorAgentPermissionsRequest) (*SupervisorAgentPermissions, error)

	// Gets the permissions of a supervisor agent. Supervisor agents can inherit
	// permissions from their root object.
	GetPermissionsBySupervisorAgentId(ctx context.Context, supervisorAgentId string) (*SupervisorAgentPermissions, error)

	// Gets a Supervisor Agent.
	GetSupervisorAgent(ctx context.Context, request GetSupervisorAgentRequest) (*SupervisorAgent, error)

	// Gets a Tool.
	GetTool(ctx context.Context, request GetToolRequest) (*Tool, error)

	// Lists examples under a Supervisor Agent.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListExamples(ctx context.Context, request ListExamplesRequest) listing.Iterator[Example]

	// Lists examples under a Supervisor Agent.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListExamplesAll(ctx context.Context, request ListExamplesRequest) ([]Example, error)

	// Lists Supervisor Agents.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListSupervisorAgents(ctx context.Context, request ListSupervisorAgentsRequest) listing.Iterator[SupervisorAgent]

	// Lists Supervisor Agents.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListSupervisorAgentsAll(ctx context.Context, request ListSupervisorAgentsRequest) ([]SupervisorAgent, error)

	// Lists Tools under a Supervisor Agent.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListTools(ctx context.Context, request ListToolsRequest) listing.Iterator[Tool]

	// Lists Tools under a Supervisor Agent.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListToolsAll(ctx context.Context, request ListToolsRequest) ([]Tool, error)

	// Sets permissions on an object, replacing existing permissions if they exist.
	// Deletes all direct permissions if none are specified. Objects can inherit
	// permissions from their root object.
	SetPermissions(ctx context.Context, request SupervisorAgentPermissionsRequest) (*SupervisorAgentPermissions, error)

	// Updates an example in a Supervisor Agent.
	UpdateExample(ctx context.Context, request UpdateExampleRequest) (*Example, error)

	// Updates the permissions on a supervisor agent. Supervisor agents can inherit
	// permissions from their root object.
	UpdatePermissions(ctx context.Context, request SupervisorAgentPermissionsRequest) (*SupervisorAgentPermissions, error)

	// Updates a Supervisor Agent. The fields that are required depend on the paths
	// specified in `update_mask`. Only fields included in the mask will be updated.
	UpdateSupervisorAgent(ctx context.Context, request UpdateSupervisorAgentRequest) (*SupervisorAgent, error)

	// Updates a Tool. Only the `description` field can be updated. To change
	// immutable fields such as tool type, spec, or tool ID, delete the tool and
	// recreate it.
	UpdateTool(ctx context.Context, request UpdateToolRequest) (*Tool, error)
}

type Tool struct {
	App *App `json:"app,omitempty"`
	// Description of what this tool does (user-facing).
	Description string `json:"description,omitempty"`

	GenieSpace *GenieSpace `json:"genie_space,omitempty"`
	// Deprecated: Use tool_id instead.
	Id string `json:"id,omitempty"`

	KnowledgeAssistant *KnowledgeAssistant `json:"knowledge_assistant,omitempty"`
	// Full resource name:
	// supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
	Name string `json:"name,omitempty"`
	// User specified id of the Tool.
	ToolId string `json:"tool_id,omitempty"`
	// Tool type. Must be one of: "genie_space", "knowledge_assistant",
	// "uc_function", "uc_connection", "app", "volume", "dashboard",
	// "serving_endpoint", "table", "vector_search_index", "catalog", "schema",
	// "supervisor_agent", "web_search". The legacy values "lakeview_dashboard"
	// and "uc_table" are also accepted and remain equivalent to "dashboard" and
	// "table" respectively.
	ToolType string `json:"tool_type"`

	UcConnection *UcConnection `json:"uc_connection,omitempty"`

	UcFunction *UcFunction `json:"uc_function,omitempty"`

	Volume *Volume `json:"volume,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type UcConnection struct {
	Name string `json:"name"`
}

type UcFunction struct {
	// Full uc function name
	Name string `json:"name"`
}

type UpdateExampleRequest struct {
	Example Example `json:"example"`
	// The resource name of the example to update. Format:
	// supervisor-agents/{supervisor_agent_id}/examples/{example_id}
	Name string `json:"-" url:"-"`
	// Comma-delimited list of fields to update on the example. Allowed values:
	// `question`, `guidelines`. Examples: - `question` - `question,guidelines`
	UpdateMask fieldmask.FieldMask `json:"-" url:"update_mask"`
}

type UpdateSupervisorAgentRequest struct {
	// The resource name of the SupervisorAgent. Format:
	// supervisor-agents/{supervisor_agent_id}
	Name string `json:"-" url:"-"`
	// The SupervisorAgent to update.
	SupervisorAgent SupervisorAgent `json:"supervisor_agent"`
	// Field mask for fields to be updated.
	UpdateMask fieldmask.FieldMask `json:"-" url:"update_mask"`
}

type UpdateToolRequest struct {
	// Full resource name:
	// supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
	Name string `json:"-" url:"-"`
	// The Tool to update.
	Tool Tool `json:"tool"`
	// Field mask for fields to be updated.
	UpdateMask fieldmask.FieldMask `json:"-" url:"update_mask"`
}

type Volume struct {
	// Full uc volume name
	Name string `json:"name"`
}