genieagents

type CreateGenieAgentRequest struct {
	// The Genie Agent to create.
	GenieAgent GenieAgent `json:"genie_agent"`
	// The ID for the new Genie Agent: 32 lowercase hexadecimal characters (a
	// UUID without dashes), not all zeros. Assigned by the server if omitted.
	// Fails with ALREADY_EXISTS if the ID is in use in the workspace, including
	// by a Genie Agent in the trash, or PERMISSION_DENIED if the caller cannot
	// view the Genie Agent using it.
	GenieAgentId string `json:"-" url:"genie_agent_id,omitempty"`

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

type DeleteGenieAgentRequest struct {
	// Etag from a previous read. On mismatch the delete fails with ABORTED and
	// nothing is deleted.
	Etag string `json:"-" url:"etag,omitempty"`
	// The resource name of the Genie Agent to delete, in the form
	// `agents/{genie_agent_id}`.
	Name string `json:"-" url:"-"`

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

type GenieAgent struct {
	// Time when the Genie Agent was created.
	CreateTime *time.Time `json:"create_time,omitempty"`
	// The definition of the Genie Agent: its sample questions, data sources,
	// instructions, and benchmarks. Must set at least one field. Returned on
	// get and on list with `GENIE_AGENT_VIEW_FULL`. Create and update return a
	// submitted definition unchanged; one the service would store differently,
	// or with a column config the workspace can't keep (unknown column, or a
	// display name while those are disabled), is rejected with
	// INVALID_PARAMETER_VALUE.
	Definition GenieAgentDefinition `json:"definition"`
	// Description of the Genie Agent.
	//
	// The maximum length is 4,096 characters. Requests with a longer value are
	// rejected with INVALID_PARAMETER_VALUE.
	Description string `json:"description,omitempty"`
	// Display name of the Genie Agent. Must be unique within its folder
	// (effective_parent_path): a create, rename, or move that would collide
	// with an existing Genie Agent's name in the target folder is rejected with
	// ALREADY_EXISTS.
	//
	// The maximum length is 63 characters. Requests with a longer value are
	// rejected with INVALID_PARAMETER_VALUE.
	DisplayName string `json:"display_name"`
	// The workspace folder that contains the Genie Agent.
	EffectiveParentPath string `json:"effective_parent_path,omitempty"`
	// Weak etag of `definition` only; metadata changes do not affect it. Send
	// it on update or delete to detect concurrent definition changes.
	Etag string `json:"etag,omitempty"`
	// The resource name of the Genie Agent, in the form
	// `agents/{genie_agent_id}`. Ignored on create.
	Name string `json:"name,omitempty"`
	// The workspace folder to create the Genie Agent in. If omitted, the
	// caller's home folder is used. Returned exactly as submitted; see
	// `effective_parent_path` for the current folder. On update, setting it
	// moves the Genie Agent and clearing it does not. At most 4,096 characters.
	ParentPath string `json:"parent_path,omitempty"`
	// Time when the Genie Agent was last modified.
	UpdateTime *time.Time `json:"update_time,omitempty"`
	// Warehouse associated with the Genie Agent.
	WarehouseId string `json:"warehouse_id"`

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

type GenieAgentBenchmarkAnswer struct {
	// The answer.
	Content string `json:"content"`
	// The format of the answer.
	Format GenieAgentBenchmarkAnswerFormat `json:"format"`
}

type GenieAgentBenchmarkAnswerFormat string

type GenieAgentBenchmarkQuestion struct {
	// The expected answer. At most one answer is supported; omit it when the
	// question has no expected answer.
	Answer []GenieAgentBenchmarkAnswer `json:"answer,omitempty"`
	// Notes on how to evaluate answers to the question.
	EvaluationNote string `json:"evaluation_note,omitempty"`
	// Identifier of the question: 32 lowercase hexadecimal characters, unique
	// within the Genie Agent.
	Id string `json:"id"`
	// The question.
	Question string `json:"question"`

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

type GenieAgentBenchmarks struct {
	// The benchmark questions, sorted by `id` in descending order.
	Questions []GenieAgentBenchmarkQuestion `json:"questions,omitempty"`
}

type GenieAgentColumnConfig struct {
	// The name of the column. Must exist in the table or metric view.
	Column string `json:"column"`
	// Description of the column, overriding its Unity Catalog comment.
	Description string `json:"description,omitempty"`
	// Display name of the column in the Genie Agent. Accepted only where column
	// display names are enabled for the workspace.
	DisplayName string `json:"display_name,omitempty"`
	// Whether the Genie Agent indexes the column's values to match them in
	// questions.
	EnableEntityMatching bool `json:"enable_entity_matching,omitempty"`
	// Whether the Genie Agent samples example values from the column to learn
	// its format.
	EnableFormatAssistance bool `json:"enable_format_assistance,omitempty"`
	// Whether the column is hidden from the Genie Agent.
	Exclude bool `json:"exclude,omitempty"`
	// Synonyms for the column name.
	Synonyms []string `json:"synonyms,omitempty"`

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

type GenieAgentConfig struct {
	// Sample questions shown to users of the Genie Agent, sorted by `id`.
	SampleQuestions []GenieAgentSampleQuestion `json:"sample_questions,omitempty"`
}

type GenieAgentDataSources struct {
	// Unity Catalog MCP connections, sorted by `mcp_connection`.
	McpConnections []GenieAgentMcpConnection `json:"mcp_connections,omitempty"`
	// Unity Catalog tables, views, and metric views, in the order they were
	// added.
	Tables []GenieAgentTable `json:"tables,omitempty"`
	// Unity Catalog volumes, in the order they were added.
	Volumes []GenieAgentVolume `json:"volumes,omitempty"`
}

type GenieAgentDefinition struct {
	// Benchmarks for evaluating the quality of the Genie Agent's answers.
	Benchmarks *GenieAgentBenchmarks `json:"benchmarks,omitempty"`
	// General settings of the Genie Agent.
	Config *GenieAgentConfig `json:"config,omitempty"`
	// The data the Genie Agent can access.
	DataSources *GenieAgentDataSources `json:"data_sources,omitempty"`
	// Instructions and SQL that guide how the Genie Agent answers questions.
	Instructions *GenieAgentInstructions `json:"instructions,omitempty"`
}

type GenieAgentExampleQuestionSql struct {
	// Identifier of the example: 32 lowercase hexadecimal characters, unique
	// within the Genie Agent.
	Id string `json:"id"`
	// Parameters used in the SQL, in the order given.
	Parameters []GenieAgentSqlParameter `json:"parameters,omitempty"`
	// The question.
	Question string `json:"question"`
	// The SQL that answers the question.
	Sql string `json:"sql"`
	// Guidance on when to use this example.
	UsageGuidance string `json:"usage_guidance,omitempty"`

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

type GenieAgentInstructions struct {
	// Example questions paired with the SQL that answers them.
	ExampleQuestionSqls []GenieAgentExampleQuestionSql `json:"example_question_sqls,omitempty"`
	// Predefined joins between tables or metric views.
	JoinSpecs []GenieAgentJoinSpec `json:"join_specs,omitempty"`
	// Unity Catalog SQL functions the generated SQL may call.
	SqlFunctions []GenieAgentSqlFunction `json:"sql_functions,omitempty"`
	// Reusable SQL filters, expressions, and measures.
	SqlSnippets *GenieAgentSqlSnippets `json:"sql_snippets,omitempty"`
	// General text instructions. At most one text instruction is supported.
	TextInstructions []GenieAgentTextInstruction `json:"text_instructions,omitempty"`
}

type GenieAgentJoinRelationshipType string

type GenieAgentJoinSource struct {
	// The alias the join condition uses for this side.
	Alias string `json:"alias,omitempty"`
	// The full three-level name of the table or metric view.
	Identifier string `json:"identifier"`

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

type GenieAgentJoinSpec struct {
	// Description of the join's purpose.
	Comment string `json:"comment,omitempty"`
	// Identifier of the join: 32 lowercase hexadecimal characters, unique
	// within the Genie Agent.
	Id string `json:"id"`
	// Guidance on when to use the join.
	Instruction string `json:"instruction,omitempty"`
	// The left side of the join.
	Left GenieAgentJoinSource `json:"left"`
	// How the rows of the two sides relate.
	RelationshipType GenieAgentJoinRelationshipType `json:"relationship_type,omitempty"`
	// The right side of the join.
	Right GenieAgentJoinSource `json:"right"`
	// The join condition, for example `orders.customer_id = customers.id`.
	Sql string `json:"sql"`

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

type GenieAgentMcpConnection struct {
	// The name of the Unity Catalog connection, for example
	// `system.ai.google_calendar`.
	McpConnection string `json:"mcp_connection"`
}

type GenieAgentSampleQuestion struct {
	// Identifier of the sample question: 32 lowercase hexadecimal characters,
	// unique within the Genie Agent.
	Id string `json:"id"`
	// The text of the question.
	Question string `json:"question"`
}

type GenieAgentSqlExpression struct {
	// The alias the Genie Agent uses for the expression in generated SQL.
	Alias string `json:"alias,omitempty"`
	// Display name of the expression.
	DisplayName string `json:"display_name,omitempty"`
	// Identifier of the expression: 32 lowercase hexadecimal characters, unique
	// within the Genie Agent.
	Id string `json:"id"`
	// Guidance on when to use the expression.
	Instruction string `json:"instruction,omitempty"`
	// The SQL of the expression.
	Sql string `json:"sql"`
	// Synonyms for the expression.
	Synonyms []string `json:"synonyms,omitempty"`

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

type GenieAgentSqlFilter struct {
	// Display name of the filter.
	DisplayName string `json:"display_name,omitempty"`
	// Identifier of the filter: 32 lowercase hexadecimal characters, unique
	// within the Genie Agent.
	Id string `json:"id"`
	// Guidance on when to use the filter.
	Instruction string `json:"instruction,omitempty"`
	// The SQL of the filter.
	Sql string `json:"sql"`
	// Synonyms for the filter.
	Synonyms []string `json:"synonyms,omitempty"`

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

type GenieAgentSqlFunction struct {
	// Identifier of the entry: 32 lowercase hexadecimal characters, unique
	// within the Genie Agent.
	Id string `json:"id"`
	// The full three-level name of the function, for example
	// `catalog.schema.function`.
	Identifier string `json:"identifier"`
}

type GenieAgentSqlMeasure struct {
	// The alias the Genie Agent uses for the measure in generated SQL.
	Alias string `json:"alias,omitempty"`
	// Display name of the measure.
	DisplayName string `json:"display_name,omitempty"`
	// Identifier of the measure: 32 lowercase hexadecimal characters, unique
	// within the Genie Agent.
	Id string `json:"id"`
	// Guidance on when to use the measure.
	Instruction string `json:"instruction,omitempty"`
	// The SQL of the measure.
	Sql string `json:"sql"`
	// Synonyms for the measure.
	Synonyms []string `json:"synonyms,omitempty"`

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

type GenieAgentSqlParameter struct {
	// The parameter's default value.
	DefaultValue *GenieAgentSqlParameterDefaultValue `json:"default_value,omitempty"`
	// Description of the parameter.
	Description string `json:"description,omitempty"`
	// The name of the parameter in the SQL.
	Name string `json:"name"`
	// The parameter's data type, for example `STRING` or `INTEGER`.
	TypeHint string `json:"type_hint,omitempty"`

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

type GenieAgentSqlParameterDefaultRange struct {
	// The upper end of the range.
	Max string `json:"max,omitempty"`
	// The lower end of the range.
	Min string `json:"min,omitempty"`

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

type GenieAgentSqlParameterDefaultValue struct {
	// The default range.
	ValueRange *GenieAgentSqlParameterDefaultRange `json:"value_range,omitempty"`
	// The default values. A single default is a one-element list.
	Values []string `json:"values,omitempty"`
}

type GenieAgentSqlSnippets struct {
	// Non-aggregated expressions (dimensions), such as `price * units`.
	Expressions []GenieAgentSqlExpression `json:"expressions,omitempty"`
	// Filters, such as `state = 'CA'`.
	Filters []GenieAgentSqlFilter `json:"filters,omitempty"`
	// Aggregated measures, such as `SUM(price * units)`.
	Measures []GenieAgentSqlMeasure `json:"measures,omitempty"`
}

type GenieAgentTable struct {
	// Column settings for the table, sorted by `column`.
	ColumnConfigs []GenieAgentColumnConfig `json:"column_configs,omitempty"`
	// Description of the table.
	Description string `json:"description,omitempty"`
	// The full three-level name, for example `catalog.schema.table`.
	Identifier string `json:"identifier"`

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

type GenieAgentTextInstruction struct {
	// The text of the instruction.
	Content string `json:"content"`
	// Identifier of the instruction: 32 lowercase hexadecimal characters,
	// unique within the Genie Agent.
	Id string `json:"id"`
}

type GenieAgentView string

type GenieAgentVolume struct {
	// Description of the volume.
	Description string `json:"description,omitempty"`
	// The volume path, for example `/Volumes/catalog/schema/volume`. May name a
	// directory or file within the volume.
	Path string `json:"path"`

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

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

type GenieAgentsInterface interface {

	// Creates a Genie Agent.
	CreateGenieAgent(ctx context.Context, request CreateGenieAgentRequest) (*GenieAgent, error)

	// Deletes a Genie Agent, moving it to trash.
	DeleteGenieAgent(ctx context.Context, request DeleteGenieAgentRequest) error

	// Gets a Genie Agent.
	GetGenieAgent(ctx context.Context, request GetGenieAgentRequest) (*GenieAgent, error)

	// Lists the Genie Agents in the workspace. Genie Agents created from an
	// integration (for example, from a dashboard) are not listed.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListGenieAgents(ctx context.Context, request ListGenieAgentsRequest) listing.Iterator[GenieAgent]

	// Lists the Genie Agents in the workspace. Genie Agents created from an
	// integration (for example, from a dashboard) are not listed.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListGenieAgentsAll(ctx context.Context, request ListGenieAgentsRequest) ([]GenieAgent, error)

	// Updates a Genie Agent. Only the fields named in update_mask are applied.
	UpdateGenieAgent(ctx context.Context, request UpdateGenieAgentRequest) (*GenieAgent, error)
}

type GetGenieAgentRequest struct {
	// The resource name of the Genie Agent to retrieve, in the form
	// `agents/{genie_agent_id}`.
	Name string `json:"-" url:"-"`
}

type ListGenieAgentsRequest struct {
	// Maximum number of Genie Agents to return per page. Defaults to 20 when
	// unset or 0; values above 100 are coerced to 100. Negative values are
	// rejected with INVALID_PARAMETER_VALUE. With `GENIE_AGENT_VIEW_FULL`, a
	// smaller per-page maximum applies.
	PageSize int `json:"-" url:"page_size,omitempty"`
	// Pagination token from a previous response's `next_page_token`. A token
	// that was not returned by this method is rejected with
	// INVALID_PARAMETER_VALUE.
	PageToken string `json:"-" url:"page_token,omitempty"`
	// The fields to return for each Genie Agent. Defaults to
	// `GENIE_AGENT_VIEW_BASIC`. Use `GENIE_AGENT_VIEW_FULL` only when the agent
	// bodies are needed, since it returns smaller pages.
	View GenieAgentView `json:"-" url:"view,omitempty"`

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

type ListGenieAgentsResponse struct {
	// The Genie Agents, with the fields selected by the request's `view`.
	GenieAgents []GenieAgent `json:"genie_agents,omitempty"`
	// Token to get the next page of results.
	NextPageToken string `json:"next_page_token,omitempty"`
	// Resource names, in the form `agents/{genie_agent_id}`, of Genie Agents in
	// this page that could not be read and are omitted from `genie_agents`.
	// Populated only for `GENIE_AGENT_VIEW_FULL`. To see why, get the Genie
	// Agent by name; to retry, repeat the request. Other kinds of resource
	// names may be added to this field in the future.
	Unreachable []string `json:"unreachable,omitempty"`

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

type UpdateGenieAgentRequest struct {
	// Etag from a previous read. On mismatch the update fails with ABORTED
	// (metadata changes may already be applied); get the agent and retry. May
	// return TEMPORARILY_UNAVAILABLE.
	Etag string `json:"-" url:"etag,omitempty"`
	// The Genie Agent to update. Its `name` identifies the resource; fields
	// named in update_mask are applied.
	GenieAgent GenieAgent `json:"genie_agent"`
	// The resource name of the Genie Agent, in the form
	// `agents/{genie_agent_id}`. Ignored on create.
	Name string `json:"-" url:"-"`
	// The set of fields to update. The mask is required and must name at least
	// one field; an empty or absent mask is rejected with
	// INVALID_PARAMETER_VALUE, as is a path that is not an updatable field.
	//
	// A field named in the mask takes the value from `genie_agent`, even when
	// it is unset there: an unset `description` is cleared; an unset
	// `display_name`, `warehouse_id`, or `definition` is rejected with
	// INVALID_PARAMETER_VALUE; an unset `parent_path` is cleared without moving
	// the Genie Agent. `definition` is replaced as a whole; paths within it are
	// not supported.
	//
	// The special value `*` replaces the whole Genie Agent, as if every
	// updatable field were named. It must be the only path in the mask. Prefer
	// naming fields explicitly: with `*`, any field added to Genie Agent later
	// is also replaced, so a client unaware of it may clear it.
	UpdateMask fieldmask.FieldMask `json:"-" url:"update_mask"`

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