azaiprojects

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 1, 2026 License: MIT Imports: 15 Imported by: 0

README

Microsoft Foundry Projects SDK

This package contains a temporary, internal Go SDK for the Microsoft Foundry Projects data-plane APIs used by Agent Framework.

We keep this SDK in-tree because the official Azure SDK for Go does not yet provide the AI Foundry Projects client surface needed by this repository. Once the official SDK supports these APIs, this package should be removed and callers should move back to the official Azure SDK module.

Generation

The SDK is generated from TypeSpec using go generate:

go generate ./internal/azaiprojects

The generation entrypoint is gen.go. It invokes tsp-client through pinned npx, so contributors need Node/npm but do not need a globally installed tsp-client.

The generated files use the z file prefix so hand-written package files can keep normal names such as client.go. The hand-written client file provides the constructor and cloud configuration that the Go emitter intentionally omits when generating into an existing containing module.

TypeSpec Source

The current TypeSpec source is pinned in tsp-location.yaml. It points at a fork and commit that include the Go emitter configuration required for this internal SDK.

After Azure/azure-rest-api-specs#44243 is merged, the TypeSpec source can be moved from the fork to the Azure REST API Specs Foundry development branch that contains the merged Go SDK emitter configuration. That should make the pinned source less temporary while we wait for the official Azure SDK for Go package to expose the needed Foundry APIs.

Documentation

Index

Constants

View Source 
const ServiceName cloud.ServiceName = moduleName

ServiceName is the cloud.ServiceName for Microsoft Foundry Projects.

Variables

This section is empty.

Functions

This section is empty.

Types

type A2APreviewTool 

type A2APreviewTool struct {
	// CONSTANT; The type of the tool. Always `"a2a_preview`.
	// Field has constant value ToolTypeA2APreview, any specified value is ignored.
	Type *ToolType

	// The path to the agent card relative to the `base_url`.
	// If not provided, defaults to `/.well-known/agent-card.json`
	AgentCardPath *string

	// Base URL of the agent.
	BaseURL *string

	// The connection ID in the project for the A2A server.
	// The connection stores authentication and other connection details needed to connect to the A2A server.
	ProjectConnectionID *string

	// When `true`, Foundry sends its credentials when fetching the remote
	// agent's Agent Card. The service defaults to `false` if a value is not
	// specified by the caller (anonymous fetch).
	SendCredentialsForAgentCard *bool
}

A2APreviewTool - An agent implementing the A2A protocol.

func (*A2APreviewTool) GetTool 

func (a *A2APreviewTool) GetTool() *Tool

GetTool implements the ToolClassification interface for type A2APreviewTool.

func (A2APreviewTool) MarshalJSON 

func (a A2APreviewTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type A2APreviewTool.

func (*A2APreviewTool) UnmarshalJSON 

func (a *A2APreviewTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type A2APreviewTool.

type A2APreviewToolboxTool 

type A2APreviewToolboxTool struct {
	// CONSTANT; Field has constant value ToolboxToolTypeA2APreview, any specified value is ignored.
	Type *ToolboxToolType

	// The path to the agent card relative to the `base_url`.
	// If not provided, defaults to `/.well-known/agent-card.json`
	AgentCardPath *string

	// Base URL of the agent.
	BaseURL *string

	// Optional user-defined description for this tool or configuration.
	Description *string

	// Optional user-defined name for this tool or configuration.
	Name *string

	// The connection ID in the project for the A2A server.
	// The connection stores authentication and other connection details needed to connect to the A2A server.
	ProjectConnectionID *string

	// When `true`, Foundry sends its credentials when fetching the remote
	// agent's Agent Card. The service defaults to `false` if a value is not
	// specified by the caller (anonymous fetch).
	SendCredentialsForAgentCard *bool

	// Per-tool configuration map. Keys are tool names or `*` (catch-all default).
	// Resolution order: exact tool name match takes priority over `*`.
	// Unknown tool names are silently ignored at runtime.
	ToolConfigs map[string]*ToolConfig
}

A2APreviewToolboxTool - An A2A tool stored in a toolbox.

func (*A2APreviewToolboxTool) GetToolboxTool 

func (a *A2APreviewToolboxTool) GetToolboxTool() *ToolboxTool

GetToolboxTool implements the ToolboxToolClassification interface for type A2APreviewToolboxTool.

func (A2APreviewToolboxTool) MarshalJSON 

func (a A2APreviewToolboxTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type A2APreviewToolboxTool.

func (*A2APreviewToolboxTool) UnmarshalJSON 

func (a *A2APreviewToolboxTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type A2APreviewToolboxTool.

type AISearchIndexResource 

type AISearchIndexResource struct {
	// filter string for search resource. [Learn more here](https://learn.microsoft.com/azure/search/search-filters).
	Filter *string

	// Index asset id for search resource.
	IndexAssetID *string

	// The name of an index in an IndexResource attached to this agent.
	IndexName *string

	// An index connection ID in an IndexResource attached to this agent.
	ProjectConnectionID *string

	// Type of query in an AIIndexResource attached to this agent.
	QueryType *AzureAISearchQueryType

	// Number of documents to retrieve from search and present to the model.
	TopK *int32
}

AISearchIndexResource - A AI Search Index resource.

func (AISearchIndexResource) MarshalJSON 

func (a AISearchIndexResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AISearchIndexResource.

func (*AISearchIndexResource) UnmarshalJSON 

func (a *AISearchIndexResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AISearchIndexResource.

type APIKeyCredentials 

type APIKeyCredentials struct {
	// READ-ONLY; The credential type
	Type *CredentialType

	// READ-ONLY; API Key
	APIKey *string
}

APIKeyCredentials - API Key Credential definition

func (*APIKeyCredentials) GetBaseCredentials 

func (a *APIKeyCredentials) GetBaseCredentials() *BaseCredentials

GetBaseCredentials implements the BaseCredentialsClassification interface for type APIKeyCredentials.

func (APIKeyCredentials) MarshalJSON 

func (a APIKeyCredentials) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type APIKeyCredentials.

func (*APIKeyCredentials) UnmarshalJSON 

func (a *APIKeyCredentials) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type APIKeyCredentials.

type AgentClusterInsightRequest 

type AgentClusterInsightRequest struct {
	// REQUIRED; Identifier for the agent.
	AgentName *string

	// CONSTANT; The type of request.
	// Field has constant value InsightTypeAgentClusterInsight, any specified value is ignored.
	Type *InsightType

	// Configuration of the model used in the insight generation.
	ModelConfiguration *InsightModelConfiguration
}

AgentClusterInsightRequest - Insights on set of Agent Evaluation Results

func (*AgentClusterInsightRequest) GetInsightRequest 

func (a *AgentClusterInsightRequest) GetInsightRequest() *InsightRequest

GetInsightRequest implements the InsightRequestClassification interface for type AgentClusterInsightRequest.

func (AgentClusterInsightRequest) MarshalJSON 

func (a AgentClusterInsightRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AgentClusterInsightRequest.

func (*AgentClusterInsightRequest) UnmarshalJSON 

func (a *AgentClusterInsightRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AgentClusterInsightRequest.

type AgentClusterInsightResult 

type AgentClusterInsightResult struct {
	// REQUIRED
	ClusterInsight *ClusterInsightResult

	// REQUIRED; The type of insights result.
	Type *InsightType
}

AgentClusterInsightResult - Insights from the agent cluster analysis.

func (*AgentClusterInsightResult) GetInsightResult 

func (a *AgentClusterInsightResult) GetInsightResult() *InsightResult

GetInsightResult implements the InsightResultClassification interface for type AgentClusterInsightResult.

func (AgentClusterInsightResult) MarshalJSON 

func (a AgentClusterInsightResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AgentClusterInsightResult.

func (*AgentClusterInsightResult) UnmarshalJSON 

func (a *AgentClusterInsightResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AgentClusterInsightResult.

type AgentEvaluatorGenerationJobSource 

type AgentEvaluatorGenerationJobSource struct {
	// REQUIRED; The agent name to fetch instructions from.
	AgentName *string

	// CONSTANT; The source type for this source, which is Agent.
	// Field has constant value EvaluatorGenerationJobSourceTypeAgent, any specified value is ignored.
	Type *EvaluatorGenerationJobSourceType

	// The agent version. If not specified, the latest version is used.
	AgentVersion *string

	// Optional description of what this source represents — helps the pipeline interpret its content (e.g., 'Company refund policy
	// document' or 'Describes the agent's core capabilities').
	Description *string
}

AgentEvaluatorGenerationJobSource - Agent source for evaluator generation jobs — references an agent to fetch instructions and metadata from.

func (*AgentEvaluatorGenerationJobSource) GetEvaluatorGenerationJobSource 

func (a *AgentEvaluatorGenerationJobSource) GetEvaluatorGenerationJobSource() *EvaluatorGenerationJobSource

GetEvaluatorGenerationJobSource implements the EvaluatorGenerationJobSourceClassification interface for type AgentEvaluatorGenerationJobSource.

func (AgentEvaluatorGenerationJobSource) MarshalJSON 

func (a AgentEvaluatorGenerationJobSource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AgentEvaluatorGenerationJobSource.

func (*AgentEvaluatorGenerationJobSource) UnmarshalJSON 

func (a *AgentEvaluatorGenerationJobSource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AgentEvaluatorGenerationJobSource.

type AgentTaxonomyInput 

type AgentTaxonomyInput struct {
	// REQUIRED; List of risk categories to evaluate against.
	RiskCategories []RiskCategory

	// REQUIRED; Target configuration for the agent.
	Target TargetClassification

	// CONSTANT; Input type of the evaluation taxonomy.
	// Field has constant value EvaluationTaxonomyInputTypeAgent, any specified value is ignored.
	Type *EvaluationTaxonomyInputType
}

AgentTaxonomyInput - Input configuration for the evaluation taxonomy when the input type is agent.

func (*AgentTaxonomyInput) GetEvaluationTaxonomyInput 

func (a *AgentTaxonomyInput) GetEvaluationTaxonomyInput() *EvaluationTaxonomyInput

GetEvaluationTaxonomyInput implements the EvaluationTaxonomyInputClassification interface for type AgentTaxonomyInput.

func (AgentTaxonomyInput) MarshalJSON 

func (a AgentTaxonomyInput) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AgentTaxonomyInput.

func (*AgentTaxonomyInput) UnmarshalJSON 

func (a *AgentTaxonomyInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AgentTaxonomyInput.

type AgenticIdentityPreviewCredentials 

type AgenticIdentityPreviewCredentials struct {
	// READ-ONLY; The credential type
	Type *CredentialType
}

AgenticIdentityPreviewCredentials - Agentic identity credential definition

func (*AgenticIdentityPreviewCredentials) GetBaseCredentials 

func (a *AgenticIdentityPreviewCredentials) GetBaseCredentials() *BaseCredentials

GetBaseCredentials implements the BaseCredentialsClassification interface for type AgenticIdentityPreviewCredentials.

func (AgenticIdentityPreviewCredentials) MarshalJSON 

func (a AgenticIdentityPreviewCredentials) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AgenticIdentityPreviewCredentials.

func (*AgenticIdentityPreviewCredentials) UnmarshalJSON 

func (a *AgenticIdentityPreviewCredentials) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AgenticIdentityPreviewCredentials.

type AgentsPagedResultEvaluatorGenerationJob 

type AgentsPagedResultEvaluatorGenerationJob struct {
	// REQUIRED; The requested list of items.
	Data []EvaluatorGenerationJob

	// REQUIRED; A value indicating whether there are additional values available not captured in this list.
	HasMore *bool

	// The first ID represented in this list.
	FirstID *string

	// The last ID represented in this list.
	LastID *string
}

AgentsPagedResultEvaluatorGenerationJob - The response data for a requested list of items.

func (AgentsPagedResultEvaluatorGenerationJob) MarshalJSON 

func (a AgentsPagedResultEvaluatorGenerationJob) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AgentsPagedResultEvaluatorGenerationJob.

func (*AgentsPagedResultEvaluatorGenerationJob) UnmarshalJSON 

func (a *AgentsPagedResultEvaluatorGenerationJob) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AgentsPagedResultEvaluatorGenerationJob.

type AgentsPagedResultMemoryItem 

type AgentsPagedResultMemoryItem struct {
	// REQUIRED; The requested list of items.
	Data []MemoryItemClassification

	// REQUIRED; A value indicating whether there are additional values available not captured in this list.
	HasMore *bool

	// The first ID represented in this list.
	FirstID *string

	// The last ID represented in this list.
	LastID *string
}

AgentsPagedResultMemoryItem - The response data for a requested list of items.

func (AgentsPagedResultMemoryItem) MarshalJSON 

func (a AgentsPagedResultMemoryItem) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AgentsPagedResultMemoryItem.

func (*AgentsPagedResultMemoryItem) UnmarshalJSON 

func (a *AgentsPagedResultMemoryItem) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AgentsPagedResultMemoryItem.

type AgentsPagedResultMemoryStoreObject 

type AgentsPagedResultMemoryStoreObject struct {
	// REQUIRED; The requested list of items.
	Data []MemoryStoreObject

	// REQUIRED; A value indicating whether there are additional values available not captured in this list.
	HasMore *bool

	// The first ID represented in this list.
	FirstID *string

	// The last ID represented in this list.
	LastID *string
}

AgentsPagedResultMemoryStoreObject - The response data for a requested list of items.

func (AgentsPagedResultMemoryStoreObject) MarshalJSON 

func (a AgentsPagedResultMemoryStoreObject) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AgentsPagedResultMemoryStoreObject.

func (*AgentsPagedResultMemoryStoreObject) UnmarshalJSON 

func (a *AgentsPagedResultMemoryStoreObject) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AgentsPagedResultMemoryStoreObject.

type AgentsPagedResultToolboxObject 

type AgentsPagedResultToolboxObject struct {
	// REQUIRED; The requested list of items.
	Data []ToolboxObject

	// REQUIRED; A value indicating whether there are additional values available not captured in this list.
	HasMore *bool

	// The first ID represented in this list.
	FirstID *string

	// The last ID represented in this list.
	LastID *string
}

AgentsPagedResultToolboxObject - The response data for a requested list of items.

func (AgentsPagedResultToolboxObject) MarshalJSON 

func (a AgentsPagedResultToolboxObject) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AgentsPagedResultToolboxObject.

func (*AgentsPagedResultToolboxObject) UnmarshalJSON 

func (a *AgentsPagedResultToolboxObject) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AgentsPagedResultToolboxObject.

type AgentsPagedResultToolboxVersionObject 

type AgentsPagedResultToolboxVersionObject struct {
	// REQUIRED; The requested list of items.
	Data []ToolboxVersionObject

	// REQUIRED; A value indicating whether there are additional values available not captured in this list.
	HasMore *bool

	// The first ID represented in this list.
	FirstID *string

	// The last ID represented in this list.
	LastID *string
}

AgentsPagedResultToolboxVersionObject - The response data for a requested list of items.

func (AgentsPagedResultToolboxVersionObject) MarshalJSON 

func (a AgentsPagedResultToolboxVersionObject) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AgentsPagedResultToolboxVersionObject.

func (*AgentsPagedResultToolboxVersionObject) UnmarshalJSON 

func (a *AgentsPagedResultToolboxVersionObject) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AgentsPagedResultToolboxVersionObject.

type ApplyPatchToolParam 

type ApplyPatchToolParam struct {
	// CONSTANT; The type of the tool. Always `apply_patch`.
	// Field has constant value ToolTypeApplyPatch, any specified value is ignored.
	Type *ToolType
}

ApplyPatchToolParam - Apply patch tool

Allows the assistant to create, delete, or update files using unified diffs.

func (*ApplyPatchToolParam) GetTool 

func (a *ApplyPatchToolParam) GetTool() *Tool

GetTool implements the ToolClassification interface for type ApplyPatchToolParam.

func (ApplyPatchToolParam) MarshalJSON 

func (a ApplyPatchToolParam) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplyPatchToolParam.

func (*ApplyPatchToolParam) UnmarshalJSON 

func (a *ApplyPatchToolParam) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ApplyPatchToolParam.

type ApproximateLocation 

type ApproximateLocation struct {
	// CONSTANT; The type of location approximation. Always `approximate`.
	// Field has constant value "approximate", any specified value is ignored.
	Type     *string
	City     *string
	Country  *string
	Region   *string
	Timezone *string
}

func (ApproximateLocation) MarshalJSON 

func (a ApproximateLocation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApproximateLocation.

func (*ApproximateLocation) UnmarshalJSON 

func (a *ApproximateLocation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ApproximateLocation.

type AttackStrategy 

type AttackStrategy string

AttackStrategy - Strategies for attacks. 

const (
	// AttackStrategyASCIIArt - Generates visual art using ASCII characters, often used for creative or obfuscation purposes.
	AttackStrategyASCIIArt AttackStrategy = "ascii_art"
	// AttackStrategyASCIISmuggler - Conceals data within ASCII characters, making it harder to detect.
	AttackStrategyASCIISmuggler AttackStrategy = "ascii_smuggler"
	// AttackStrategyAnsiAttack - Utilizes ANSI escape sequences to manipulate text appearance and behavior.
	AttackStrategyAnsiAttack AttackStrategy = "ansi_attack"
	// AttackStrategyAtbash - Implements the Atbash cipher, a simple substitution cipher where each letter is mapped to its reverse.
	AttackStrategyAtbash AttackStrategy = "atbash"
	// AttackStrategyBase64 - Encodes binary data into a text format using Base64, commonly used for data transmission.
	AttackStrategyBase64 AttackStrategy = "base64"
	// AttackStrategyBaseline - Represents the baseline direct adversarial probing, which is used by attack strategies as the
	// attack objective.
	AttackStrategyBaseline AttackStrategy = "baseline"
	// AttackStrategyBinary - Converts text into binary code, representing data in a series of 0s and 1s.
	AttackStrategyBinary AttackStrategy = "binary"
	// AttackStrategyCaesar - Applies the Caesar cipher, a substitution cipher that shifts characters by a fixed number of positions.
	AttackStrategyCaesar AttackStrategy = "caesar"
	// AttackStrategyCharacterSpace - Alters text by adding spaces between characters, often used for obfuscation.
	AttackStrategyCharacterSpace AttackStrategy = "character_space"
	// AttackStrategyCharacterSwap - Swaps characters within text to create variations or obfuscate the original content.
	AttackStrategyCharacterSwap AttackStrategy = "character_swap"
	// AttackStrategyCrescendo - Gradually increases the intensity or complexity of the attack over time.
	AttackStrategyCrescendo AttackStrategy = "crescendo"
	// AttackStrategyDiacritic - Adds diacritical marks to characters, changing their appearance and sometimes their meaning.
	AttackStrategyDiacritic AttackStrategy = "diacritic"
	// AttackStrategyDifficult - Represents a default set of difficult complexity attacks. Difficult complexity attacks include
	// attacks that require access to significant resources and effort to execute an attack such as knowledge of search-based
	// algorithms in addition to a generative AI model.
	AttackStrategyDifficult AttackStrategy = "difficult"
	// AttackStrategyEasy - Represents a default set of easy complexity attacks. Easy complexity attacks require less effort,
	// such as translation of a prompt into some encoding, and does not require any Large Language Model to convert or orchestrate.
	AttackStrategyEasy AttackStrategy = "easy"
	// AttackStrategyFlip - Flips characters from front to back, creating a mirrored effect.
	AttackStrategyFlip AttackStrategy = "flip"
	// AttackStrategyIndirectJailbreak - Represents indirect jailbreak attacks that use complex methods to bypass AI safeguards.
	AttackStrategyIndirectJailbreak AttackStrategy = "indirect_jailbreak"
	// AttackStrategyJailbreak - Injects specially crafted prompts to bypass AI safeguards, known as User Injected Prompt Attacks
	// (UPIA).
	AttackStrategyJailbreak AttackStrategy = "jailbreak"
	// AttackStrategyLeetspeak - Transforms text into Leetspeak, a form of encoding that replaces letters with similar-looking
	// numbers or symbols.
	AttackStrategyLeetspeak AttackStrategy = "leetspeak"
	// AttackStrategyModerate - Represents a default set of moderate complexity attacks. Moderate complexity attacks require having
	// access to resources such as another generative AI model.
	AttackStrategyModerate AttackStrategy = "moderate"
	// AttackStrategyMorse - Encodes text into Morse code, using dots and dashes to represent characters.
	AttackStrategyMorse AttackStrategy = "morse"
	// AttackStrategyMultiTurn - Creates multi-turn conversations to simulate extended interactions.
	AttackStrategyMultiTurn AttackStrategy = "multi_turn"
	// AttackStrategyROT13 - Applies the ROT13 cipher, a simple substitution cipher that shifts characters by 13 positions.
	AttackStrategyROT13 AttackStrategy = "rot13"
	// AttackStrategyStringJoin - Joins multiple strings together, often used for concatenation or obfuscation.
	AttackStrategyStringJoin AttackStrategy = "string_join"
	// AttackStrategySuffixAppend - Appends an adversarial suffix to the prompt.
	AttackStrategySuffixAppend AttackStrategy = "suffix_append"
	// AttackStrategyTense - Alters the tense of the text, changing its temporal context.
	AttackStrategyTense AttackStrategy = "tense"
	// AttackStrategyURL - Encodes text into URL format.
	AttackStrategyURL AttackStrategy = "url"
	// AttackStrategyUnicodeConfusable - Uses Unicode characters that look similar to standard characters, creating visual confusion.
	AttackStrategyUnicodeConfusable AttackStrategy = "unicode_confusable"
	// AttackStrategyUnicodeSubstitution - Substitutes standard characters with Unicode equivalents, often for obfuscation.
	AttackStrategyUnicodeSubstitution AttackStrategy = "unicode_substitution"
)

func PossibleAttackStrategyValues 

func PossibleAttackStrategyValues() []AttackStrategy

PossibleAttackStrategyValues returns the possible values for the AttackStrategy const type.

type AzureAIAgentTarget 

type AzureAIAgentTarget struct {
	// REQUIRED; The unique identifier of the Azure AI agent.
	Name *string

	// CONSTANT; The type of target, always `azure_ai_agent`.
	// Field has constant value "azure_ai_agent", any specified value is ignored.
	Type *string

	// The parameters used to control the sampling behavior of the agent during text generation.
	ToolDescriptions []ToolDescription
	Tools            []ToolClassification

	// The version of the Azure AI agent.
	Version *string
}

AzureAIAgentTarget - Represents a target specifying an Azure AI agent.

func (*AzureAIAgentTarget) GetTarget 

func (a *AzureAIAgentTarget) GetTarget() *Target

GetTarget implements the TargetClassification interface for type AzureAIAgentTarget.

func (AzureAIAgentTarget) MarshalJSON 

func (a AzureAIAgentTarget) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureAIAgentTarget.

func (*AzureAIAgentTarget) UnmarshalJSON 

func (a *AzureAIAgentTarget) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureAIAgentTarget.

type AzureAIModelTarget 

type AzureAIModelTarget struct {
	// CONSTANT; The type of target, always `azure_ai_model`.
	// Field has constant value "azure_ai_model", any specified value is ignored.
	Type *string

	// The unique identifier of the Azure AI model.
	Model *string

	// The parameters used to control the sampling behavior of the model during text generation.
	SamplingParams *ModelSamplingParams
}

AzureAIModelTarget - Represents a target specifying an Azure AI model for operations requiring model selection.

func (*AzureAIModelTarget) GetTarget 

func (a *AzureAIModelTarget) GetTarget() *Target

GetTarget implements the TargetClassification interface for type AzureAIModelTarget.

func (AzureAIModelTarget) MarshalJSON 

func (a AzureAIModelTarget) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureAIModelTarget.

func (*AzureAIModelTarget) UnmarshalJSON 

func (a *AzureAIModelTarget) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureAIModelTarget.

type AzureAISearchIndex 

type AzureAISearchIndex struct {
	// REQUIRED; Name of connection to Azure AI Search
	ConnectionName *string

	// REQUIRED; Name of index in Azure AI Search resource to attach
	IndexName *string

	// CONSTANT; Type of index
	// Field has constant value IndexTypeAzureSearch, any specified value is ignored.
	Type *IndexType

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The version of the resource
	Version *string

	// The asset description text.
	Description *string

	// Field mapping configuration
	FieldMapping *FieldMapping

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// READ-ONLY; Asset ID, a unique identifier for the asset
	ID *string
}

AzureAISearchIndex - Azure AI Search Index Definition

func (*AzureAISearchIndex) GetIndex 

func (a *AzureAISearchIndex) GetIndex() *Index

GetIndex implements the IndexClassification interface for type AzureAISearchIndex.

func (AzureAISearchIndex) MarshalJSON 

func (a AzureAISearchIndex) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureAISearchIndex.

func (*AzureAISearchIndex) UnmarshalJSON 

func (a *AzureAISearchIndex) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureAISearchIndex.

type AzureAISearchQueryType 

type AzureAISearchQueryType string

AzureAISearchQueryType - Available query types for Azure AI Search tool. 

const (
	// AzureAISearchQueryTypeSemantic - Query type `semantic`
	AzureAISearchQueryTypeSemantic AzureAISearchQueryType = "semantic"
	// AzureAISearchQueryTypeSimple - Query type `simple`
	AzureAISearchQueryTypeSimple AzureAISearchQueryType = "simple"
	// AzureAISearchQueryTypeVector - Query type `vector`
	AzureAISearchQueryTypeVector AzureAISearchQueryType = "vector"
	// AzureAISearchQueryTypeVectorSemanticHybrid - Query type `vector_semantic_hybrid`
	AzureAISearchQueryTypeVectorSemanticHybrid AzureAISearchQueryType = "vector_semantic_hybrid"
	// AzureAISearchQueryTypeVectorSimpleHybrid - Query type `vector_simple_hybrid`
	AzureAISearchQueryTypeVectorSimpleHybrid AzureAISearchQueryType = "vector_simple_hybrid"
)

func PossibleAzureAISearchQueryTypeValues 

func PossibleAzureAISearchQueryTypeValues() []AzureAISearchQueryType

PossibleAzureAISearchQueryTypeValues returns the possible values for the AzureAISearchQueryType const type.

type AzureAISearchTool 

type AzureAISearchTool struct {
	// REQUIRED; The azure ai search index resource.
	AzureAiSearch *AzureAISearchToolResource

	// CONSTANT; The object type, which is always 'azure_ai_search'.
	// Field has constant value ToolTypeAzureAiSearch, any specified value is ignored.
	Type *ToolType

	// Deprecated. This property is deprecated and will be removed in a future version.
	Description *string

	// Deprecated. This property is deprecated and will be removed in a future version.
	Name *string

	// Deprecated. This property is deprecated and will be removed in a future version.
	ToolConfigs map[string]*ToolConfig
}

AzureAISearchTool - The input definition information for an Azure AI search tool as used to configure an agent.

func (*AzureAISearchTool) GetTool 

func (a *AzureAISearchTool) GetTool() *Tool

GetTool implements the ToolClassification interface for type AzureAISearchTool.

func (AzureAISearchTool) MarshalJSON 

func (a AzureAISearchTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureAISearchTool.

func (*AzureAISearchTool) UnmarshalJSON 

func (a *AzureAISearchTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureAISearchTool.

type AzureAISearchToolResource 

type AzureAISearchToolResource struct {
	// REQUIRED; The indices attached to this agent. There can be a maximum of 1 index
	// resource attached to the agent.
	Indexes []AISearchIndexResource
}

AzureAISearchToolResource - A set of index resources used by the `azure_ai_search` tool.

func (AzureAISearchToolResource) MarshalJSON 

func (a AzureAISearchToolResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureAISearchToolResource.

func (*AzureAISearchToolResource) UnmarshalJSON 

func (a *AzureAISearchToolResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureAISearchToolResource.

type AzureAISearchToolboxTool 

type AzureAISearchToolboxTool struct {
	// REQUIRED; The azure ai search index resource.
	AzureAiSearch *AzureAISearchToolResource

	// CONSTANT; Field has constant value ToolboxToolTypeAzureAiSearch, any specified value is ignored.
	Type *ToolboxToolType

	// Optional user-defined description for this tool or configuration.
	Description *string

	// Optional user-defined name for this tool or configuration.
	Name *string

	// Deprecated. This property is deprecated and will be removed in a future version.
	ToolConfigs map[string]*ToolConfig
}

AzureAISearchToolboxTool - An Azure AI Search tool stored in a toolbox.

func (*AzureAISearchToolboxTool) GetToolboxTool 

func (a *AzureAISearchToolboxTool) GetToolboxTool() *ToolboxTool

GetToolboxTool implements the ToolboxToolClassification interface for type AzureAISearchToolboxTool.

func (AzureAISearchToolboxTool) MarshalJSON 

func (a AzureAISearchToolboxTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureAISearchToolboxTool.

func (*AzureAISearchToolboxTool) UnmarshalJSON 

func (a *AzureAISearchToolboxTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureAISearchToolboxTool.

type AzureFunctionBinding 

type AzureFunctionBinding struct {
	// REQUIRED; Storage queue.
	StorageQueue *AzureFunctionStorageQueue

	// CONSTANT; The type of binding, which is always 'storage_queue'.
	// Field has constant value "storage_queue", any specified value is ignored.
	Type *string
}

AzureFunctionBinding - The structure for keeping storage queue name and URI.

func (AzureFunctionBinding) MarshalJSON 

func (a AzureFunctionBinding) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureFunctionBinding.

func (*AzureFunctionBinding) UnmarshalJSON 

func (a *AzureFunctionBinding) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureFunctionBinding.

type AzureFunctionDefinition 

type AzureFunctionDefinition struct {
	// REQUIRED; The definition of azure function and its parameters.
	Function *AzureFunctionDefinitionFunction

	// REQUIRED; Input storage queue. The queue storage trigger runs a function as messages are added to it.
	InputBinding *AzureFunctionBinding

	// REQUIRED; Output storage queue. The function writes output to this queue when the input items are processed.
	OutputBinding *AzureFunctionBinding
}

AzureFunctionDefinition - The definition of Azure function.

func (AzureFunctionDefinition) MarshalJSON 

func (a AzureFunctionDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureFunctionDefinition.

func (*AzureFunctionDefinition) UnmarshalJSON 

func (a *AzureFunctionDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureFunctionDefinition.

type AzureFunctionDefinitionFunction 

type AzureFunctionDefinitionFunction struct {
	// REQUIRED; The name of the function to be called.
	Name *string

	// REQUIRED; The parameters the functions accepts, described as a JSON Schema object.
	Parameters map[string]any

	// A description of what the function does, used by the model to choose when and how to call the function.
	Description *string
}

func (AzureFunctionDefinitionFunction) MarshalJSON 

func (a AzureFunctionDefinitionFunction) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureFunctionDefinitionFunction.

func (*AzureFunctionDefinitionFunction) UnmarshalJSON 

func (a *AzureFunctionDefinitionFunction) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureFunctionDefinitionFunction.

type AzureFunctionStorageQueue 

type AzureFunctionStorageQueue struct {
	// REQUIRED; The name of an Azure function storage queue.
	QueueName *string

	// REQUIRED; URI to the Azure Storage Queue service allowing you to manipulate a queue.
	QueueServiceEndpoint *string
}

AzureFunctionStorageQueue - The structure for keeping storage queue name and URI.

func (AzureFunctionStorageQueue) MarshalJSON 

func (a AzureFunctionStorageQueue) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureFunctionStorageQueue.

func (*AzureFunctionStorageQueue) UnmarshalJSON 

func (a *AzureFunctionStorageQueue) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureFunctionStorageQueue.

type AzureFunctionTool 

type AzureFunctionTool struct {
	// REQUIRED; The Azure Function Tool definition.
	AzureFunction *AzureFunctionDefinition

	// CONSTANT; The object type, which is always 'browser_automation'.
	// Field has constant value ToolTypeAzureFunction, any specified value is ignored.
	Type *ToolType

	// Deprecated. This property is deprecated and will be removed in a future version.
	ToolConfigs map[string]*ToolConfig
}

AzureFunctionTool - The input definition information for an Azure Function Tool, as used to configure an Agent.

func (*AzureFunctionTool) GetTool 

func (a *AzureFunctionTool) GetTool() *Tool

GetTool implements the ToolClassification interface for type AzureFunctionTool.

func (AzureFunctionTool) MarshalJSON 

func (a AzureFunctionTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureFunctionTool.

func (*AzureFunctionTool) UnmarshalJSON 

func (a *AzureFunctionTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureFunctionTool.

type AzureOpenAIModelConfiguration 

type AzureOpenAIModelConfiguration struct {
	// REQUIRED; Deployment name for AOAI model. Example: gpt-4o if in AIServices or connection based `connection_name/deployment_name`
	// (e.g. `my-aoai-connection/gpt-4o`).
	ModelDeploymentName *string

	// CONSTANT; Field has constant value "AzureOpenAIModel", any specified value is ignored.
	Type *string
}

AzureOpenAIModelConfiguration - Azure OpenAI model configuration. The API version would be selected by the service for querying the model.

func (*AzureOpenAIModelConfiguration) GetRedTeamTargetConfig 

func (a *AzureOpenAIModelConfiguration) GetRedTeamTargetConfig() *RedTeamTargetConfig

GetRedTeamTargetConfig implements the RedTeamTargetConfigClassification interface for type AzureOpenAIModelConfiguration.

func (AzureOpenAIModelConfiguration) MarshalJSON 

func (a AzureOpenAIModelConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureOpenAIModelConfiguration.

func (*AzureOpenAIModelConfiguration) UnmarshalJSON 

func (a *AzureOpenAIModelConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureOpenAIModelConfiguration.

type BaseCredentials 

type BaseCredentials struct {
	// READ-ONLY; The type of credential used by the connection
	Type *CredentialType
}

BaseCredentials - A base class for connection credentials

func (*BaseCredentials) GetBaseCredentials 

func (b *BaseCredentials) GetBaseCredentials() *BaseCredentials

GetBaseCredentials implements the BaseCredentialsClassification interface for type BaseCredentials.

func (BaseCredentials) MarshalJSON 

func (b BaseCredentials) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BaseCredentials.

func (*BaseCredentials) UnmarshalJSON 

func (b *BaseCredentials) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BaseCredentials.

type BaseCredentialsClassification 

type BaseCredentialsClassification interface {
	// GetBaseCredentials returns the BaseCredentials content of the underlying type.
	GetBaseCredentials() *BaseCredentials
}

BaseCredentialsClassification provides polymorphic access to related types. Call the interface's GetBaseCredentials() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *APIKeyCredentials, *AgenticIdentityPreviewCredentials, *BaseCredentials, *CustomCredential, *EntraIDCredentials, *NoAuthenticationCredentials, - *SASCredentials

type BingCustomSearchConfiguration 

type BingCustomSearchConfiguration struct {
	// REQUIRED; Name of the custom configuration instance given to config.
	InstanceName *string

	// REQUIRED; Project connection id for grounding with bing search
	ProjectConnectionID *string

	// The number of search results to return in the bing api response
	Count *int64

	// Filter search results by a specific time range. See [accepted values here](https://learn.microsoft.com/bing/search-apis/bing-web-search/reference/query-parameters).
	Freshness *string

	// The market where the results come from.
	Market *string

	// The language to use for user interface strings when calling Bing API.
	SetLang *string
}

BingCustomSearchConfiguration - A bing custom search configuration.

func (BingCustomSearchConfiguration) MarshalJSON 

func (b BingCustomSearchConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BingCustomSearchConfiguration.

func (*BingCustomSearchConfiguration) UnmarshalJSON 

func (b *BingCustomSearchConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BingCustomSearchConfiguration.

type BingCustomSearchPreviewTool 

type BingCustomSearchPreviewTool struct {
	// REQUIRED; The bing custom search tool parameters.
	BingCustomSearchPreview *BingCustomSearchToolParameters

	// CONSTANT; The object type, which is always 'bing_custom_search_preview'.
	// Field has constant value ToolTypeBingCustomSearchPreview, any specified value is ignored.
	Type *ToolType
}

BingCustomSearchPreviewTool - The input definition information for a Bing custom search tool as used to configure an agent.

func (*BingCustomSearchPreviewTool) GetTool 

func (b *BingCustomSearchPreviewTool) GetTool() *Tool

GetTool implements the ToolClassification interface for type BingCustomSearchPreviewTool.

func (BingCustomSearchPreviewTool) MarshalJSON 

func (b BingCustomSearchPreviewTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BingCustomSearchPreviewTool.

func (*BingCustomSearchPreviewTool) UnmarshalJSON 

func (b *BingCustomSearchPreviewTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BingCustomSearchPreviewTool.

type BingCustomSearchToolParameters 

type BingCustomSearchToolParameters struct {
	// REQUIRED; The project connections attached to this tool. There can be a maximum of 1 connection
	// resource attached to the tool.
	SearchConfigurations []BingCustomSearchConfiguration
}

BingCustomSearchToolParameters - The bing custom search tool parameters.

func (BingCustomSearchToolParameters) MarshalJSON 

func (b BingCustomSearchToolParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BingCustomSearchToolParameters.

func (*BingCustomSearchToolParameters) UnmarshalJSON 

func (b *BingCustomSearchToolParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BingCustomSearchToolParameters.

type BingGroundingSearchConfiguration 

type BingGroundingSearchConfiguration struct {
	// REQUIRED; Project connection id for grounding with bing search
	ProjectConnectionID *string

	// The number of search results to return in the bing api response
	Count *int64

	// Filter search results by a specific time range. See [accepted values here](https://learn.microsoft.com/bing/search-apis/bing-web-search/reference/query-parameters).
	Freshness *string

	// The market where the results come from.
	Market *string

	// The language to use for user interface strings when calling Bing API.
	SetLang *string
}

BingGroundingSearchConfiguration - Search configuration for Bing Grounding

func (BingGroundingSearchConfiguration) MarshalJSON 

func (b BingGroundingSearchConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BingGroundingSearchConfiguration.

func (*BingGroundingSearchConfiguration) UnmarshalJSON 

func (b *BingGroundingSearchConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BingGroundingSearchConfiguration.

type BingGroundingSearchToolParameters 

type BingGroundingSearchToolParameters struct {
	// REQUIRED; The search configurations attached to this tool. There can be a maximum of 1
	// search configuration resource attached to the tool.
	SearchConfigurations []BingGroundingSearchConfiguration
}

BingGroundingSearchToolParameters - The bing grounding search tool parameters.

func (BingGroundingSearchToolParameters) MarshalJSON 

func (b BingGroundingSearchToolParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BingGroundingSearchToolParameters.

func (*BingGroundingSearchToolParameters) UnmarshalJSON 

func (b *BingGroundingSearchToolParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BingGroundingSearchToolParameters.

type BingGroundingTool 

type BingGroundingTool struct {
	// REQUIRED; The bing grounding search tool parameters.
	BingGrounding *BingGroundingSearchToolParameters

	// CONSTANT; The object type, which is always 'bing_grounding'.
	// Field has constant value ToolTypeBingGrounding, any specified value is ignored.
	Type *ToolType

	// Deprecated. This property is deprecated and will be removed in a future version.
	Description *string

	// Deprecated. This property is deprecated and will be removed in a future version.
	Name *string

	// Deprecated. This property is deprecated and will be removed in a future version.
	ToolConfigs map[string]*ToolConfig
}

BingGroundingTool - The input definition information for a bing grounding search tool as used to configure an agent.

func (*BingGroundingTool) GetTool 

func (b *BingGroundingTool) GetTool() *Tool

GetTool implements the ToolClassification interface for type BingGroundingTool.

func (BingGroundingTool) MarshalJSON 

func (b BingGroundingTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BingGroundingTool.

func (*BingGroundingTool) UnmarshalJSON 

func (b *BingGroundingTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BingGroundingTool.

type BlobReference 

type BlobReference struct {
	// REQUIRED; Blob URI path for client to upload data. Example: `https://blob.windows.core.net/Container/Path`
	BlobURI *string

	// REQUIRED; Credential info to access the storage account.
	Credential *BlobReferenceSasCredential

	// REQUIRED; ARM ID of the storage account to use.
	StorageAccountArmID *string
}

BlobReference - Blob reference details.

func (BlobReference) MarshalJSON 

func (b BlobReference) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BlobReference.

func (*BlobReference) UnmarshalJSON 

func (b *BlobReference) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BlobReference.

type BlobReferenceSasCredential 

type BlobReferenceSasCredential struct {
	// READ-ONLY; SAS uri
	SasURI *string

	// READ-ONLY; Type of credential
	Type *string
}

BlobReferenceSasCredential - SAS Credential definition

func (BlobReferenceSasCredential) MarshalJSON 

func (b BlobReferenceSasCredential) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BlobReferenceSasCredential.

func (*BlobReferenceSasCredential) UnmarshalJSON 

func (b *BlobReferenceSasCredential) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BlobReferenceSasCredential.

type BrowserAutomationPreviewTool 

type BrowserAutomationPreviewTool struct {
	// REQUIRED; The Browser Automation Tool parameters.
	BrowserAutomationPreview *BrowserAutomationToolParameters

	// CONSTANT; The object type, which is always 'browser_automation_preview'.
	// Field has constant value ToolTypeBrowserAutomationPreview, any specified value is ignored.
	Type *ToolType
}

BrowserAutomationPreviewTool - The input definition information for a Browser Automation Tool, as used to configure an Agent.

func (*BrowserAutomationPreviewTool) GetTool 

func (b *BrowserAutomationPreviewTool) GetTool() *Tool

GetTool implements the ToolClassification interface for type BrowserAutomationPreviewTool.

func (BrowserAutomationPreviewTool) MarshalJSON 

func (b BrowserAutomationPreviewTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BrowserAutomationPreviewTool.

func (*BrowserAutomationPreviewTool) UnmarshalJSON 

func (b *BrowserAutomationPreviewTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BrowserAutomationPreviewTool.

type BrowserAutomationPreviewToolboxTool 

type BrowserAutomationPreviewToolboxTool struct {
	// REQUIRED; The Browser Automation Tool parameters.
	BrowserAutomationPreview *BrowserAutomationToolParameters

	// CONSTANT; Field has constant value ToolboxToolTypeBrowserAutomationPreview, any specified value is ignored.
	Type *ToolboxToolType

	// Optional user-defined description for this tool or configuration.
	Description *string

	// Optional user-defined name for this tool or configuration.
	Name *string

	// Per-tool configuration map. Keys are tool names or `*` (catch-all default).
	// Resolution order: exact tool name match takes priority over `*`.
	// Unknown tool names are silently ignored at runtime.
	ToolConfigs map[string]*ToolConfig
}

BrowserAutomationPreviewToolboxTool - A browser automation tool stored in a toolbox.

func (*BrowserAutomationPreviewToolboxTool) GetToolboxTool 

func (b *BrowserAutomationPreviewToolboxTool) GetToolboxTool() *ToolboxTool

GetToolboxTool implements the ToolboxToolClassification interface for type BrowserAutomationPreviewToolboxTool.

func (BrowserAutomationPreviewToolboxTool) MarshalJSON 

func (b BrowserAutomationPreviewToolboxTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BrowserAutomationPreviewToolboxTool.

func (*BrowserAutomationPreviewToolboxTool) UnmarshalJSON 

func (b *BrowserAutomationPreviewToolboxTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BrowserAutomationPreviewToolboxTool.

type BrowserAutomationToolConnectionParameters 

type BrowserAutomationToolConnectionParameters struct {
	// REQUIRED; The ID of the project connection to your Azure Playwright resource.
	ProjectConnectionID *string
}

BrowserAutomationToolConnectionParameters - Definition of input parameters for the connection used by the Browser Automation Tool.

func (BrowserAutomationToolConnectionParameters) MarshalJSON 

func (b BrowserAutomationToolConnectionParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BrowserAutomationToolConnectionParameters.

func (*BrowserAutomationToolConnectionParameters) UnmarshalJSON 

func (b *BrowserAutomationToolConnectionParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BrowserAutomationToolConnectionParameters.

type BrowserAutomationToolParameters 

type BrowserAutomationToolParameters struct {
	// REQUIRED; The project connection parameters associated with the Browser Automation Tool.
	Connection *BrowserAutomationToolConnectionParameters
}

BrowserAutomationToolParameters - Definition of input parameters for the Browser Automation Tool.

func (BrowserAutomationToolParameters) MarshalJSON 

func (b BrowserAutomationToolParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BrowserAutomationToolParameters.

func (*BrowserAutomationToolParameters) UnmarshalJSON 

func (b *BrowserAutomationToolParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BrowserAutomationToolParameters.

type CaptureStructuredOutputsTool 

type CaptureStructuredOutputsTool struct {
	// REQUIRED; The structured outputs to capture from the model.
	Outputs *StructuredOutputDefinition

	// CONSTANT; The type of the tool. Always `capture_structured_outputs`.
	// Field has constant value ToolTypeCaptureStructuredOutputs, any specified value is ignored.
	Type *ToolType

	// Deprecated. This property is deprecated and will be removed in a future version.
	Description *string

	// Deprecated. This property is deprecated and will be removed in a future version.
	Name *string

	// Deprecated. This property is deprecated and will be removed in a future version.
	ToolConfigs map[string]*ToolConfig
}

CaptureStructuredOutputsTool - A tool for capturing structured outputs

func (*CaptureStructuredOutputsTool) GetTool 

func (c *CaptureStructuredOutputsTool) GetTool() *Tool

GetTool implements the ToolClassification interface for type CaptureStructuredOutputsTool.

func (CaptureStructuredOutputsTool) MarshalJSON 

func (c CaptureStructuredOutputsTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CaptureStructuredOutputsTool.

func (*CaptureStructuredOutputsTool) UnmarshalJSON 

func (c *CaptureStructuredOutputsTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CaptureStructuredOutputsTool.

type ChartCoordinate 

type ChartCoordinate struct {
	// REQUIRED; Size of the chart element.
	Size *int32

	// REQUIRED; X-axis coordinate.
	X *int32

	// REQUIRED; Y-axis coordinate.
	Y *int32
}

ChartCoordinate - Coordinates for the analysis chart.

func (ChartCoordinate) MarshalJSON 

func (c ChartCoordinate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ChartCoordinate.

func (*ChartCoordinate) UnmarshalJSON 

func (c *ChartCoordinate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ChartCoordinate.

type ChatSummaryMemoryItem 

type ChatSummaryMemoryItem struct {
	// REQUIRED; The content of the memory.
	Content *string

	// REQUIRED; The kind of the memory item.
	Kind *MemoryItemKind

	// REQUIRED; The unique ID of the memory item.
	MemoryID *string

	// REQUIRED; The namespace that logically groups and isolates memories, such as a user ID.
	Scope *string

	// REQUIRED; The last update time of the memory item.
	UpdatedAt *time.Time
}

ChatSummaryMemoryItem - A memory item containing a summary extracted from conversations.

func (*ChatSummaryMemoryItem) GetMemoryItem 

func (c *ChatSummaryMemoryItem) GetMemoryItem() *MemoryItem

GetMemoryItem implements the MemoryItemClassification interface for type ChatSummaryMemoryItem.

func (ChatSummaryMemoryItem) MarshalJSON 

func (c ChatSummaryMemoryItem) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ChatSummaryMemoryItem.

func (*ChatSummaryMemoryItem) UnmarshalJSON 

func (c *ChatSummaryMemoryItem) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ChatSummaryMemoryItem.

type Client 

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

Client contains the methods for the service. Don't use this type directly, use a constructor function instead.

func NewClient 

func NewClient(endpoint string, credential azcore.TokenCredential, options *ClientOptions) (*Client, error)

NewClient creates a new instance of Client with the specified values.

  • endpoint - Service host.
  • credential - Used to authorize requests. Usually a credential from azidentity.
  • options - Contains optional client configuration. Pass nil to accept the default values.

func (*Client) NewConnectionsClient 

func (client *Client) NewConnectionsClient() *ConnectionsClient

NewConnectionsClient creates a new instance of ConnectionsClient.

func (*Client) NewDatasetsClient 

func (client *Client) NewDatasetsClient() *DatasetsClient

NewDatasetsClient creates a new instance of DatasetsClient.

func (*Client) NewDeploymentsClient 

func (client *Client) NewDeploymentsClient() *DeploymentsClient

NewDeploymentsClient creates a new instance of DeploymentsClient.

func (*Client) NewEvaluationRulesClient 

func (client *Client) NewEvaluationRulesClient() *EvaluationRulesClient

NewEvaluationRulesClient creates a new instance of EvaluationRulesClient.

func (*Client) NewEvaluationTaxonomiesClient 

func (client *Client) NewEvaluationTaxonomiesClient() *EvaluationTaxonomiesClient

NewEvaluationTaxonomiesClient creates a new instance of EvaluationTaxonomiesClient.

func (*Client) NewEvaluatorGenerationJobsClient 

func (client *Client) NewEvaluatorGenerationJobsClient() *EvaluatorGenerationJobsClient

NewEvaluatorGenerationJobsClient creates a new instance of EvaluatorGenerationJobsClient.

func (*Client) NewEvaluatorsClient 

func (client *Client) NewEvaluatorsClient() *EvaluatorsClient

NewEvaluatorsClient creates a new instance of EvaluatorsClient.

func (*Client) NewIndexesClient 

func (client *Client) NewIndexesClient() *IndexesClient

NewIndexesClient creates a new instance of IndexesClient.

func (*Client) NewInsightsClient 

func (client *Client) NewInsightsClient() *InsightsClient

NewInsightsClient creates a new instance of InsightsClient.

func (*Client) NewMemoryStoresClient 

func (client *Client) NewMemoryStoresClient() *MemoryStoresClient

NewMemoryStoresClient creates a new instance of MemoryStoresClient.

func (*Client) NewRedTeamsClient 

func (client *Client) NewRedTeamsClient() *RedTeamsClient

NewRedTeamsClient creates a new instance of RedTeamsClient.

func (*Client) NewSchedulesClient 

func (client *Client) NewSchedulesClient() *SchedulesClient

NewSchedulesClient creates a new instance of SchedulesClient.

func (*Client) NewToolboxesClient 

func (client *Client) NewToolboxesClient() *ToolboxesClient

NewToolboxesClient creates a new instance of ToolboxesClient.

type ClientOptions 

type ClientOptions struct {
	azcore.ClientOptions
}

ClientOptions contains the optional values for creating a Client.

type ClusterInsightResult 

type ClusterInsightResult struct {
	// REQUIRED; List of clusters identified in the insights.
	Clusters []InsightCluster

	// REQUIRED; Summary of the insights report.
	Summary *InsightSummary

	// Optional mapping of IDs to 2D coordinates used by the UX for visualization.
	// The map keys are string identifiers (for example, a cluster id or a sample id)
	// and the values are the coordinates and visual size for rendering on a 2D chart.
	// This property is omitted unless the client requests coordinates (for example,
	// by passing `includeCoordinates=true` as a query parameter).
	// Example:
	// “`
	// {
	// "cluster-1": { "x": 12, "y": 34, "size": 8 },
	// "sample-123": { "x": 18, "y": 22, "size": 4 }
	// }
	// “`
	// Coordinates are intended only for client-side visualization and do not
	// modify the canonical insights results.
	Coordinates map[string]*ChartCoordinate
}

ClusterInsightResult - Insights from the cluster analysis.

func (ClusterInsightResult) MarshalJSON 

func (c ClusterInsightResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClusterInsightResult.

func (*ClusterInsightResult) UnmarshalJSON 

func (c *ClusterInsightResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterInsightResult.

type ClusterTokenUsage 

type ClusterTokenUsage struct {
	// REQUIRED; input token usage
	InputTokenUsage *int32

	// REQUIRED; output token usage
	OutputTokenUsage *int32

	// REQUIRED; total token usage
	TotalTokenUsage *int32
}

ClusterTokenUsage - Token usage for cluster analysis

func (ClusterTokenUsage) MarshalJSON 

func (c ClusterTokenUsage) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClusterTokenUsage.

func (*ClusterTokenUsage) UnmarshalJSON 

func (c *ClusterTokenUsage) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterTokenUsage.

type CodeBasedEvaluatorDefinition 

type CodeBasedEvaluatorDefinition struct {
	// CONSTANT; Field has constant value EvaluatorDefinitionTypeCode, any specified value is ignored.
	Type *EvaluatorDefinitionType

	// The blob URI for the evaluator storage
	BlobURI *string

	// Inline code text for the evaluator
	CodeText *string

	// The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required.
	DataSchema map[string]any

	// The entry point Python file name for the uploaded evaluator code (e.g. 'answer_length_evaluator.py')
	EntryPoint *string

	// The container image tag to use for evaluator code execution
	ImageTag *string

	// The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required.
	InitParameters map[string]any

	// List of output metrics produced by this evaluator
	Metrics map[string]*EvaluatorMetric
}

CodeBasedEvaluatorDefinition - Code-based evaluator definition using python code

func (*CodeBasedEvaluatorDefinition) GetEvaluatorDefinition 

func (c *CodeBasedEvaluatorDefinition) GetEvaluatorDefinition() *EvaluatorDefinition

GetEvaluatorDefinition implements the EvaluatorDefinitionClassification interface for type CodeBasedEvaluatorDefinition.

func (CodeBasedEvaluatorDefinition) MarshalJSON 

func (c CodeBasedEvaluatorDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CodeBasedEvaluatorDefinition.

func (*CodeBasedEvaluatorDefinition) UnmarshalJSON 

func (c *CodeBasedEvaluatorDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CodeBasedEvaluatorDefinition.

type CodeInterpreterTool 

type CodeInterpreterTool struct {
	// CONSTANT; The type of the code interpreter tool. Always `code_interpreter`.
	// Field has constant value ToolTypeCodeInterpreter, any specified value is ignored.
	Type *ToolType

	// The code interpreter container. Can be a container ID or an object that
	// specifies uploaded file IDs to make available to your code, along with an
	// optional `memory_limit` setting.
	// If not provided, the service assumes auto.
	Container any

	// Deprecated. This property is deprecated and will be removed in a future version.
	Description *string

	// Deprecated. This property is deprecated and will be removed in a future version.
	Name *string

	// Deprecated. This property is deprecated and will be removed in a future version.
	ToolConfigs map[string]*ToolConfig
}

CodeInterpreterTool - Code interpreter

A tool that runs Python code to help generate a response to a prompt.

func (*CodeInterpreterTool) GetTool 

func (c *CodeInterpreterTool) GetTool() *Tool

GetTool implements the ToolClassification interface for type CodeInterpreterTool.

func (CodeInterpreterTool) MarshalJSON 

func (c CodeInterpreterTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CodeInterpreterTool.

func (*CodeInterpreterTool) UnmarshalJSON 

func (c *CodeInterpreterTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CodeInterpreterTool.

type CodeInterpreterToolboxTool 

type CodeInterpreterToolboxTool struct {
	// CONSTANT; Field has constant value ToolboxToolTypeCodeInterpreter, any specified value is ignored.
	Type *ToolboxToolType

	// The code interpreter container. Can be a container ID or an object that
	// specifies uploaded file IDs to make available to your code, along with an
	// optional `memory_limit` setting.
	// If not provided, the service assumes auto.
	Container any

	// Optional user-defined description for this tool or configuration.
	Description *string

	// Optional user-defined name for this tool or configuration.
	Name *string

	// Deprecated. This property is deprecated and will be removed in a future version.
	ToolConfigs map[string]*ToolConfig
}

CodeInterpreterToolboxTool - A code interpreter tool stored in a toolbox.

func (*CodeInterpreterToolboxTool) GetToolboxTool 

func (c *CodeInterpreterToolboxTool) GetToolboxTool() *ToolboxTool

GetToolboxTool implements the ToolboxToolClassification interface for type CodeInterpreterToolboxTool.

func (CodeInterpreterToolboxTool) MarshalJSON 

func (c CodeInterpreterToolboxTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CodeInterpreterToolboxTool.

func (*CodeInterpreterToolboxTool) UnmarshalJSON 

func (c *CodeInterpreterToolboxTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CodeInterpreterToolboxTool.

type ComputerEnvironment 

type ComputerEnvironment string
const (
	ComputerEnvironmentBrowser ComputerEnvironment = "browser"
	ComputerEnvironmentLinux   ComputerEnvironment = "linux"
	ComputerEnvironmentMac     ComputerEnvironment = "mac"
	ComputerEnvironmentUbuntu  ComputerEnvironment = "ubuntu"
	ComputerEnvironmentWindows ComputerEnvironment = "windows"
)

func PossibleComputerEnvironmentValues 

func PossibleComputerEnvironmentValues() []ComputerEnvironment

PossibleComputerEnvironmentValues returns the possible values for the ComputerEnvironment const type.

type ComputerTool 

type ComputerTool struct {
	// CONSTANT; The type of the computer tool. Always `computer`.
	// Field has constant value ToolTypeComputer, any specified value is ignored.
	Type *ToolType
}

ComputerTool - Computer

A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).

func (*ComputerTool) GetTool 

func (c *ComputerTool) GetTool() *Tool

GetTool implements the ToolClassification interface for type ComputerTool.

func (ComputerTool) MarshalJSON 

func (c ComputerTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ComputerTool.

func (*ComputerTool) UnmarshalJSON 

func (c *ComputerTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ComputerTool.

type ComputerUsePreviewTool 

type ComputerUsePreviewTool struct {
	// REQUIRED; The height of the computer display.
	DisplayHeight *int64

	// REQUIRED; The width of the computer display.
	DisplayWidth *int64

	// REQUIRED; The type of computer environment to control.
	Environment *ComputerEnvironment

	// CONSTANT; The type of the computer use tool. Always `computer_use_preview`.
	// Field has constant value ToolTypeComputerUsePreview, any specified value is ignored.
	Type *ToolType
}

ComputerUsePreviewTool - Computer use preview

A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).

func (*ComputerUsePreviewTool) GetTool 

func (c *ComputerUsePreviewTool) GetTool() *Tool

GetTool implements the ToolClassification interface for type ComputerUsePreviewTool.

func (ComputerUsePreviewTool) MarshalJSON 

func (c ComputerUsePreviewTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ComputerUsePreviewTool.

func (*ComputerUsePreviewTool) UnmarshalJSON 

func (c *ComputerUsePreviewTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ComputerUsePreviewTool.

type Connection 

type Connection struct {
	// READ-ONLY; The credentials used by the connection
	Credentials BaseCredentialsClassification

	// READ-ONLY; A unique identifier for the connection, generated by the service
	ID *string

	// READ-ONLY; Whether the connection is tagged as the default connection of its type
	IsDefault *bool

	// READ-ONLY; Metadata of the connection
	Metadata map[string]*string

	// READ-ONLY; The friendly name of the connection, provided by the user.
	Name *string

	// READ-ONLY; The connection URL to be used for this service
	Target *string

	// READ-ONLY; Category of the connection
	Type *ConnectionType
}

Connection - Response from the list and get connections operations

func (Connection) MarshalJSON 

func (c Connection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Connection.

func (*Connection) UnmarshalJSON 

func (c *Connection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Connection.

type ConnectionType 

type ConnectionType string

ConnectionType - The Type (or category) of the connection 

const (
	// ConnectionTypeAPIKey - Generic connection that uses API Key authentication
	ConnectionTypeAPIKey ConnectionType = "ApiKey"
	// ConnectionTypeApplicationConfiguration - Application Configuration
	ConnectionTypeApplicationConfiguration ConnectionType = "AppConfig"
	// ConnectionTypeApplicationInsights - Application Insights
	ConnectionTypeApplicationInsights ConnectionType = "AppInsights"
	// ConnectionTypeAzureAISearch - Azure AI Search
	ConnectionTypeAzureAISearch ConnectionType = "CognitiveSearch"
	// ConnectionTypeAzureBlobStorage - Azure Blob Storage, with specified container
	ConnectionTypeAzureBlobStorage ConnectionType = "AzureBlob"
	// ConnectionTypeAzureOpenAI - Azure OpenAI Service
	ConnectionTypeAzureOpenAI ConnectionType = "AzureOpenAI"
	// ConnectionTypeAzureStorageAccount - Azure Blob Storage, with container not specified (used by Agents)
	ConnectionTypeAzureStorageAccount ConnectionType = "AzureStorageAccount"
	// ConnectionTypeCosmosDB - CosmosDB
	ConnectionTypeCosmosDB ConnectionType = "CosmosDB"
	// ConnectionTypeCustom - Custom Keys
	ConnectionTypeCustom ConnectionType = "CustomKeys"
	// ConnectionTypeRemoteTool - Remote tool
	ConnectionTypeRemoteTool ConnectionType = "RemoteTool_Preview"
)

func PossibleConnectionTypeValues 

func PossibleConnectionTypeValues() []ConnectionType

PossibleConnectionTypeValues returns the possible values for the ConnectionType const type.

type ConnectionsClient 

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

ConnectionsClient contains the methods for the Connections group. Don't use this type directly, use Client.NewConnectionsClient instead.

Generated from API version v1

func (*ConnectionsClient) NewListPager 

func (client *ConnectionsClient) NewListPager(options *ConnectionsClientListOptions) *runtime.Pager[ConnectionsClientListResponse]

NewListPager - List connections

Returns the connections available in the current project, optionally filtered by type or default status.

  • options - ConnectionsClientListOptions contains the optional parameters for the ConnectionsClient.NewListPager method.

type ConnectionsClientListOptions 

type ConnectionsClientListOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Lists connections of this specific type
	ConnectionType *ConnectionType

	// Lists connections that are default connections
	DefaultConnection *bool
}

ConnectionsClientListOptions contains the optional parameters for the ConnectionsClient.NewListPager method.

type ConnectionsClientListResponse 

type ConnectionsClientListResponse struct {
	// Paged collection of Connection items
	PagedConnection

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string
}

ConnectionsClientListResponse contains the response from method ConnectionsClient.NewListPager.

type ContainerAutoParam 

type ContainerAutoParam struct {
	// CONSTANT; Automatically creates a container for this request
	// Field has constant value FunctionShellToolParamEnvironmentTypeContainerAuto, any specified value is ignored.
	Type *FunctionShellToolParamEnvironmentType

	// An optional list of uploaded files to make available to your code.
	FileIDs       []string
	MemoryLimit   *ContainerMemoryLimit
	NetworkPolicy ContainerNetworkPolicyParamClassification

	// An optional list of skills referenced by id or inline data.
	Skills []ContainerSkillClassification
}

func (*ContainerAutoParam) GetFunctionShellToolParamEnvironment 

func (c *ContainerAutoParam) GetFunctionShellToolParamEnvironment() *FunctionShellToolParamEnvironment

GetFunctionShellToolParamEnvironment implements the FunctionShellToolParamEnvironmentClassification interface for type ContainerAutoParam.

func (ContainerAutoParam) MarshalJSON 

func (c ContainerAutoParam) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerAutoParam.

func (*ContainerAutoParam) UnmarshalJSON 

func (c *ContainerAutoParam) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerAutoParam.

type ContainerMemoryLimit 

type ContainerMemoryLimit string
const (
	ContainerMemoryLimit16G ContainerMemoryLimit = "16g"
	ContainerMemoryLimit1G  ContainerMemoryLimit = "1g"
	ContainerMemoryLimit4G  ContainerMemoryLimit = "4g"
	ContainerMemoryLimit64G ContainerMemoryLimit = "64g"
)

func PossibleContainerMemoryLimitValues 

func PossibleContainerMemoryLimitValues() []ContainerMemoryLimit

PossibleContainerMemoryLimitValues returns the possible values for the ContainerMemoryLimit const type.

type ContainerNetworkPolicyAllowlistParam 

type ContainerNetworkPolicyAllowlistParam struct {
	// REQUIRED; A list of allowed domains when type is `allowlist`.
	AllowedDomains []string

	// CONSTANT; Allow outbound network access only to specified domains. Always `allowlist`.
	// Field has constant value ContainerNetworkPolicyParamTypeAllowlist, any specified value is ignored.
	Type *ContainerNetworkPolicyParamType

	// Optional domain-scoped secrets for allowlisted domains.
	DomainSecrets []ContainerNetworkPolicyDomainSecretParam
}

func (*ContainerNetworkPolicyAllowlistParam) GetContainerNetworkPolicyParam 

func (c *ContainerNetworkPolicyAllowlistParam) GetContainerNetworkPolicyParam() *ContainerNetworkPolicyParam

GetContainerNetworkPolicyParam implements the ContainerNetworkPolicyParamClassification interface for type ContainerNetworkPolicyAllowlistParam.

func (ContainerNetworkPolicyAllowlistParam) MarshalJSON 

func (c ContainerNetworkPolicyAllowlistParam) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerNetworkPolicyAllowlistParam.

func (*ContainerNetworkPolicyAllowlistParam) UnmarshalJSON 

func (c *ContainerNetworkPolicyAllowlistParam) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerNetworkPolicyAllowlistParam.

type ContainerNetworkPolicyDisabledParam 

type ContainerNetworkPolicyDisabledParam struct {
	// CONSTANT; Disable outbound network access. Always `disabled`.
	// Field has constant value ContainerNetworkPolicyParamTypeDisabled, any specified value is ignored.
	Type *ContainerNetworkPolicyParamType
}

func (*ContainerNetworkPolicyDisabledParam) GetContainerNetworkPolicyParam 

func (c *ContainerNetworkPolicyDisabledParam) GetContainerNetworkPolicyParam() *ContainerNetworkPolicyParam

GetContainerNetworkPolicyParam implements the ContainerNetworkPolicyParamClassification interface for type ContainerNetworkPolicyDisabledParam.

func (ContainerNetworkPolicyDisabledParam) MarshalJSON 

func (c ContainerNetworkPolicyDisabledParam) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerNetworkPolicyDisabledParam.

func (*ContainerNetworkPolicyDisabledParam) UnmarshalJSON 

func (c *ContainerNetworkPolicyDisabledParam) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerNetworkPolicyDisabledParam.

type ContainerNetworkPolicyDomainSecretParam 

type ContainerNetworkPolicyDomainSecretParam struct {
	// REQUIRED; The domain associated with the secret.
	Domain *string

	// REQUIRED; The name of the secret to inject for the domain.
	Name *string

	// REQUIRED; The secret value to inject for the domain.
	Value *string
}

func (ContainerNetworkPolicyDomainSecretParam) MarshalJSON 

func (c ContainerNetworkPolicyDomainSecretParam) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerNetworkPolicyDomainSecretParam.

func (*ContainerNetworkPolicyDomainSecretParam) UnmarshalJSON 

func (c *ContainerNetworkPolicyDomainSecretParam) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerNetworkPolicyDomainSecretParam.

type ContainerNetworkPolicyParam 

type ContainerNetworkPolicyParam struct {
	// REQUIRED
	Type *ContainerNetworkPolicyParamType
}

ContainerNetworkPolicyParam - Network access policy for the container.

func (*ContainerNetworkPolicyParam) GetContainerNetworkPolicyParam 

func (c *ContainerNetworkPolicyParam) GetContainerNetworkPolicyParam() *ContainerNetworkPolicyParam

GetContainerNetworkPolicyParam implements the ContainerNetworkPolicyParamClassification interface for type ContainerNetworkPolicyParam.

func (ContainerNetworkPolicyParam) MarshalJSON 

func (c ContainerNetworkPolicyParam) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerNetworkPolicyParam.

func (*ContainerNetworkPolicyParam) UnmarshalJSON 

func (c *ContainerNetworkPolicyParam) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerNetworkPolicyParam.

type ContainerNetworkPolicyParamClassification 

type ContainerNetworkPolicyParamClassification interface {
	// GetContainerNetworkPolicyParam returns the ContainerNetworkPolicyParam content of the underlying type.
	GetContainerNetworkPolicyParam() *ContainerNetworkPolicyParam
}

ContainerNetworkPolicyParamClassification provides polymorphic access to related types. Call the interface's GetContainerNetworkPolicyParam() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *ContainerNetworkPolicyAllowlistParam, *ContainerNetworkPolicyDisabledParam, *ContainerNetworkPolicyParam

type ContainerNetworkPolicyParamType 

type ContainerNetworkPolicyParamType string
const (
	ContainerNetworkPolicyParamTypeAllowlist ContainerNetworkPolicyParamType = "allowlist"
	ContainerNetworkPolicyParamTypeDisabled  ContainerNetworkPolicyParamType = "disabled"
)

func PossibleContainerNetworkPolicyParamTypeValues 

func PossibleContainerNetworkPolicyParamTypeValues() []ContainerNetworkPolicyParamType

PossibleContainerNetworkPolicyParamTypeValues returns the possible values for the ContainerNetworkPolicyParamType const type.

type ContainerSkill 

type ContainerSkill struct {
	// REQUIRED
	Type *ContainerSkillType
}

func (*ContainerSkill) GetContainerSkill 

func (c *ContainerSkill) GetContainerSkill() *ContainerSkill

GetContainerSkill implements the ContainerSkillClassification interface for type ContainerSkill.

func (ContainerSkill) MarshalJSON 

func (c ContainerSkill) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerSkill.

func (*ContainerSkill) UnmarshalJSON 

func (c *ContainerSkill) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerSkill.

type ContainerSkillClassification 

type ContainerSkillClassification interface {
	// GetContainerSkill returns the ContainerSkill content of the underlying type.
	GetContainerSkill() *ContainerSkill
}

ContainerSkillClassification provides polymorphic access to related types. Call the interface's GetContainerSkill() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *ContainerSkill, *InlineSkillParam, *SkillReferenceParam

type ContainerSkillType 

type ContainerSkillType string
const (
	ContainerSkillTypeInline         ContainerSkillType = "inline"
	ContainerSkillTypeSkillReference ContainerSkillType = "skill_reference"
)

func PossibleContainerSkillTypeValues 

func PossibleContainerSkillTypeValues() []ContainerSkillType

PossibleContainerSkillTypeValues returns the possible values for the ContainerSkillType const type.

type ContinuousEvaluationRuleAction 

type ContinuousEvaluationRuleAction struct {
	// REQUIRED; Eval Id to add continuous evaluation runs to.
	EvalID *string

	// CONSTANT; Field has constant value EvaluationRuleActionTypeContinuousEvaluation, any specified value is ignored.
	Type *EvaluationRuleActionType

	// Maximum number of evaluation runs allowed per hour.
	MaxHourlyRuns *int32

	// Percentage (0-100] chance that a matching event triggers an evaluation. When omitted, the service-default is to evaluate
	// every event, which is equivalent to setting a sampling rate of 100.
	SamplingRate *float64
}

ContinuousEvaluationRuleAction - Evaluation rule action for continuous evaluation.

func (*ContinuousEvaluationRuleAction) GetEvaluationRuleAction 

func (c *ContinuousEvaluationRuleAction) GetEvaluationRuleAction() *EvaluationRuleAction

GetEvaluationRuleAction implements the EvaluationRuleActionClassification interface for type ContinuousEvaluationRuleAction.

func (ContinuousEvaluationRuleAction) MarshalJSON 

func (c ContinuousEvaluationRuleAction) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContinuousEvaluationRuleAction.

func (*ContinuousEvaluationRuleAction) UnmarshalJSON 

func (c *ContinuousEvaluationRuleAction) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContinuousEvaluationRuleAction.

type CosmosDBIndex 

type CosmosDBIndex struct {
	// REQUIRED; Name of connection to CosmosDB
	ConnectionName *string

	// REQUIRED; Name of CosmosDB Container
	ContainerName *string

	// REQUIRED; Name of the CosmosDB Database
	DatabaseName *string

	// REQUIRED; Embedding model configuration
	EmbeddingConfiguration *EmbeddingConfiguration

	// REQUIRED; Field mapping configuration
	FieldMapping *FieldMapping

	// CONSTANT; Type of index
	// Field has constant value IndexTypeCosmosDB, any specified value is ignored.
	Type *IndexType

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The version of the resource
	Version *string

	// The asset description text.
	Description *string

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// READ-ONLY; Asset ID, a unique identifier for the asset
	ID *string
}

CosmosDBIndex - CosmosDB Vector Store Index Definition

func (*CosmosDBIndex) GetIndex 

func (c *CosmosDBIndex) GetIndex() *Index

GetIndex implements the IndexClassification interface for type CosmosDBIndex.

func (CosmosDBIndex) MarshalJSON 

func (c CosmosDBIndex) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CosmosDBIndex.

func (*CosmosDBIndex) UnmarshalJSON 

func (c *CosmosDBIndex) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CosmosDBIndex.

type CredentialType 

type CredentialType string

CredentialType - The credential type used by the connection 

const (
	// CredentialTypeAPIKey - API Key credential
	CredentialTypeAPIKey CredentialType = "ApiKey"
	// CredentialTypeAgenticIdentityPreview - Agentic identity credential
	CredentialTypeAgenticIdentityPreview CredentialType = "AgenticIdentityToken_Preview"
	// CredentialTypeCustom - Custom credential
	CredentialTypeCustom CredentialType = "CustomKeys"
	// CredentialTypeEntraID - Entra ID credential (formerly known as AAD)
	CredentialTypeEntraID CredentialType = "AAD"
	// CredentialTypeNone - No credential
	CredentialTypeNone CredentialType = "None"
	// CredentialTypeSAS - Shared Access Signature (SAS) credential
	CredentialTypeSAS CredentialType = "SAS"
)

func PossibleCredentialTypeValues 

func PossibleCredentialTypeValues() []CredentialType

PossibleCredentialTypeValues returns the possible values for the CredentialType const type.

type CronTrigger 

type CronTrigger struct {
	// REQUIRED; Cron expression that defines the schedule frequency.
	Expression *string

	// CONSTANT; Field has constant value TriggerTypeCron, any specified value is ignored.
	Type *TriggerType

	// End time for the cron schedule in ISO 8601 format.
	EndTime *time.Time

	// Start time for the cron schedule in ISO 8601 format.
	StartTime *time.Time

	// Time zone for the cron schedule. Defaults to `UTC`.
	TimeZone *string
}

CronTrigger - Cron based trigger.

func (*CronTrigger) GetTrigger 

func (c *CronTrigger) GetTrigger() *Trigger

GetTrigger implements the TriggerClassification interface for type CronTrigger.

func (CronTrigger) MarshalJSON 

func (c CronTrigger) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CronTrigger.

func (*CronTrigger) UnmarshalJSON 

func (c *CronTrigger) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CronTrigger.

type CustomCredential 

type CustomCredential struct {
	// READ-ONLY; The credential type
	Type                 *CredentialType
	AdditionalProperties map[string]*string
}

CustomCredential - Custom credential definition

func (*CustomCredential) GetBaseCredentials 

func (c *CustomCredential) GetBaseCredentials() *BaseCredentials

GetBaseCredentials implements the BaseCredentialsClassification interface for type CustomCredential.

func (CustomCredential) MarshalJSON 

func (c CustomCredential) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CustomCredential.

func (*CustomCredential) UnmarshalJSON 

func (c *CustomCredential) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CustomCredential.

type CustomGrammarFormatParam 

type CustomGrammarFormatParam struct {
	// REQUIRED; The grammar definition.
	Definition *string

	// REQUIRED; The syntax of the grammar definition. One of `lark` or `regex`.
	Syntax *GrammarSyntax1

	// CONSTANT; Grammar format. Always `grammar`.
	// Field has constant value CustomToolParamFormatTypeGrammar, any specified value is ignored.
	Type *CustomToolParamFormatType
}

CustomGrammarFormatParam - Grammar format

A grammar defined by the user.

func (*CustomGrammarFormatParam) GetCustomToolParamFormat 

func (c *CustomGrammarFormatParam) GetCustomToolParamFormat() *CustomToolParamFormat

GetCustomToolParamFormat implements the CustomToolParamFormatClassification interface for type CustomGrammarFormatParam.

func (CustomGrammarFormatParam) MarshalJSON 

func (c CustomGrammarFormatParam) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CustomGrammarFormatParam.

func (*CustomGrammarFormatParam) UnmarshalJSON 

func (c *CustomGrammarFormatParam) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CustomGrammarFormatParam.

type CustomTextFormatParam 

type CustomTextFormatParam struct {
	// CONSTANT; Unconstrained text format. Always `text`.
	// Field has constant value CustomToolParamFormatTypeText, any specified value is ignored.
	Type *CustomToolParamFormatType
}

CustomTextFormatParam - Text format

Unconstrained free-form text.

func (*CustomTextFormatParam) GetCustomToolParamFormat 

func (c *CustomTextFormatParam) GetCustomToolParamFormat() *CustomToolParamFormat

GetCustomToolParamFormat implements the CustomToolParamFormatClassification interface for type CustomTextFormatParam.

func (CustomTextFormatParam) MarshalJSON 

func (c CustomTextFormatParam) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CustomTextFormatParam.

func (*CustomTextFormatParam) UnmarshalJSON 

func (c *CustomTextFormatParam) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CustomTextFormatParam.

type CustomToolParam 

type CustomToolParam struct {
	// REQUIRED; The name of the custom tool, used to identify it in tool calls.
	Name *string

	// CONSTANT; The type of the custom tool. Always `custom`.
	// Field has constant value ToolTypeCustom, any specified value is ignored.
	Type *ToolType

	// Whether this tool should be deferred and discovered via tool search.
	DeferLoading *bool

	// Optional description of the custom tool, used to provide more context.
	Description *string

	// The input format for the custom tool. Default is unconstrained text.
	Format CustomToolParamFormatClassification
}

CustomToolParam - Custom tool

A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)

func (*CustomToolParam) GetTool 

func (c *CustomToolParam) GetTool() *Tool

GetTool implements the ToolClassification interface for type CustomToolParam.

func (CustomToolParam) MarshalJSON 

func (c CustomToolParam) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CustomToolParam.

func (*CustomToolParam) UnmarshalJSON 

func (c *CustomToolParam) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CustomToolParam.

type CustomToolParamFormat 

type CustomToolParamFormat struct {
	// REQUIRED
	Type *CustomToolParamFormatType
}

CustomToolParamFormat - The input format for the custom tool. Default is unconstrained text.

func (*CustomToolParamFormat) GetCustomToolParamFormat 

func (c *CustomToolParamFormat) GetCustomToolParamFormat() *CustomToolParamFormat

GetCustomToolParamFormat implements the CustomToolParamFormatClassification interface for type CustomToolParamFormat.

func (CustomToolParamFormat) MarshalJSON 

func (c CustomToolParamFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CustomToolParamFormat.

func (*CustomToolParamFormat) UnmarshalJSON 

func (c *CustomToolParamFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CustomToolParamFormat.

type CustomToolParamFormatClassification 

type CustomToolParamFormatClassification interface {
	// GetCustomToolParamFormat returns the CustomToolParamFormat content of the underlying type.
	GetCustomToolParamFormat() *CustomToolParamFormat
}

CustomToolParamFormatClassification provides polymorphic access to related types. Call the interface's GetCustomToolParamFormat() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *CustomGrammarFormatParam, *CustomTextFormatParam, *CustomToolParamFormat

type CustomToolParamFormatType 

type CustomToolParamFormatType string
const (
	CustomToolParamFormatTypeGrammar CustomToolParamFormatType = "grammar"
	CustomToolParamFormatTypeText    CustomToolParamFormatType = "text"
)

func PossibleCustomToolParamFormatTypeValues 

func PossibleCustomToolParamFormatTypeValues() []CustomToolParamFormatType

PossibleCustomToolParamFormatTypeValues returns the possible values for the CustomToolParamFormatType const type.

type DailyRecurrenceSchedule 

type DailyRecurrenceSchedule struct {
	// REQUIRED; Hours for the recurrence schedule.
	Hours []int32

	// CONSTANT; Daily recurrence type.
	// Field has constant value RecurrenceTypeDaily, any specified value is ignored.
	Type *RecurrenceType
}

DailyRecurrenceSchedule - Daily recurrence schedule.

func (*DailyRecurrenceSchedule) GetRecurrenceSchedule 

func (d *DailyRecurrenceSchedule) GetRecurrenceSchedule() *RecurrenceSchedule

GetRecurrenceSchedule implements the RecurrenceScheduleClassification interface for type DailyRecurrenceSchedule.

func (DailyRecurrenceSchedule) MarshalJSON 

func (d DailyRecurrenceSchedule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DailyRecurrenceSchedule.

func (*DailyRecurrenceSchedule) UnmarshalJSON 

func (d *DailyRecurrenceSchedule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DailyRecurrenceSchedule.

type DatasetCredential 

type DatasetCredential struct {
	// REQUIRED; Credential info to access the storage account.
	BlobReference *BlobReference
}

DatasetCredential - Represents a reference to a blob for consumption

func (DatasetCredential) MarshalJSON 

func (d DatasetCredential) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DatasetCredential.

func (*DatasetCredential) UnmarshalJSON 

func (d *DatasetCredential) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DatasetCredential.

type DatasetEvaluatorGenerationJobSource 

type DatasetEvaluatorGenerationJobSource struct {
	// REQUIRED; The name of the dataset.
	Name *string

	// CONSTANT; The source type for this source, which is Dataset.
	// Field has constant value EvaluatorGenerationJobSourceTypeDataset, any specified value is ignored.
	Type *EvaluatorGenerationJobSourceType

	// Optional description of what this source represents — helps the pipeline interpret its content (e.g., 'Company refund policy
	// document' or 'Describes the agent's core capabilities').
	Description *string

	// The version of the dataset. If not specified, the latest version is used.
	Version *string
}

DatasetEvaluatorGenerationJobSource - Dataset source for evaluator generation jobs — reference to a dataset.

func (*DatasetEvaluatorGenerationJobSource) GetEvaluatorGenerationJobSource 

func (d *DatasetEvaluatorGenerationJobSource) GetEvaluatorGenerationJobSource() *EvaluatorGenerationJobSource

GetEvaluatorGenerationJobSource implements the EvaluatorGenerationJobSourceClassification interface for type DatasetEvaluatorGenerationJobSource.

func (DatasetEvaluatorGenerationJobSource) MarshalJSON 

func (d DatasetEvaluatorGenerationJobSource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DatasetEvaluatorGenerationJobSource.

func (*DatasetEvaluatorGenerationJobSource) UnmarshalJSON 

func (d *DatasetEvaluatorGenerationJobSource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DatasetEvaluatorGenerationJobSource.

type DatasetReference 

type DatasetReference struct {
	// REQUIRED; Dataset name.
	Name *string

	// REQUIRED; Dataset version.
	Version *string
}

DatasetReference - Reference to a versioned Foundry Dataset.

func (DatasetReference) MarshalJSON 

func (d DatasetReference) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DatasetReference.

func (*DatasetReference) UnmarshalJSON 

func (d *DatasetReference) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DatasetReference.

type DatasetType 

type DatasetType string

DatasetType - Enum to determine the type of data. 

const (
	// DatasetTypeURIFile - URI file.
	DatasetTypeURIFile DatasetType = "uri_file"
	// DatasetTypeURIFolder - URI folder.
	DatasetTypeURIFolder DatasetType = "uri_folder"
)

func PossibleDatasetTypeValues 

func PossibleDatasetTypeValues() []DatasetType

PossibleDatasetTypeValues returns the possible values for the DatasetType const type.

type DatasetVersion 

type DatasetVersion struct {
	// REQUIRED; URI of the data ([example](https://go.microsoft.com/fwlink/?linkid=2202330))
	DataURI *string

	// REQUIRED; Dataset type
	Type *DatasetType

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The version of the resource
	Version *string

	// The Azure Storage Account connection name. Required if startPendingUploadVersion was not called before creating the Dataset
	ConnectionName *string

	// The asset description text.
	Description *string

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// READ-ONLY; Asset ID, a unique identifier for the asset
	ID *string

	// READ-ONLY; Indicates if the dataset holds a reference to the storage, or the dataset manages storage itself. If true, the
	// underlying data will not be deleted when the dataset version is deleted
	IsReference *bool
}

DatasetVersion Definition

func (*DatasetVersion) GetDatasetVersion 

func (d *DatasetVersion) GetDatasetVersion() *DatasetVersion

GetDatasetVersion implements the DatasetVersionClassification interface for type DatasetVersion.

func (DatasetVersion) MarshalJSON 

func (d DatasetVersion) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DatasetVersion.

func (*DatasetVersion) UnmarshalJSON 

func (d *DatasetVersion) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DatasetVersion.

type DatasetVersionClassification 

type DatasetVersionClassification interface {
	// GetDatasetVersion returns the DatasetVersion content of the underlying type.
	GetDatasetVersion() *DatasetVersion
}

DatasetVersionClassification provides polymorphic access to related types. Call the interface's GetDatasetVersion() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *DatasetVersion, *FileDatasetVersion, *FolderDatasetVersion

type DatasetsClient 

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

DatasetsClient contains the methods for the Datasets group. Don't use this type directly, use Client.NewDatasetsClient instead.

Generated from API version v1

func (*DatasetsClient) CreateOrUpdateVersion 

func (client *DatasetsClient) CreateOrUpdateVersion(ctx context.Context, name string, datasetVersion DatasetVersionClassification, version string, options *DatasetsClientCreateOrUpdateVersionOptions) (DatasetsClientCreateOrUpdateVersionResponse, error)

CreateOrUpdateVersion - Create or update a version

Create a new or update an existing DatasetVersion with the given version id If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the resource
  • datasetVersion - The DatasetVersion to create or update.
  • version - The specific version id of the DatasetVersion to create or update.
  • options - DatasetsClientCreateOrUpdateVersionOptions contains the optional parameters for the DatasetsClient.CreateOrUpdateVersion method.

func (*DatasetsClient) DeleteVersion 

func (client *DatasetsClient) DeleteVersion(ctx context.Context, name string, version string, options *DatasetsClientDeleteVersionOptions) (DatasetsClientDeleteVersionResponse, error)

DeleteVersion - Delete a version

Delete the specific version of the DatasetVersion. The service returns 204 No Content if the DatasetVersion was deleted successfully or if the DatasetVersion does not exist. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the resource
  • version - The version of the DatasetVersion to delete.
  • options - DatasetsClientDeleteVersionOptions contains the optional parameters for the DatasetsClient.DeleteVersion method.

func (*DatasetsClient) GetCredentials 

func (client *DatasetsClient) GetCredentials(ctx context.Context, name string, version string, options *DatasetsClientGetCredentialsOptions) (DatasetsClientGetCredentialsResponse, error)

GetCredentials - Get dataset credentials

Gets the SAS credential to access the storage account associated with a Dataset version. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the resource
  • version - The specific version id of the DatasetVersion to operate on.
  • options - DatasetsClientGetCredentialsOptions contains the optional parameters for the DatasetsClient.GetCredentials method.

func (*DatasetsClient) GetVersion 

func (client *DatasetsClient) GetVersion(ctx context.Context, name string, version string, options *DatasetsClientGetVersionOptions) (DatasetsClientGetVersionResponse, error)

GetVersion - Get a version

Get the specific version of the DatasetVersion. The service returns 404 Not Found error if the DatasetVersion does not exist. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the resource
  • version - The specific version id of the DatasetVersion to retrieve.
  • options - DatasetsClientGetVersionOptions contains the optional parameters for the DatasetsClient.GetVersion method.

func (*DatasetsClient) NewListLatestPager 

func (client *DatasetsClient) NewListLatestPager(options *DatasetsClientListLatestOptions) *runtime.Pager[DatasetsClientListLatestResponse]

NewListLatestPager - List latest versions

List the latest version of each DatasetVersion

  • options - DatasetsClientListLatestOptions contains the optional parameters for the DatasetsClient.NewListLatestPager method.

func (*DatasetsClient) NewListVersionsPager 

func (client *DatasetsClient) NewListVersionsPager(name string, options *DatasetsClientListVersionsOptions) *runtime.Pager[DatasetsClientListVersionsResponse]

NewListVersionsPager - List versions

List all versions of the given DatasetVersion

  • name - The name of the resource
  • options - DatasetsClientListVersionsOptions contains the optional parameters for the DatasetsClient.NewListVersionsPager method.

func (*DatasetsClient) StartPendingUploadVersion 

func (client *DatasetsClient) StartPendingUploadVersion(ctx context.Context, name string, pendingUploadRequest PendingUploadRequest, version string, options *DatasetsClientStartPendingUploadVersionOptions) (DatasetsClientStartPendingUploadVersionResponse, error)

StartPendingUploadVersion - Start a pending upload

Initiates a new pending upload or retrieves an existing one for the specified dataset version. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the resource
  • pendingUploadRequest - The pending upload request parameters
  • version - The specific version id of the DatasetVersion to operate on.
  • options - DatasetsClientStartPendingUploadVersionOptions contains the optional parameters for the DatasetsClient.StartPendingUploadVersion method.

type DatasetsClientCreateOrUpdateVersionOptions 

type DatasetsClientCreateOrUpdateVersionOptions struct {
}

DatasetsClientCreateOrUpdateVersionOptions contains the optional parameters for the DatasetsClient.CreateOrUpdateVersion method.

type DatasetsClientCreateOrUpdateVersionResponse 

type DatasetsClientCreateOrUpdateVersionResponse struct {
	// DatasetVersion Definition
	DatasetVersionClassification
}

DatasetsClientCreateOrUpdateVersionResponse contains the response from method DatasetsClient.CreateOrUpdateVersion.

func (*DatasetsClientCreateOrUpdateVersionResponse) UnmarshalJSON 

func (d *DatasetsClientCreateOrUpdateVersionResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DatasetsClientCreateOrUpdateVersionResponse.

type DatasetsClientDeleteVersionOptions 

type DatasetsClientDeleteVersionOptions struct {
}

DatasetsClientDeleteVersionOptions contains the optional parameters for the DatasetsClient.DeleteVersion method.

type DatasetsClientDeleteVersionResponse 

type DatasetsClientDeleteVersionResponse struct {
}

DatasetsClientDeleteVersionResponse contains the response from method DatasetsClient.DeleteVersion.

type DatasetsClientGetCredentialsOptions 

type DatasetsClientGetCredentialsOptions struct {
}

DatasetsClientGetCredentialsOptions contains the optional parameters for the DatasetsClient.GetCredentials method.

type DatasetsClientGetCredentialsResponse 

type DatasetsClientGetCredentialsResponse struct {
	// Represents a reference to a blob for consumption
	DatasetCredential
}

DatasetsClientGetCredentialsResponse contains the response from method DatasetsClient.GetCredentials.

type DatasetsClientGetVersionOptions 

type DatasetsClientGetVersionOptions struct {
}

DatasetsClientGetVersionOptions contains the optional parameters for the DatasetsClient.GetVersion method.

type DatasetsClientGetVersionResponse 

type DatasetsClientGetVersionResponse struct {
	// DatasetVersion Definition
	DatasetVersionClassification
}

DatasetsClientGetVersionResponse contains the response from method DatasetsClient.GetVersion.

func (*DatasetsClientGetVersionResponse) UnmarshalJSON 

func (d *DatasetsClientGetVersionResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DatasetsClientGetVersionResponse.

type DatasetsClientListLatestOptions 

type DatasetsClientListLatestOptions struct {
}

DatasetsClientListLatestOptions contains the optional parameters for the DatasetsClient.NewListLatestPager method.

type DatasetsClientListLatestResponse 

type DatasetsClientListLatestResponse struct {
	// Paged collection of DatasetVersion items
	PagedDatasetVersion
}

DatasetsClientListLatestResponse contains the response from method DatasetsClient.NewListLatestPager.

type DatasetsClientListVersionsOptions 

type DatasetsClientListVersionsOptions struct {
}

DatasetsClientListVersionsOptions contains the optional parameters for the DatasetsClient.NewListVersionsPager method.

type DatasetsClientListVersionsResponse 

type DatasetsClientListVersionsResponse struct {
	// Paged collection of DatasetVersion items
	PagedDatasetVersion
}

DatasetsClientListVersionsResponse contains the response from method DatasetsClient.NewListVersionsPager.

type DatasetsClientStartPendingUploadVersionOptions 

type DatasetsClientStartPendingUploadVersionOptions struct {
}

DatasetsClientStartPendingUploadVersionOptions contains the optional parameters for the DatasetsClient.StartPendingUploadVersion method.

type DatasetsClientStartPendingUploadVersionResponse 

type DatasetsClientStartPendingUploadVersionResponse struct {
	// Represents the response for a pending upload request
	PendingUploadResponse
}

DatasetsClientStartPendingUploadVersionResponse contains the response from method DatasetsClient.StartPendingUploadVersion.

type DayOfWeek 

type DayOfWeek string

DayOfWeek - Days of the week for recurrence schedule. 

const (
	// DayOfWeekFriday - Friday.
	DayOfWeekFriday DayOfWeek = "Friday"
	// DayOfWeekMonday - Monday.
	DayOfWeekMonday DayOfWeek = "Monday"
	// DayOfWeekSaturday - Saturday.
	DayOfWeekSaturday DayOfWeek = "Saturday"
	// DayOfWeekSunday - Sunday.
	DayOfWeekSunday DayOfWeek = "Sunday"
	// DayOfWeekThursday - Thursday.
	DayOfWeekThursday DayOfWeek = "Thursday"
	// DayOfWeekTuesday - Tuesday.
	DayOfWeekTuesday DayOfWeek = "Tuesday"
	// DayOfWeekWednesday - Wednesday.
	DayOfWeekWednesday DayOfWeek = "Wednesday"
)

func PossibleDayOfWeekValues 

func PossibleDayOfWeekValues() []DayOfWeek

PossibleDayOfWeekValues returns the possible values for the DayOfWeek const type.

type DeleteMemoryResponse 

type DeleteMemoryResponse struct {
	// REQUIRED; Whether the memory item was successfully deleted.
	Deleted *bool

	// REQUIRED; The unique ID of the deleted memory item.
	MemoryID *string

	// REQUIRED; The object type. Always 'memory_store.item.deleted'.
	Object *MemoryStoreObjectType
}

DeleteMemoryResponse - Response for deleting a memory item from a memory store.

func (DeleteMemoryResponse) MarshalJSON 

func (d DeleteMemoryResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeleteMemoryResponse.

func (*DeleteMemoryResponse) UnmarshalJSON 

func (d *DeleteMemoryResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeleteMemoryResponse.

type DeleteMemoryStoreResult 

type DeleteMemoryStoreResult struct {
	// REQUIRED; Whether the memory store was successfully deleted.
	Deleted *bool

	// REQUIRED; The name of the memory store.
	Name *string

	// REQUIRED; The object type. Always 'memory_store.deleted'.
	Object *MemoryStoreObjectType
}

func (DeleteMemoryStoreResult) MarshalJSON 

func (d DeleteMemoryStoreResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeleteMemoryStoreResult.

func (*DeleteMemoryStoreResult) UnmarshalJSON 

func (d *DeleteMemoryStoreResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeleteMemoryStoreResult.

type Deployment 

type Deployment struct {
	// REQUIRED; The type of the deployment
	Type *DeploymentType

	// READ-ONLY; Name of the deployment
	Name *string
}

Deployment - Model Deployment Definition

func (*Deployment) GetDeployment 

func (d *Deployment) GetDeployment() *Deployment

GetDeployment implements the DeploymentClassification interface for type Deployment.

func (Deployment) MarshalJSON 

func (d Deployment) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Deployment.

func (*Deployment) UnmarshalJSON 

func (d *Deployment) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Deployment.

type DeploymentClassification 

type DeploymentClassification interface {
	// GetDeployment returns the Deployment content of the underlying type.
	GetDeployment() *Deployment
}

DeploymentClassification provides polymorphic access to related types. Call the interface's GetDeployment() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *Deployment, *ModelDeployment

type DeploymentType 

type DeploymentType string
const (
	// DeploymentTypeModelDeployment - Model deployment
	DeploymentTypeModelDeployment DeploymentType = "ModelDeployment"
)

func PossibleDeploymentTypeValues 

func PossibleDeploymentTypeValues() []DeploymentType

PossibleDeploymentTypeValues returns the possible values for the DeploymentType const type.

type DeploymentsClient 

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

DeploymentsClient contains the methods for the Deployments group. Don't use this type directly, use Client.NewDeploymentsClient instead.

Generated from API version v1

func (*DeploymentsClient) Get 

func (client *DeploymentsClient) Get(ctx context.Context, name string, options *DeploymentsClientGetOptions) (DeploymentsClientGetResponse, error)

Get - Get a deployment

Gets a deployed model. If the operation fails it returns an *azcore.ResponseError type.

  • name - Name of the deployment
  • options - DeploymentsClientGetOptions contains the optional parameters for the DeploymentsClient.Get method.

func (*DeploymentsClient) NewListPager 

func (client *DeploymentsClient) NewListPager(options *DeploymentsClientListOptions) *runtime.Pager[DeploymentsClientListResponse]

NewListPager - List deployments

Returns the deployed models available in the current project, optionally filtered by publisher, model name, or deployment type.

  • options - DeploymentsClientListOptions contains the optional parameters for the DeploymentsClient.NewListPager method.

type DeploymentsClientGetOptions 

type DeploymentsClientGetOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string
}

DeploymentsClientGetOptions contains the optional parameters for the DeploymentsClient.Get method.

type DeploymentsClientGetResponse 

type DeploymentsClientGetResponse struct {
	// Model Deployment Definition
	DeploymentClassification

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string
}

DeploymentsClientGetResponse contains the response from method DeploymentsClient.Get.

func (*DeploymentsClientGetResponse) UnmarshalJSON 

func (d *DeploymentsClientGetResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentsClientGetResponse.

type DeploymentsClientListOptions 

type DeploymentsClientListOptions struct {
	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string

	// Type of deployment to filter list by
	DeploymentType *DeploymentType

	// Model name (the publisher specific name) to filter models by
	ModelName *string

	// Model publisher to filter models by
	ModelPublisher *string
}

DeploymentsClientListOptions contains the optional parameters for the DeploymentsClient.NewListPager method.

type DeploymentsClientListResponse 

type DeploymentsClientListResponse struct {
	// Paged collection of Deployment items
	PagedDeployment

	// An opaque, globally-unique, client-generated string identifier for the request.
	ClientRequestID *string
}

DeploymentsClientListResponse contains the response from method DeploymentsClient.NewListPager.

type Dimension 

type Dimension struct {
	// REQUIRED; What this dimension measures (e.g., 'Correctly identifies the user's reservation intent and pursues the appropriate
	// workflow').
	Description *string

	// REQUIRED; Stable identifier for this dimension (snake_case, e.g., `correct_resolution`). Required. Provided by the user
	// when manually creating a rubric evaluator or during human-in-the-loop review of a generated set; the generation pipeline
	// produces an initial value the user can edit. Editable when saving new versions.
	ID *string

	// REQUIRED; Relative weight of this dimension (1-10). The generation pipeline assigns exactly one dimension weight 8-10;
	// all others use 1-6. User edits are not constrained by this heuristic.
	Weight *int32

	// When true, the LLM judge always scores this dimension regardless of relevance (skips applicability assessment). The service-generated
	// general quality/policy dimension has this set to true and is non-editable. Users may set this on their own custom dimensions.
	// The service defaults to `false` if a value is not specified by the caller.
	AlwaysApplicable *bool
}

Dimension - A single dimension — one independent, measurable quality dimension within a rubric evaluator's scoring blueprint.

func (Dimension) MarshalJSON 

func (d Dimension) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Dimension.

func (*Dimension) UnmarshalJSON 

func (d *Dimension) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Dimension.

type EmbeddingConfiguration 

type EmbeddingConfiguration struct {
	// REQUIRED; Embedding field
	EmbeddingField *string

	// REQUIRED; Deployment name of embedding model. It can point to a model deployment either in the parent AIServices or a connection.
	ModelDeploymentName *string
}

EmbeddingConfiguration - Embedding configuration class

func (EmbeddingConfiguration) MarshalJSON 

func (e EmbeddingConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EmbeddingConfiguration.

func (*EmbeddingConfiguration) UnmarshalJSON 

func (e *EmbeddingConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EmbeddingConfiguration.

type EmptyModelParam 

type EmptyModelParam struct {
}

type EntraIDCredentials 

type EntraIDCredentials struct {
	// READ-ONLY; The credential type
	Type *CredentialType
}

EntraIDCredentials - Entra ID credential definition

func (*EntraIDCredentials) GetBaseCredentials 

func (e *EntraIDCredentials) GetBaseCredentials() *BaseCredentials

GetBaseCredentials implements the BaseCredentialsClassification interface for type EntraIDCredentials.

func (EntraIDCredentials) MarshalJSON 

func (e EntraIDCredentials) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EntraIDCredentials.

func (*EntraIDCredentials) UnmarshalJSON 

func (e *EntraIDCredentials) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EntraIDCredentials.

type Error 

type Error struct {
	// REQUIRED
	Code *string

	// REQUIRED
	Message        *string
	AdditionalInfo map[string]any
	DebugInfo      map[string]any
	Details        []Error
	Param          *string
	Type           *string
}

func (Error) MarshalJSON 

func (e Error) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Error.

func (*Error) UnmarshalJSON 

func (e *Error) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Error.

type EvalResult 

type EvalResult struct {
	// REQUIRED; name of the check
	Name *string

	// REQUIRED; indicates if the check passed or failed
	Passed *bool

	// REQUIRED; score
	Score *float32

	// REQUIRED; type of the check
	Type *string
}

EvalResult - Result of the evaluation.

func (EvalResult) MarshalJSON 

func (e EvalResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EvalResult.

func (*EvalResult) UnmarshalJSON 

func (e *EvalResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EvalResult.

type EvalRunResultCompareItem 

type EvalRunResultCompareItem struct {
	// REQUIRED; Estimated difference between treatment and baseline.
	DeltaEstimate *float32

	// REQUIRED; P-value for the treatment effect.
	PValue *float32

	// REQUIRED; Type of treatment effect.
	TreatmentEffect *TreatmentEffectType

	// REQUIRED; The treatment run ID.
	TreatmentRunID *string

	// REQUIRED; Summary statistics of the treatment run.
	TreatmentRunSummary *EvalRunResultSummary
}

EvalRunResultCompareItem - Metric comparison for a treatment against the baseline.

func (EvalRunResultCompareItem) MarshalJSON 

func (e EvalRunResultCompareItem) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EvalRunResultCompareItem.

func (*EvalRunResultCompareItem) UnmarshalJSON 

func (e *EvalRunResultCompareItem) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EvalRunResultCompareItem.

type EvalRunResultComparison 

type EvalRunResultComparison struct {
	// REQUIRED; Summary statistics of the baseline run.
	BaselineRunSummary *EvalRunResultSummary

	// REQUIRED; List of comparison results for each treatment run.
	CompareItems []EvalRunResultCompareItem

	// REQUIRED; Name of the evaluator for this testing criteria.
	Evaluator *string

	// REQUIRED; Metric being evaluated.
	Metric *string

	// REQUIRED; Name of the testing criteria.
	TestingCriteria *string
}

EvalRunResultComparison - Comparison results for treatment runs against the baseline.

func (EvalRunResultComparison) MarshalJSON 

func (e EvalRunResultComparison) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EvalRunResultComparison.

func (*EvalRunResultComparison) UnmarshalJSON 

func (e *EvalRunResultComparison) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EvalRunResultComparison.

type EvalRunResultSummary 

type EvalRunResultSummary struct {
	// REQUIRED; Average value of the metric in the evaluation run.
	Average *float32

	// REQUIRED; The evaluation run ID.
	RunID *string

	// REQUIRED; Number of samples in the evaluation run.
	SampleCount *int32

	// REQUIRED; Standard deviation of the metric in the evaluation run.
	StandardDeviation *float32
}

EvalRunResultSummary - Summary statistics of a metric in an evaluation run.

func (EvalRunResultSummary) MarshalJSON 

func (e EvalRunResultSummary) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EvalRunResultSummary.

func (*EvalRunResultSummary) UnmarshalJSON 

func (e *EvalRunResultSummary) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EvalRunResultSummary.

type EvaluationComparisonInsightRequest 

type EvaluationComparisonInsightRequest struct {
	// REQUIRED; The baseline run ID for comparison.
	BaselineRunID *string

	// REQUIRED; Identifier for the evaluation.
	EvalID *string

	// REQUIRED; List of treatment run IDs for comparison.
	TreatmentRunIDs []string

	// CONSTANT; The type of request.
	// Field has constant value InsightTypeEvaluationComparison, any specified value is ignored.
	Type *InsightType
}

EvaluationComparisonInsightRequest - Evaluation Comparison Request

func (*EvaluationComparisonInsightRequest) GetInsightRequest 

func (e *EvaluationComparisonInsightRequest) GetInsightRequest() *InsightRequest

GetInsightRequest implements the InsightRequestClassification interface for type EvaluationComparisonInsightRequest.

func (EvaluationComparisonInsightRequest) MarshalJSON 

func (e EvaluationComparisonInsightRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EvaluationComparisonInsightRequest.

func (*EvaluationComparisonInsightRequest) UnmarshalJSON 

func (e *EvaluationComparisonInsightRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EvaluationComparisonInsightRequest.

type EvaluationComparisonInsightResult 

type EvaluationComparisonInsightResult struct {
	// REQUIRED; Comparison results for each treatment run against the baseline.
	Comparisons []EvalRunResultComparison

	// REQUIRED; The statistical method used for comparison.
	Method *string

	// REQUIRED; The type of insights result.
	Type *InsightType
}

EvaluationComparisonInsightResult - Insights from the evaluation comparison.

func (*EvaluationComparisonInsightResult) GetInsightResult 

func (e *EvaluationComparisonInsightResult) GetInsightResult() *InsightResult

GetInsightResult implements the InsightResultClassification interface for type EvaluationComparisonInsightResult.

func (EvaluationComparisonInsightResult) MarshalJSON 

func (e EvaluationComparisonInsightResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EvaluationComparisonInsightResult.

func (*EvaluationComparisonInsightResult) UnmarshalJSON 

func (e *EvaluationComparisonInsightResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EvaluationComparisonInsightResult.

type EvaluationLevel 

type EvaluationLevel string

EvaluationLevel - The level at which evaluation is performed. 

const (
	// EvaluationLevelConversation - Evaluation is performed at the conversation level.
	EvaluationLevelConversation EvaluationLevel = "conversation"
	// EvaluationLevelTurn - Evaluation is performed at the turn level.
	EvaluationLevelTurn EvaluationLevel = "turn"
)

func PossibleEvaluationLevelValues 

func PossibleEvaluationLevelValues() []EvaluationLevel

PossibleEvaluationLevelValues returns the possible values for the EvaluationLevel const type.

type EvaluationResultSample 

type EvaluationResultSample struct {
	// REQUIRED; Info about the correlation for the analysis sample.
	CorrelationInfo map[string]any

	// REQUIRED; Evaluation result for the analysis sample.
	EvaluationResult *EvalResult

	// REQUIRED; Features to help with additional filtering of data in UX.
	Features map[string]any

	// REQUIRED; The unique identifier for the analysis sample.
	ID *string

	// REQUIRED; Evaluation Result Sample Type
	Type *SampleType
}

EvaluationResultSample - A sample from the evaluation result.

func (*EvaluationResultSample) GetInsightSample 

func (e *EvaluationResultSample) GetInsightSample() *InsightSample

GetInsightSample implements the InsightSampleClassification interface for type EvaluationResultSample.

func (EvaluationResultSample) MarshalJSON 

func (e EvaluationResultSample) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EvaluationResultSample.

func (*EvaluationResultSample) UnmarshalJSON 

func (e *EvaluationResultSample) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EvaluationResultSample.

type EvaluationRule 

type EvaluationRule struct {
	// REQUIRED; Definition of the evaluation rule action.
	Action EvaluationRuleActionClassification

	// REQUIRED; Indicates whether the evaluation rule is enabled. Default is true.
	Enabled *bool

	// REQUIRED; Event type that the evaluation rule applies to.
	EventType *EvaluationRuleEventType

	// READ-ONLY; Unique identifier for the evaluation rule.
	ID *string

	// READ-ONLY; System metadata for the evaluation rule.
	SystemData map[string]*string

	// Description for the evaluation rule.
	Description *string

	// Display Name for the evaluation rule.
	DisplayName *string

	// Filter condition of the evaluation rule.
	Filter *EvaluationRuleFilter
}

EvaluationRule - Evaluation rule model.

func (EvaluationRule) MarshalJSON 

func (e EvaluationRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EvaluationRule.

func (*EvaluationRule) UnmarshalJSON 

func (e *EvaluationRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EvaluationRule.

type EvaluationRuleAction 

type EvaluationRuleAction struct {
	// REQUIRED; Type of the evaluation action.
	Type *EvaluationRuleActionType
}

EvaluationRuleAction - Evaluation action model.

func (*EvaluationRuleAction) GetEvaluationRuleAction 

func (e *EvaluationRuleAction) GetEvaluationRuleAction() *EvaluationRuleAction

GetEvaluationRuleAction implements the EvaluationRuleActionClassification interface for type EvaluationRuleAction.

func (EvaluationRuleAction) MarshalJSON 

func (e EvaluationRuleAction) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EvaluationRuleAction.

func (*EvaluationRuleAction) UnmarshalJSON 

func (e *EvaluationRuleAction) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EvaluationRuleAction.

type EvaluationRuleActionClassification 

type EvaluationRuleActionClassification interface {
	// GetEvaluationRuleAction returns the EvaluationRuleAction content of the underlying type.
	GetEvaluationRuleAction() *EvaluationRuleAction
}

EvaluationRuleActionClassification provides polymorphic access to related types. Call the interface's GetEvaluationRuleAction() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *ContinuousEvaluationRuleAction, *EvaluationRuleAction, *HumanEvaluationPreviewRuleAction

type EvaluationRuleActionType 

type EvaluationRuleActionType string

EvaluationRuleActionType - Type of the evaluation action. 

const (
	// EvaluationRuleActionTypeContinuousEvaluation - Continuous evaluation.
	EvaluationRuleActionTypeContinuousEvaluation EvaluationRuleActionType = "continuousEvaluation"
	// EvaluationRuleActionTypeHumanEvaluationPreview - Human evaluation preview.
	EvaluationRuleActionTypeHumanEvaluationPreview EvaluationRuleActionType = "humanEvaluationPreview"
)

func PossibleEvaluationRuleActionTypeValues 

func PossibleEvaluationRuleActionTypeValues() []EvaluationRuleActionType

PossibleEvaluationRuleActionTypeValues returns the possible values for the EvaluationRuleActionType const type.

type EvaluationRuleEventType 

type EvaluationRuleEventType string

EvaluationRuleEventType - Type of the evaluation rule event. 

const (
	// EvaluationRuleEventTypeManual - Manual trigger.
	EvaluationRuleEventTypeManual EvaluationRuleEventType = "manual"
	// EvaluationRuleEventTypeResponseCompleted - Response completed.
	EvaluationRuleEventTypeResponseCompleted EvaluationRuleEventType = "responseCompleted"
)

func PossibleEvaluationRuleEventTypeValues 

func PossibleEvaluationRuleEventTypeValues() []EvaluationRuleEventType

PossibleEvaluationRuleEventTypeValues returns the possible values for the EvaluationRuleEventType const type.

type EvaluationRuleFilter 

type EvaluationRuleFilter struct {
	// REQUIRED; Filter by agent name.
	AgentName *string
}

EvaluationRuleFilter - Evaluation filter model.

func (EvaluationRuleFilter) MarshalJSON 

func (e EvaluationRuleFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EvaluationRuleFilter.

func (*EvaluationRuleFilter) UnmarshalJSON 

func (e *EvaluationRuleFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EvaluationRuleFilter.

type EvaluationRulesClient 

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

EvaluationRulesClient contains the methods for the EvaluationRules group. Don't use this type directly, use Client.NewEvaluationRulesClient instead.

Generated from API version v1

func (*EvaluationRulesClient) CreateOrUpdate 

func (client *EvaluationRulesClient) CreateOrUpdate(ctx context.Context, id string, evaluationRule EvaluationRule, options *EvaluationRulesClientCreateOrUpdateOptions) (EvaluationRulesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update an evaluation rule

Creates a new evaluation rule, or replaces the existing rule when the identifier matches. If the operation fails it returns an *azcore.ResponseError type.

  • id - Unique identifier for the evaluation rule.
  • evaluationRule - Evaluation rule resource
  • options - EvaluationRulesClientCreateOrUpdateOptions contains the optional parameters for the EvaluationRulesClient.CreateOrUpdate method.

func (*EvaluationRulesClient) Delete 

func (client *EvaluationRulesClient) Delete(ctx context.Context, id string, options *EvaluationRulesClientDeleteOptions) (EvaluationRulesClientDeleteResponse, error)

Delete - Delete an evaluation rule

Removes the specified evaluation rule from the project. If the operation fails it returns an *azcore.ResponseError type.

  • id - Unique identifier for the evaluation rule.
  • options - EvaluationRulesClientDeleteOptions contains the optional parameters for the EvaluationRulesClient.Delete method.

func (*EvaluationRulesClient) Get 

func (client *EvaluationRulesClient) Get(ctx context.Context, id string, options *EvaluationRulesClientGetOptions) (EvaluationRulesClientGetResponse, error)

Get - Get an evaluation rule

Retrieves the specified evaluation rule and its configuration. If the operation fails it returns an *azcore.ResponseError type.

  • id - Unique identifier for the evaluation rule.
  • options - EvaluationRulesClientGetOptions contains the optional parameters for the EvaluationRulesClient.Get method.

func (*EvaluationRulesClient) NewListPager 

func (client *EvaluationRulesClient) NewListPager(options *EvaluationRulesClientListOptions) *runtime.Pager[EvaluationRulesClientListResponse]

NewListPager - List evaluation rules

Returns the evaluation rules configured for the project, optionally filtered by action type, agent name, or enabled state.

  • options - EvaluationRulesClientListOptions contains the optional parameters for the EvaluationRulesClient.NewListPager method.

type EvaluationRulesClientCreateOrUpdateOptions 

type EvaluationRulesClientCreateOrUpdateOptions struct {
	// A feature flag opt-in required when using preview operations or modifying persisted preview resources.
	FoundryFeatures *string
}

EvaluationRulesClientCreateOrUpdateOptions contains the optional parameters for the EvaluationRulesClient.CreateOrUpdate method.

type EvaluationRulesClientCreateOrUpdateResponse 

type EvaluationRulesClientCreateOrUpdateResponse struct {
	// Evaluation rule model.
	EvaluationRule
}

EvaluationRulesClientCreateOrUpdateResponse contains the response from method EvaluationRulesClient.CreateOrUpdate.

type EvaluationRulesClientDeleteOptions 

type EvaluationRulesClientDeleteOptions struct {
}

EvaluationRulesClientDeleteOptions contains the optional parameters for the EvaluationRulesClient.Delete method.

type EvaluationRulesClientDeleteResponse 

type EvaluationRulesClientDeleteResponse struct {
}

EvaluationRulesClientDeleteResponse contains the response from method EvaluationRulesClient.Delete.

type EvaluationRulesClientGetOptions 

type EvaluationRulesClientGetOptions struct {
}

EvaluationRulesClientGetOptions contains the optional parameters for the EvaluationRulesClient.Get method.

type EvaluationRulesClientGetResponse 

type EvaluationRulesClientGetResponse struct {
	// Evaluation rule model.
	EvaluationRule
}

EvaluationRulesClientGetResponse contains the response from method EvaluationRulesClient.Get.

type EvaluationRulesClientListOptions 

type EvaluationRulesClientListOptions struct {
	// Filter by the type of evaluation rule.
	ActionType *EvaluationRuleActionType

	// Filter by the agent name.
	AgentName *string

	// Filter by the enabled status.
	Enabled *bool
}

EvaluationRulesClientListOptions contains the optional parameters for the EvaluationRulesClient.NewListPager method.

type EvaluationRulesClientListResponse 

type EvaluationRulesClientListResponse struct {
	// Paged collection of EvaluationRule items
	PagedEvaluationRule
}

EvaluationRulesClientListResponse contains the response from method EvaluationRulesClient.NewListPager.

type EvaluationRunClusterInsightRequest 

type EvaluationRunClusterInsightRequest struct {
	// REQUIRED; Evaluation Id for the insights.
	EvalID *string

	// REQUIRED; List of evaluation run IDs for the insights.
	RunIDs []string

	// CONSTANT; The type of insights request.
	// Field has constant value InsightTypeEvaluationRunClusterInsight, any specified value is ignored.
	Type *InsightType

	// Configuration of the model used in the insight generation.
	ModelConfiguration *InsightModelConfiguration
}

EvaluationRunClusterInsightRequest - Insights on set of Evaluation Results

func (*EvaluationRunClusterInsightRequest) GetInsightRequest 

func (e *EvaluationRunClusterInsightRequest) GetInsightRequest() *InsightRequest

GetInsightRequest implements the InsightRequestClassification interface for type EvaluationRunClusterInsightRequest.

func (EvaluationRunClusterInsightRequest) MarshalJSON 

func (e EvaluationRunClusterInsightRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EvaluationRunClusterInsightRequest.

func (*EvaluationRunClusterInsightRequest) UnmarshalJSON 

func (e *EvaluationRunClusterInsightRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EvaluationRunClusterInsightRequest.

type EvaluationRunClusterInsightResult 

type EvaluationRunClusterInsightResult struct {
	// REQUIRED
	ClusterInsight *ClusterInsightResult

	// REQUIRED; The type of insights result.
	Type *InsightType
}

EvaluationRunClusterInsightResult - Insights from the evaluation run cluster analysis.

func (*EvaluationRunClusterInsightResult) GetInsightResult 

func (e *EvaluationRunClusterInsightResult) GetInsightResult() *InsightResult

GetInsightResult implements the InsightResultClassification interface for type EvaluationRunClusterInsightResult.

func (EvaluationRunClusterInsightResult) MarshalJSON 

func (e EvaluationRunClusterInsightResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EvaluationRunClusterInsightResult.

func (*EvaluationRunClusterInsightResult) UnmarshalJSON 

func (e *EvaluationRunClusterInsightResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EvaluationRunClusterInsightResult.

type EvaluationScheduleTask 

type EvaluationScheduleTask struct {
	// REQUIRED; Identifier of the evaluation group.
	EvalID *string

	// REQUIRED; The evaluation run payload.
	EvalRun map[string]any

	// CONSTANT; Field has constant value ScheduleTaskTypeEvaluation, any specified value is ignored.
	Type *ScheduleTaskType

	// Configuration for the task.
	Configuration map[string]*string
}

EvaluationScheduleTask - Evaluation task for the schedule.

func (*EvaluationScheduleTask) GetScheduleTask 

func (e *EvaluationScheduleTask) GetScheduleTask() *ScheduleTask

GetScheduleTask implements the ScheduleTaskClassification interface for type EvaluationScheduleTask.

func (EvaluationScheduleTask) MarshalJSON 

func (e EvaluationScheduleTask) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EvaluationScheduleTask.

func (*EvaluationScheduleTask) UnmarshalJSON 

func (e *EvaluationScheduleTask) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EvaluationScheduleTask.

type EvaluationTaxonomiesClient 

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

EvaluationTaxonomiesClient contains the methods for the EvaluationTaxonomies group. Don't use this type directly, use Client.NewEvaluationTaxonomiesClient instead.

Generated from API version v1

func (*EvaluationTaxonomiesClient) Create 

func (client *EvaluationTaxonomiesClient) Create(ctx context.Context, name string, taxonomy EvaluationTaxonomy, options *EvaluationTaxonomiesClientCreateOptions) (EvaluationTaxonomiesClientCreateResponse, error)

Create - Create an evaluation taxonomy

Creates or replaces the specified evaluation taxonomy with the provided definition. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the evaluation taxonomy.
  • taxonomy - The evaluation taxonomy.
  • options - EvaluationTaxonomiesClientCreateOptions contains the optional parameters for the EvaluationTaxonomiesClient.Create method.

func (*EvaluationTaxonomiesClient) Delete 

func (client *EvaluationTaxonomiesClient) Delete(ctx context.Context, name string, options *EvaluationTaxonomiesClientDeleteOptions) (EvaluationTaxonomiesClientDeleteResponse, error)

Delete - Delete an evaluation taxonomy

Removes the specified evaluation taxonomy from the project. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the resource
  • options - EvaluationTaxonomiesClientDeleteOptions contains the optional parameters for the EvaluationTaxonomiesClient.Delete method.

func (*EvaluationTaxonomiesClient) Get 

func (client *EvaluationTaxonomiesClient) Get(ctx context.Context, name string, options *EvaluationTaxonomiesClientGetOptions) (EvaluationTaxonomiesClientGetResponse, error)

Get - Get an evaluation taxonomy

Retrieves the specified evaluation taxonomy. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the resource
  • options - EvaluationTaxonomiesClientGetOptions contains the optional parameters for the EvaluationTaxonomiesClient.Get method.

func (*EvaluationTaxonomiesClient) NewListPager 

func (client *EvaluationTaxonomiesClient) NewListPager(options *EvaluationTaxonomiesClientListOptions) *runtime.Pager[EvaluationTaxonomiesClientListResponse]

NewListPager - List evaluation taxonomies

Returns the evaluation taxonomies available in the project, optionally filtered by input name or input type.

  • options - EvaluationTaxonomiesClientListOptions contains the optional parameters for the EvaluationTaxonomiesClient.NewListPager method.

func (*EvaluationTaxonomiesClient) Update 

func (client *EvaluationTaxonomiesClient) Update(ctx context.Context, name string, taxonomy EvaluationTaxonomy, options *EvaluationTaxonomiesClientUpdateOptions) (EvaluationTaxonomiesClientUpdateResponse, error)

Update - Update an evaluation taxonomy

Update an evaluation taxonomy. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the evaluation taxonomy.
  • taxonomy - The evaluation taxonomy.
  • options - EvaluationTaxonomiesClientUpdateOptions contains the optional parameters for the EvaluationTaxonomiesClient.Update method.

type EvaluationTaxonomiesClientCreateOptions 

type EvaluationTaxonomiesClientCreateOptions struct {
}

EvaluationTaxonomiesClientCreateOptions contains the optional parameters for the EvaluationTaxonomiesClient.Create method.

type EvaluationTaxonomiesClientCreateResponse 

type EvaluationTaxonomiesClientCreateResponse struct {
	// Evaluation Taxonomy Definition
	EvaluationTaxonomy
}

EvaluationTaxonomiesClientCreateResponse contains the response from method EvaluationTaxonomiesClient.Create.

type EvaluationTaxonomiesClientDeleteOptions 

type EvaluationTaxonomiesClientDeleteOptions struct {
}

EvaluationTaxonomiesClientDeleteOptions contains the optional parameters for the EvaluationTaxonomiesClient.Delete method.

type EvaluationTaxonomiesClientDeleteResponse 

type EvaluationTaxonomiesClientDeleteResponse struct {
}

EvaluationTaxonomiesClientDeleteResponse contains the response from method EvaluationTaxonomiesClient.Delete.

type EvaluationTaxonomiesClientGetOptions 

type EvaluationTaxonomiesClientGetOptions struct {
}

EvaluationTaxonomiesClientGetOptions contains the optional parameters for the EvaluationTaxonomiesClient.Get method.

type EvaluationTaxonomiesClientGetResponse 

type EvaluationTaxonomiesClientGetResponse struct {
	// Evaluation Taxonomy Definition
	EvaluationTaxonomy
}

EvaluationTaxonomiesClientGetResponse contains the response from method EvaluationTaxonomiesClient.Get.

type EvaluationTaxonomiesClientListOptions 

type EvaluationTaxonomiesClientListOptions struct {
	// Filter by the evaluation input name.
	InputName *string

	// Filter by taxonomy input type.
	InputType *string
}

EvaluationTaxonomiesClientListOptions contains the optional parameters for the EvaluationTaxonomiesClient.NewListPager method.

type EvaluationTaxonomiesClientListResponse 

type EvaluationTaxonomiesClientListResponse struct {
	// Paged collection of EvaluationTaxonomy items
	PagedEvaluationTaxonomy
}

EvaluationTaxonomiesClientListResponse contains the response from method EvaluationTaxonomiesClient.NewListPager.

type EvaluationTaxonomiesClientUpdateOptions 

type EvaluationTaxonomiesClientUpdateOptions struct {
}

EvaluationTaxonomiesClientUpdateOptions contains the optional parameters for the EvaluationTaxonomiesClient.Update method.

type EvaluationTaxonomiesClientUpdateResponse 

type EvaluationTaxonomiesClientUpdateResponse struct {
	// Evaluation Taxonomy Definition
	EvaluationTaxonomy
}

EvaluationTaxonomiesClientUpdateResponse contains the response from method EvaluationTaxonomiesClient.Update.

type EvaluationTaxonomy 

type EvaluationTaxonomy struct {
	// REQUIRED; Input configuration for the evaluation taxonomy.
	TaxonomyInput EvaluationTaxonomyInputClassification

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The version of the resource
	Version *string

	// The asset description text.
	Description *string

	// Additional properties for the evaluation taxonomy.
	Properties map[string]*string

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// List of taxonomy categories.
	TaxonomyCategories []TaxonomyCategory

	// READ-ONLY; Asset ID, a unique identifier for the asset
	ID *string
}

EvaluationTaxonomy - Evaluation Taxonomy Definition

func (EvaluationTaxonomy) MarshalJSON 

func (e EvaluationTaxonomy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EvaluationTaxonomy.

func (*EvaluationTaxonomy) UnmarshalJSON 

func (e *EvaluationTaxonomy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EvaluationTaxonomy.

type EvaluationTaxonomyInput 

type EvaluationTaxonomyInput struct {
	// REQUIRED; Input type of the evaluation taxonomy.
	Type *EvaluationTaxonomyInputType
}

EvaluationTaxonomyInput - Input configuration for the evaluation taxonomy.

func (*EvaluationTaxonomyInput) GetEvaluationTaxonomyInput 

func (e *EvaluationTaxonomyInput) GetEvaluationTaxonomyInput() *EvaluationTaxonomyInput

GetEvaluationTaxonomyInput implements the EvaluationTaxonomyInputClassification interface for type EvaluationTaxonomyInput.

func (EvaluationTaxonomyInput) MarshalJSON 

func (e EvaluationTaxonomyInput) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EvaluationTaxonomyInput.

func (*EvaluationTaxonomyInput) UnmarshalJSON 

func (e *EvaluationTaxonomyInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EvaluationTaxonomyInput.

type EvaluationTaxonomyInputClassification 

type EvaluationTaxonomyInputClassification interface {
	// GetEvaluationTaxonomyInput returns the EvaluationTaxonomyInput content of the underlying type.
	GetEvaluationTaxonomyInput() *EvaluationTaxonomyInput
}

EvaluationTaxonomyInputClassification provides polymorphic access to related types. Call the interface's GetEvaluationTaxonomyInput() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AgentTaxonomyInput, *EvaluationTaxonomyInput

type EvaluationTaxonomyInputType 

type EvaluationTaxonomyInputType string

EvaluationTaxonomyInputType - Type of the evaluation taxonomy input. 

const (
	// EvaluationTaxonomyInputTypeAgent - Agent
	EvaluationTaxonomyInputTypeAgent EvaluationTaxonomyInputType = "agent"
	// EvaluationTaxonomyInputTypePolicy - Policy
	EvaluationTaxonomyInputTypePolicy EvaluationTaxonomyInputType = "policy"
)

func PossibleEvaluationTaxonomyInputTypeValues 

func PossibleEvaluationTaxonomyInputTypeValues() []EvaluationTaxonomyInputType

PossibleEvaluationTaxonomyInputTypeValues returns the possible values for the EvaluationTaxonomyInputType const type.

type EvaluatorCategory 

type EvaluatorCategory string

EvaluatorCategory - The category of the evaluator 

const (
	// EvaluatorCategoryAgents - Agents
	EvaluatorCategoryAgents EvaluatorCategory = "agents"
	// EvaluatorCategoryQuality - Quality
	EvaluatorCategoryQuality EvaluatorCategory = "quality"
	// EvaluatorCategorySafety - Risk & Safety
	EvaluatorCategorySafety EvaluatorCategory = "safety"
)

func PossibleEvaluatorCategoryValues 

func PossibleEvaluatorCategoryValues() []EvaluatorCategory

PossibleEvaluatorCategoryValues returns the possible values for the EvaluatorCategory const type.

type EvaluatorCredentialRequest 

type EvaluatorCredentialRequest struct {
	// REQUIRED; The blob URI for the evaluator storage. Example: `https://account.blob.core.windows.net:443/container`
	BlobURI *string
}

EvaluatorCredentialRequest - Request body for getting evaluator credentials

func (EvaluatorCredentialRequest) MarshalJSON 

func (e EvaluatorCredentialRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EvaluatorCredentialRequest.

func (*EvaluatorCredentialRequest) UnmarshalJSON 

func (e *EvaluatorCredentialRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EvaluatorCredentialRequest.

type EvaluatorDefinition 

type EvaluatorDefinition struct {
	// REQUIRED; The type of evaluator definition
	Type *EvaluatorDefinitionType

	// The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required.
	DataSchema map[string]any

	// The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required.
	InitParameters map[string]any

	// List of output metrics produced by this evaluator
	Metrics map[string]*EvaluatorMetric
}

EvaluatorDefinition - Base evaluator configuration with discriminator

func (*EvaluatorDefinition) GetEvaluatorDefinition 

func (e *EvaluatorDefinition) GetEvaluatorDefinition() *EvaluatorDefinition

GetEvaluatorDefinition implements the EvaluatorDefinitionClassification interface for type EvaluatorDefinition.

func (EvaluatorDefinition) MarshalJSON 

func (e EvaluatorDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EvaluatorDefinition.

func (*EvaluatorDefinition) UnmarshalJSON 

func (e *EvaluatorDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EvaluatorDefinition.

type EvaluatorDefinitionClassification 

type EvaluatorDefinitionClassification interface {
	// GetEvaluatorDefinition returns the EvaluatorDefinition content of the underlying type.
	GetEvaluatorDefinition() *EvaluatorDefinition
}

EvaluatorDefinitionClassification provides polymorphic access to related types. Call the interface's GetEvaluatorDefinition() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *CodeBasedEvaluatorDefinition, *EvaluatorDefinition, *PromptBasedEvaluatorDefinition, *RubricBasedEvaluatorDefinition

type EvaluatorDefinitionType 

type EvaluatorDefinitionType string

EvaluatorDefinitionType - The type of evaluator definition 

const (
	// EvaluatorDefinitionTypeCode - Code-based definition
	EvaluatorDefinitionTypeCode EvaluatorDefinitionType = "code"
	// EvaluatorDefinitionTypeOpenaiGraders - OpenAI graders
	EvaluatorDefinitionTypeOpenaiGraders EvaluatorDefinitionType = "openai_graders"
	// EvaluatorDefinitionTypePrompt - Prompt-based definition
	EvaluatorDefinitionTypePrompt EvaluatorDefinitionType = "prompt"
	// EvaluatorDefinitionTypePromptAndCode - Prompt & Code Based definition
	EvaluatorDefinitionTypePromptAndCode EvaluatorDefinitionType = "prompt_and_code"
	// EvaluatorDefinitionTypeRubric - Rubric-based evaluator definition. Stores dimensions (the scoring blueprint) for both quality
	// and safety evaluators. Can be created via the generate API or manually via createVersion.
	EvaluatorDefinitionTypeRubric EvaluatorDefinitionType = "rubric"
	// EvaluatorDefinitionTypeService - Service-based evaluator
	EvaluatorDefinitionTypeService EvaluatorDefinitionType = "service"
)

func PossibleEvaluatorDefinitionTypeValues 

func PossibleEvaluatorDefinitionTypeValues() []EvaluatorDefinitionType

PossibleEvaluatorDefinitionTypeValues returns the possible values for the EvaluatorDefinitionType const type.

type EvaluatorGenerationArtifacts 

type EvaluatorGenerationArtifacts struct {
	// REQUIRED; Reference to the single Foundry Dataset (one combined JSONL file, version-aligned to `EvaluatorVersion.version`)
	// holding all artifacts produced by the generation pipeline. Each row in the JSONL carries a `kind` field discriminating
	// its content (e.g. `spec`, `tools`, `context`).
	Dataset *DatasetReference

	// REQUIRED; The kinds of rows present in `dataset`. Always contains `"spec"` (the generated evaluation specification, a Markdown
	// document describing what the evaluator measures). May additionally contain `"tools"` (when the generation pipeline produced
	// or inferred OpenAI tool schemas) and/or `"context"` (when supplementary materials such as file uploads or trace samples
	// were used during generation).
	Kinds []string
}

EvaluatorGenerationArtifacts - Service-managed provenance artifacts produced by an evaluator generation job. Present only on EvaluatorVersion resources created via the generation pipeline. The combined-JSONL Foundry Dataset is read-only and resolves to a versioned dataset in a service-reserved namespace.

func (EvaluatorGenerationArtifacts) MarshalJSON 

func (e EvaluatorGenerationArtifacts) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EvaluatorGenerationArtifacts.

func (*EvaluatorGenerationArtifacts) UnmarshalJSON 

func (e *EvaluatorGenerationArtifacts) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EvaluatorGenerationArtifacts.

type EvaluatorGenerationInputs 

type EvaluatorGenerationInputs struct {
	// REQUIRED; The evaluator name (immutable identifier). 1-256 characters; allowed characters are ASCII letters, digits, underscore
	// (`_`), period (`.`), tilde (`~`), and hyphen (`-`). The prefix `builtin.` is reserved for system-managed evaluators and
	// is rejected by the service. If an evaluator with this name already exists in the project (and is rubric-subtype), the service
	// creates a new version under the same name and uses the prior version's `dimensions` as context for incremental improvement
	// (foundation of the post-//build adaptive loop). Old versions remain queryable via `get_version(name, version)`. If the
	// existing evaluator is not a rubric-subtype evaluator (built-in, prompt-based, code-based), the request is rejected with
	// `400 Bad Request`.
	EvaluatorName *string

	// REQUIRED; The LLM model to use for rubric generation (e.g., 'gpt-4o'). Required — users must provide their own model rather
	// than relying on service-owned capacity.
	Model *string

	// REQUIRED; Source materials for generation — agent descriptions, prompts, traces, or datasets. Each entry is an `EvaluatorGenerationJobSource`
	// variant discriminated by `type`.
	Sources []EvaluatorGenerationJobSourceClassification

	// Optional human-friendly description for the resulting evaluator. Surfaced as `EvaluatorVersion.description` on the persisted
	// evaluator. Typically collected from the UI alongside `evaluator_display_name`. The `evaluator_` prefix disambiguates this
	// from any other description fields on related models.
	EvaluatorDescription *string

	// Optional human-friendly display name for the resulting evaluator. Surfaced as `EvaluatorVersion.display_name` on the persisted
	// evaluator. When omitted, the service uses `evaluator_name` as the display name. The `evaluator_` prefix disambiguates this
	// from the immutable `evaluator_name` identifier.
	EvaluatorDisplayName *string
}

EvaluatorGenerationInputs - Caller-supplied inputs for an evaluator generation job.

func (EvaluatorGenerationInputs) MarshalJSON 

func (e EvaluatorGenerationInputs) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EvaluatorGenerationInputs.

func (*EvaluatorGenerationInputs) UnmarshalJSON 

func (e *EvaluatorGenerationInputs) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EvaluatorGenerationInputs.

type EvaluatorGenerationJob 

type EvaluatorGenerationJob struct {
	// Caller-supplied inputs.
	Inputs *EvaluatorGenerationInputs

	// READ-ONLY; The timestamp when the job was created, represented in Unix time (seconds since January 1, 1970).
	CreatedAt *time.Time

	// READ-ONLY; Server-assigned unique identifier.
	ID *string

	// READ-ONLY; Current lifecycle status.
	Status *JobStatus

	// READ-ONLY; Error details — populated only on failure.
	Error *Error

	// READ-ONLY; The timestamp when the job finished, represented in Unix time (seconds since January 1, 1970).
	FinishedAt *time.Time

	// READ-ONLY; Result produced on success.
	Result *EvaluatorVersion

	// READ-ONLY; Token consumption summary. Populated when the job reaches a terminal state.
	Usage *EvaluatorGenerationTokenUsage
}

EvaluatorGenerationJob - Evaluator Generation Job resource — a long-running job that generates rubric-based evaluator definitions from source materials. On success, the result is the persisted EvaluatorVersion.

func (EvaluatorGenerationJob) MarshalJSON 

func (e EvaluatorGenerationJob) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EvaluatorGenerationJob.

func (*EvaluatorGenerationJob) UnmarshalJSON 

func (e *EvaluatorGenerationJob) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EvaluatorGenerationJob.

type EvaluatorGenerationJobSource 

type EvaluatorGenerationJobSource struct {
	// REQUIRED; The type of source.
	Type *EvaluatorGenerationJobSourceType
}

EvaluatorGenerationJobSource - The base source model for evaluator generation jobs. Polymorphic over `type`.

func (*EvaluatorGenerationJobSource) GetEvaluatorGenerationJobSource 

func (e *EvaluatorGenerationJobSource) GetEvaluatorGenerationJobSource() *EvaluatorGenerationJobSource

GetEvaluatorGenerationJobSource implements the EvaluatorGenerationJobSourceClassification interface for type EvaluatorGenerationJobSource.

func (EvaluatorGenerationJobSource) MarshalJSON 

func (e EvaluatorGenerationJobSource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EvaluatorGenerationJobSource.

func (*EvaluatorGenerationJobSource) UnmarshalJSON 

func (e *EvaluatorGenerationJobSource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EvaluatorGenerationJobSource.

type EvaluatorGenerationJobSourceClassification 

type EvaluatorGenerationJobSourceClassification interface {
	// GetEvaluatorGenerationJobSource returns the EvaluatorGenerationJobSource content of the underlying type.
	GetEvaluatorGenerationJobSource() *EvaluatorGenerationJobSource
}

EvaluatorGenerationJobSourceClassification provides polymorphic access to related types. Call the interface's GetEvaluatorGenerationJobSource() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AgentEvaluatorGenerationJobSource, *DatasetEvaluatorGenerationJobSource, *EvaluatorGenerationJobSource, *PromptEvaluatorGenerationJobSource, - *TracesEvaluatorGenerationJobSource

type EvaluatorGenerationJobSourceType 

type EvaluatorGenerationJobSourceType string

EvaluatorGenerationJobSourceType - The supported source types for evaluator generation jobs. 

const (
	// EvaluatorGenerationJobSourceTypeAgent - Agent source — references an agent to fetch instructions and metadata from.
	EvaluatorGenerationJobSourceTypeAgent EvaluatorGenerationJobSourceType = "agent"
	// EvaluatorGenerationJobSourceTypeDataset - Dataset source — reference to a dataset.
	EvaluatorGenerationJobSourceTypeDataset EvaluatorGenerationJobSourceType = "dataset"
	// EvaluatorGenerationJobSourceTypePrompt - Prompt source — inline text provided by the user.
	EvaluatorGenerationJobSourceTypePrompt EvaluatorGenerationJobSourceType = "prompt"
	// EvaluatorGenerationJobSourceTypeTraces - Traces source — conversation traces from Application Insights.
	EvaluatorGenerationJobSourceTypeTraces EvaluatorGenerationJobSourceType = "traces"
)

func PossibleEvaluatorGenerationJobSourceTypeValues 

func PossibleEvaluatorGenerationJobSourceTypeValues() []EvaluatorGenerationJobSourceType

PossibleEvaluatorGenerationJobSourceTypeValues returns the possible values for the EvaluatorGenerationJobSourceType const type.

type EvaluatorGenerationJobsClient 

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

EvaluatorGenerationJobsClient contains the methods for the EvaluatorGenerationJobs group. Don't use this type directly, use Client.NewEvaluatorGenerationJobsClient instead.

Generated from API version v1

func (*EvaluatorGenerationJobsClient) Cancel 

func (client *EvaluatorGenerationJobsClient) Cancel(ctx context.Context, jobID string, options *EvaluatorGenerationJobsClientCancelOptions) (EvaluatorGenerationJobsClientCancelResponse, error)

Cancel - Cancel an evaluator generation job

Cancels an evaluator generation job by its ID. If the operation fails it returns an *azcore.ResponseError type.

  • jobID - The ID of the job to cancel.
  • options - EvaluatorGenerationJobsClientCancelOptions contains the optional parameters for the EvaluatorGenerationJobsClient.Cancel method.

func (*EvaluatorGenerationJobsClient) Create 

func (client *EvaluatorGenerationJobsClient) Create(ctx context.Context, job EvaluatorGenerationJob, options *EvaluatorGenerationJobsClientCreateOptions) (EvaluatorGenerationJobsClientCreateResponse, error)

Create - Create an evaluator generation job

Creates an evaluator generation job. The service generates rubric-based evaluator definitions from the provided source materials asynchronously. If the operation fails it returns an *azcore.ResponseError type.

  • job - The job to create.
  • options - EvaluatorGenerationJobsClientCreateOptions contains the optional parameters for the EvaluatorGenerationJobsClient.Create method.

func (*EvaluatorGenerationJobsClient) Delete 

func (client *EvaluatorGenerationJobsClient) Delete(ctx context.Context, jobID string, options *EvaluatorGenerationJobsClientDeleteOptions) (EvaluatorGenerationJobsClientDeleteResponse, error)

Delete - Delete an evaluator generation job

Deletes an evaluator generation job by its ID. Deletes the job record only; the generated evaluator (if any) is preserved. If the operation fails it returns an *azcore.ResponseError type.

  • jobID - The ID of the job to delete.
  • options - EvaluatorGenerationJobsClientDeleteOptions contains the optional parameters for the EvaluatorGenerationJobsClient.Delete method.

func (*EvaluatorGenerationJobsClient) Get 

func (client *EvaluatorGenerationJobsClient) Get(ctx context.Context, jobID string, options *EvaluatorGenerationJobsClientGetOptions) (EvaluatorGenerationJobsClientGetResponse, error)

Get - Get an evaluator generation job

Gets the details of an evaluator generation job by its ID. If the operation fails it returns an *azcore.ResponseError type.

  • jobID - The ID of the job.
  • options - EvaluatorGenerationJobsClientGetOptions contains the optional parameters for the EvaluatorGenerationJobsClient.Get method.

func (*EvaluatorGenerationJobsClient) NewListPager 

func (client *EvaluatorGenerationJobsClient) NewListPager(options *EvaluatorGenerationJobsClientListOptions) *runtime.Pager[EvaluatorGenerationJobsClientListResponse]

NewListPager - List evaluator generation jobs

Returns a list of evaluator generation jobs. The List API has up to a few seconds of propagation delay, so a recently created job may not appear immediately; use the Get evaluator generation job API with the job ID to retrieve a specific job without delay.

  • options - EvaluatorGenerationJobsClientListOptions contains the optional parameters for the EvaluatorGenerationJobsClient.NewListPager method.

type EvaluatorGenerationJobsClientCancelOptions 

type EvaluatorGenerationJobsClientCancelOptions struct {
	// A feature flag opt-in required when using preview operations or modifying persisted preview resources.
	FoundryFeatures *string
}

EvaluatorGenerationJobsClientCancelOptions contains the optional parameters for the EvaluatorGenerationJobsClient.Cancel method.

type EvaluatorGenerationJobsClientCancelResponse 

type EvaluatorGenerationJobsClientCancelResponse struct {
	// Evaluator Generation Job resource — a long-running job that generates rubric-based evaluator definitions from source materials.
	// On success, the result is the persisted EvaluatorVersion.
	EvaluatorGenerationJob
}

EvaluatorGenerationJobsClientCancelResponse contains the response from method EvaluatorGenerationJobsClient.Cancel.

type EvaluatorGenerationJobsClientCreateOptions 

type EvaluatorGenerationJobsClientCreateOptions struct {
	// A feature flag opt-in required when using preview operations or modifying persisted preview resources.
	FoundryFeatures *string

	// Client-generated unique ID for idempotent retries. When absent, the server creates the job unconditionally.
	OperationID *string
}

EvaluatorGenerationJobsClientCreateOptions contains the optional parameters for the EvaluatorGenerationJobsClient.Create method.

type EvaluatorGenerationJobsClientCreateResponse 

type EvaluatorGenerationJobsClientCreateResponse struct {
	// Evaluator Generation Job resource — a long-running job that generates rubric-based evaluator definitions from source materials.
	// On success, the result is the persisted EvaluatorVersion.
	EvaluatorGenerationJob

	// URL of the created job resource.
	Location *string

	// URL to poll for the job status.
	OperationLocation *string
}

EvaluatorGenerationJobsClientCreateResponse contains the response from method EvaluatorGenerationJobsClient.Create.

type EvaluatorGenerationJobsClientDeleteOptions 

type EvaluatorGenerationJobsClientDeleteOptions struct {
	// A feature flag opt-in required when using preview operations or modifying persisted preview resources.
	FoundryFeatures *string
}

EvaluatorGenerationJobsClientDeleteOptions contains the optional parameters for the EvaluatorGenerationJobsClient.Delete method.

type EvaluatorGenerationJobsClientDeleteResponse 

type EvaluatorGenerationJobsClientDeleteResponse struct {
}

EvaluatorGenerationJobsClientDeleteResponse contains the response from method EvaluatorGenerationJobsClient.Delete.

type EvaluatorGenerationJobsClientGetOptions 

type EvaluatorGenerationJobsClientGetOptions struct {
	// A feature flag opt-in required when using preview operations or modifying persisted preview resources.
	FoundryFeatures *string
}

EvaluatorGenerationJobsClientGetOptions contains the optional parameters for the EvaluatorGenerationJobsClient.Get method.

type EvaluatorGenerationJobsClientGetResponse 

type EvaluatorGenerationJobsClientGetResponse struct {
	// Evaluator Generation Job resource — a long-running job that generates rubric-based evaluator definitions from source materials.
	// On success, the result is the persisted EvaluatorVersion.
	EvaluatorGenerationJob

	// Recommended number of seconds to wait before polling again.
	RetryAfter *int32
}

EvaluatorGenerationJobsClientGetResponse contains the response from method EvaluatorGenerationJobsClient.Get.

type EvaluatorGenerationJobsClientListOptions 

type EvaluatorGenerationJobsClientListOptions struct {
	// A cursor for use in pagination. `after` is an object ID that defines your place in the list.
	// For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
	// subsequent call can include after=obj_foo in order to fetch the next page of the list.
	After *string

	// A cursor for use in pagination. `before` is an object ID that defines your place in the list.
	// For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
	// subsequent call can include before=obj_foo in order to fetch the previous page of the list.
	Before *string

	// A feature flag opt-in required when using preview operations or modifying persisted preview resources.
	FoundryFeatures *string

	// A limit on the number of objects to be returned. Limit can range between 1 and 100, and the
	// default is 20.
	Limit *int32

	// Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`
	// for descending order.
	Order *PageOrder
}

EvaluatorGenerationJobsClientListOptions contains the optional parameters for the EvaluatorGenerationJobsClient.NewListPager method.

type EvaluatorGenerationJobsClientListResponse 

type EvaluatorGenerationJobsClientListResponse struct {
	// The response data for a requested list of items.
	AgentsPagedResultEvaluatorGenerationJob
}

EvaluatorGenerationJobsClientListResponse contains the response from method EvaluatorGenerationJobsClient.NewListPager.

type EvaluatorGenerationTokenUsage 

type EvaluatorGenerationTokenUsage struct {
	// REQUIRED; Number of input (prompt) tokens consumed.
	InputTokens *int64

	// REQUIRED; Number of output (completion) tokens generated.
	OutputTokens *int64

	// REQUIRED; Total tokens consumed (input + output).
	TotalTokens *int64
}

EvaluatorGenerationTokenUsage - Token consumption summary for an evaluator generation job. Populated when the job reaches a terminal state.

func (EvaluatorGenerationTokenUsage) MarshalJSON 

func (e EvaluatorGenerationTokenUsage) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EvaluatorGenerationTokenUsage.

func (*EvaluatorGenerationTokenUsage) UnmarshalJSON 

func (e *EvaluatorGenerationTokenUsage) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EvaluatorGenerationTokenUsage.

type EvaluatorMetric 

type EvaluatorMetric struct {
	// It indicates whether a higher value is better or a lower value is better for this metric.
	DesirableDirection *EvaluatorMetricDirection

	// Indicates if this metric is primary when there are multiple metrics.
	IsPrimary *bool

	// Maximum value for the metric. If not specified, it is assumed to be unbounded.
	MaxValue *float32

	// Minimum value for the metric
	MinValue *float32

	// Default pass/fail threshold for this metric.
	Threshold *float32

	// Type of the metric.
	Type *EvaluatorMetricType
}

EvaluatorMetric - Evaluator Metric

func (EvaluatorMetric) MarshalJSON 

func (e EvaluatorMetric) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EvaluatorMetric.

func (*EvaluatorMetric) UnmarshalJSON 

func (e *EvaluatorMetric) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EvaluatorMetric.

type EvaluatorMetricDirection 

type EvaluatorMetricDirection string

EvaluatorMetricDirection - The direction of the metric indicating whether a higher value is better, a lower value is better, or neutral 

const (
	// EvaluatorMetricDirectionDecrease - It indicates a lower value is better for this metric
	EvaluatorMetricDirectionDecrease EvaluatorMetricDirection = "decrease"
	// EvaluatorMetricDirectionIncrease - It indicates a higher value is better for this metric
	EvaluatorMetricDirectionIncrease EvaluatorMetricDirection = "increase"
	// EvaluatorMetricDirectionNeutral - It indicates no preference for this metric direction
	EvaluatorMetricDirectionNeutral EvaluatorMetricDirection = "neutral"
)

func PossibleEvaluatorMetricDirectionValues 

func PossibleEvaluatorMetricDirectionValues() []EvaluatorMetricDirection

PossibleEvaluatorMetricDirectionValues returns the possible values for the EvaluatorMetricDirection const type.

type EvaluatorMetricType 

type EvaluatorMetricType string

EvaluatorMetricType - The type of the evaluator 

const (
	// EvaluatorMetricTypeBoolean - Boolean metric representing true/false values
	EvaluatorMetricTypeBoolean EvaluatorMetricType = "boolean"
	// EvaluatorMetricTypeContinuous - Continuous metric representing values in a continuous range.
	EvaluatorMetricTypeContinuous EvaluatorMetricType = "continuous"
	// EvaluatorMetricTypeOrdinal - Ordinal metric representing categories that can be ordered or ranked.
	EvaluatorMetricTypeOrdinal EvaluatorMetricType = "ordinal"
)

func PossibleEvaluatorMetricTypeValues 

func PossibleEvaluatorMetricTypeValues() []EvaluatorMetricType

PossibleEvaluatorMetricTypeValues returns the possible values for the EvaluatorMetricType const type.

type EvaluatorType 

type EvaluatorType string

EvaluatorType - The type of the evaluator 

const (
	// EvaluatorTypeBuiltIn - Built-in evaluator (Microsoft provided)
	EvaluatorTypeBuiltIn EvaluatorType = "builtin"
	// EvaluatorTypeCustom - Custom evaluator
	EvaluatorTypeCustom EvaluatorType = "custom"
)

func PossibleEvaluatorTypeValues 

func PossibleEvaluatorTypeValues() []EvaluatorType

PossibleEvaluatorTypeValues returns the possible values for the EvaluatorType const type.

type EvaluatorVersion 

type EvaluatorVersion struct {
	// REQUIRED; The categories of the evaluator
	Categories []EvaluatorCategory

	// REQUIRED; Definition of the evaluator
	Definition EvaluatorDefinitionClassification

	// REQUIRED; The type of the evaluator
	EvaluatorType *EvaluatorType

	// READ-ONLY; Last modified date/time of the evaluator
	ModifiedAt *time.Time

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The version of the resource
	Version *string

	// The asset description text.
	Description *string

	// Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique.
	DisplayName *string

	// Metadata about the evaluator
	Metadata map[string]*string

	// Evaluation levels this evaluator supports (e.g., `turn`, `conversation`). When omitted on create, the service defaults
	// to `["turn"]`. On update, omitting this field leaves it unchanged; an empty list is rejected. Custom code-based evaluators
	// support only `turn`; custom prompt-based evaluators support exactly one level (`turn` or `conversation`).
	SupportedEvaluationLevels []EvaluationLevel

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// READ-ONLY; Creation date/time of the evaluator
	CreatedAt *time.Time

	// READ-ONLY; Creator of the evaluator
	CreatedBy *string

	// READ-ONLY; Provenance artifacts from the generation pipeline. Read-only; present only on evaluator versions created via
	// an EvaluatorGenerationJob. Each artifact resolves to a versioned Foundry Dataset.
	GenerationArtifacts *EvaluatorGenerationArtifacts

	// READ-ONLY; Asset ID, a unique identifier for the asset
	ID *string
}

EvaluatorVersion - Evaluator Definition

func (EvaluatorVersion) MarshalJSON 

func (e EvaluatorVersion) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EvaluatorVersion.

func (*EvaluatorVersion) UnmarshalJSON 

func (e *EvaluatorVersion) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EvaluatorVersion.

type EvaluatorsClient 

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

EvaluatorsClient contains the methods for the Evaluators group. Don't use this type directly, use Client.NewEvaluatorsClient instead.

Generated from API version v1

func (*EvaluatorsClient) CreateVersion 

func (client *EvaluatorsClient) CreateVersion(ctx context.Context, name string, evaluatorVersion EvaluatorVersion, options *EvaluatorsClientCreateVersionOptions) (EvaluatorsClientCreateVersionResponse, error)

CreateVersion - Create an evaluator version

Creates a new evaluator version with an auto-incremented version identifier. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the resource
  • options - EvaluatorsClientCreateVersionOptions contains the optional parameters for the EvaluatorsClient.CreateVersion method.

func (*EvaluatorsClient) DeleteVersion 

func (client *EvaluatorsClient) DeleteVersion(ctx context.Context, name string, version string, options *EvaluatorsClientDeleteVersionOptions) (EvaluatorsClientDeleteVersionResponse, error)

DeleteVersion - Delete an evaluator version

Removes the specified evaluator version. Returns 204 whether the version existed or not. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the resource
  • version - The version of the EvaluatorVersion to delete.
  • options - EvaluatorsClientDeleteVersionOptions contains the optional parameters for the EvaluatorsClient.DeleteVersion method.

func (*EvaluatorsClient) GetCredentials 

func (client *EvaluatorsClient) GetCredentials(ctx context.Context, name string, credentialRequest EvaluatorCredentialRequest, version string, options *EvaluatorsClientGetCredentialsOptions) (EvaluatorsClientGetCredentialsResponse, error)

GetCredentials - Get evaluator credentials

Retrieves SAS credentials for accessing the storage account associated with the specified evaluator version. If the operation fails it returns an *azcore.ResponseError type.

  • credentialRequest - The credential request parameters
  • version - The specific version id of the EvaluatorVersion to operate on.
  • options - EvaluatorsClientGetCredentialsOptions contains the optional parameters for the EvaluatorsClient.GetCredentials method.

func (*EvaluatorsClient) GetVersion 

func (client *EvaluatorsClient) GetVersion(ctx context.Context, name string, version string, options *EvaluatorsClientGetVersionOptions) (EvaluatorsClientGetVersionResponse, error)

GetVersion - Get an evaluator version

Retrieves the specified evaluator version, returning 404 if it does not exist. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the resource
  • version - The specific version id of the EvaluatorVersion to retrieve.
  • options - EvaluatorsClientGetVersionOptions contains the optional parameters for the EvaluatorsClient.GetVersion method.

func (*EvaluatorsClient) NewListLatestVersionsPager 

func (client *EvaluatorsClient) NewListLatestVersionsPager(options *EvaluatorsClientListLatestVersionsOptions) *runtime.Pager[EvaluatorsClientListLatestVersionsResponse]

NewListLatestVersionsPager - List latest evaluator versions

Lists the latest version of each evaluator

  • options - EvaluatorsClientListLatestVersionsOptions contains the optional parameters for the EvaluatorsClient.NewListLatestVersionsPager method.

func (*EvaluatorsClient) NewListVersionsPager 

func (client *EvaluatorsClient) NewListVersionsPager(name string, options *EvaluatorsClientListVersionsOptions) *runtime.Pager[EvaluatorsClientListVersionsResponse]

NewListVersionsPager - List evaluator versions

Returns the available versions for the specified evaluator.

  • name - The name of the resource
  • options - EvaluatorsClientListVersionsOptions contains the optional parameters for the EvaluatorsClient.NewListVersionsPager method.

func (*EvaluatorsClient) StartPendingUpload 

func (client *EvaluatorsClient) StartPendingUpload(ctx context.Context, name string, version string, pendingUploadRequest PendingUploadRequest, options *EvaluatorsClientStartPendingUploadOptions) (EvaluatorsClientStartPendingUploadResponse, error)

StartPendingUpload - Start a pending upload

Initiates a new pending upload or retrieves an existing one for the specified evaluator version. If the operation fails it returns an *azcore.ResponseError type.

  • version - The specific version id of the EvaluatorVersion to operate on.
  • pendingUploadRequest - The pending upload request parameters
  • options - EvaluatorsClientStartPendingUploadOptions contains the optional parameters for the EvaluatorsClient.StartPendingUpload method.

func (*EvaluatorsClient) UpdateVersion 

func (client *EvaluatorsClient) UpdateVersion(ctx context.Context, name string, version string, evaluatorVersion EvaluatorVersion, options *EvaluatorsClientUpdateVersionOptions) (EvaluatorsClientUpdateVersionResponse, error)

UpdateVersion - Update an evaluator version

Updates the specified evaluator version in place. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the resource
  • version - The version of the EvaluatorVersion to update.
  • evaluatorVersion - Evaluator resource
  • options - EvaluatorsClientUpdateVersionOptions contains the optional parameters for the EvaluatorsClient.UpdateVersion method.

type EvaluatorsClientCreateVersionOptions 

type EvaluatorsClientCreateVersionOptions struct {
}

EvaluatorsClientCreateVersionOptions contains the optional parameters for the EvaluatorsClient.CreateVersion method.

type EvaluatorsClientCreateVersionResponse 

type EvaluatorsClientCreateVersionResponse struct {
	// Evaluator Definition
	EvaluatorVersion
}

EvaluatorsClientCreateVersionResponse contains the response from method EvaluatorsClient.CreateVersion.

type EvaluatorsClientDeleteVersionOptions 

type EvaluatorsClientDeleteVersionOptions struct {
}

EvaluatorsClientDeleteVersionOptions contains the optional parameters for the EvaluatorsClient.DeleteVersion method.

type EvaluatorsClientDeleteVersionResponse 

type EvaluatorsClientDeleteVersionResponse struct {
}

EvaluatorsClientDeleteVersionResponse contains the response from method EvaluatorsClient.DeleteVersion.

type EvaluatorsClientGetCredentialsOptions 

type EvaluatorsClientGetCredentialsOptions struct {
	// A feature flag opt-in required when using preview operations or modifying persisted preview resources.
	FoundryFeatures *string
}

EvaluatorsClientGetCredentialsOptions contains the optional parameters for the EvaluatorsClient.GetCredentials method.

type EvaluatorsClientGetCredentialsResponse 

type EvaluatorsClientGetCredentialsResponse struct {
	// Represents a reference to a blob for consumption
	DatasetCredential
}

EvaluatorsClientGetCredentialsResponse contains the response from method EvaluatorsClient.GetCredentials.

type EvaluatorsClientGetVersionOptions 

type EvaluatorsClientGetVersionOptions struct {
}

EvaluatorsClientGetVersionOptions contains the optional parameters for the EvaluatorsClient.GetVersion method.

type EvaluatorsClientGetVersionResponse 

type EvaluatorsClientGetVersionResponse struct {
	// Evaluator Definition
	EvaluatorVersion
}

EvaluatorsClientGetVersionResponse contains the response from method EvaluatorsClient.GetVersion.

type EvaluatorsClientListLatestVersionsOptions 

type EvaluatorsClientListLatestVersionsOptions struct {
	// A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
	Limit *int32

	// Filter evaluators by type. Possible values: 'all', 'custom', 'builtin'.
	Type *ListVersionsRequestType
}

EvaluatorsClientListLatestVersionsOptions contains the optional parameters for the EvaluatorsClient.NewListLatestVersionsPager method.

type EvaluatorsClientListLatestVersionsResponse 

type EvaluatorsClientListLatestVersionsResponse struct {
	// Paged collection of EvaluatorVersion items
	PagedEvaluatorVersion
}

EvaluatorsClientListLatestVersionsResponse contains the response from method EvaluatorsClient.NewListLatestVersionsPager.

type EvaluatorsClientListVersionsOptions 

type EvaluatorsClientListVersionsOptions struct {
	// A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
	Limit *int32

	// Filter evaluators by type. Possible values: 'all', 'custom', 'builtin'.
	Type *ListVersionsRequestType
}

EvaluatorsClientListVersionsOptions contains the optional parameters for the EvaluatorsClient.NewListVersionsPager method.

type EvaluatorsClientListVersionsResponse 

type EvaluatorsClientListVersionsResponse struct {
	// Paged collection of EvaluatorVersion items
	PagedEvaluatorVersion
}

EvaluatorsClientListVersionsResponse contains the response from method EvaluatorsClient.NewListVersionsPager.

type EvaluatorsClientStartPendingUploadOptions 

type EvaluatorsClientStartPendingUploadOptions struct {
	// A feature flag opt-in required when using preview operations or modifying persisted preview resources.
	FoundryFeatures *string
}

EvaluatorsClientStartPendingUploadOptions contains the optional parameters for the EvaluatorsClient.StartPendingUpload method.

type EvaluatorsClientStartPendingUploadResponse 

type EvaluatorsClientStartPendingUploadResponse struct {
	// Represents the response for a pending upload request
	PendingUploadResponse
}

EvaluatorsClientStartPendingUploadResponse contains the response from method EvaluatorsClient.StartPendingUpload.

type EvaluatorsClientUpdateVersionOptions 

type EvaluatorsClientUpdateVersionOptions struct {
}

EvaluatorsClientUpdateVersionOptions contains the optional parameters for the EvaluatorsClient.UpdateVersion method.

type EvaluatorsClientUpdateVersionResponse 

type EvaluatorsClientUpdateVersionResponse struct {
	// Evaluator Definition
	EvaluatorVersion
}

EvaluatorsClientUpdateVersionResponse contains the response from method EvaluatorsClient.UpdateVersion.

type FabricDataAgentToolParameters 

type FabricDataAgentToolParameters struct {
	// The project connections attached to this tool. There can be a maximum of 1 connection
	// resource attached to the tool.
	ProjectConnections []ToolProjectConnection
}

FabricDataAgentToolParameters - The fabric data agent tool parameters.

func (FabricDataAgentToolParameters) MarshalJSON 

func (f FabricDataAgentToolParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FabricDataAgentToolParameters.

func (*FabricDataAgentToolParameters) UnmarshalJSON 

func (f *FabricDataAgentToolParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FabricDataAgentToolParameters.

type FabricIQPreviewTool 

type FabricIQPreviewTool struct {
	// REQUIRED; The ID of the FabricIQ project connection.
	ProjectConnectionID *string

	// CONSTANT; The object type, which is always 'fabric_iq_preview'.
	// Field has constant value ToolTypeFabricIqPreview, any specified value is ignored.
	Type *ToolType

	// (Optional) Whether the agent requires approval before executing actions. Default is always.
	RequireApproval *string

	// (Optional) The label of the FabricIQ MCP server to connect to.
	ServerLabel *string

	// (Optional) The URL of the FabricIQ MCP server. If not provided, the URL from the project connection will be used.
	ServerURL *string
}

FabricIQPreviewTool - A FabricIQ server-side tool.

func (*FabricIQPreviewTool) GetTool 

func (f *FabricIQPreviewTool) GetTool() *Tool

GetTool implements the ToolClassification interface for type FabricIQPreviewTool.

func (FabricIQPreviewTool) MarshalJSON 

func (f FabricIQPreviewTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FabricIQPreviewTool.

func (*FabricIQPreviewTool) UnmarshalJSON 

func (f *FabricIQPreviewTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FabricIQPreviewTool.

type FabricIQPreviewToolboxTool 

type FabricIQPreviewToolboxTool struct {
	// REQUIRED; The ID of the FabricIQ project connection.
	ProjectConnectionID *string

	// CONSTANT; Field has constant value ToolboxToolTypeFabricIqPreview, any specified value is ignored.
	Type *ToolboxToolType

	// Optional user-defined description for this tool or configuration.
	Description *string

	// Optional user-defined name for this tool or configuration.
	Name *string

	// (Optional) Whether the agent requires approval before executing actions. Default is always.
	RequireApproval *string

	// (Optional) The label of the FabricIQ MCP server to connect to.
	ServerLabel *string

	// (Optional) The URL of the FabricIQ MCP server. If not provided, the URL from the project connection will be used.
	ServerURL *string

	// Per-tool configuration map. Keys are tool names or `*` (catch-all default).
	// Resolution order: exact tool name match takes priority over `*`.
	// Unknown tool names are silently ignored at runtime.
	ToolConfigs map[string]*ToolConfig
}

FabricIQPreviewToolboxTool - A FabricIQ tool stored in a toolbox.

func (*FabricIQPreviewToolboxTool) GetToolboxTool 

func (f *FabricIQPreviewToolboxTool) GetToolboxTool() *ToolboxTool

GetToolboxTool implements the ToolboxToolClassification interface for type FabricIQPreviewToolboxTool.

func (FabricIQPreviewToolboxTool) MarshalJSON 

func (f FabricIQPreviewToolboxTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FabricIQPreviewToolboxTool.

func (*FabricIQPreviewToolboxTool) UnmarshalJSON 

func (f *FabricIQPreviewToolboxTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FabricIQPreviewToolboxTool.

type FieldMapping 

type FieldMapping struct {
	// REQUIRED; List of fields with text content
	ContentFields []string

	// Path of file to be used as a source of text content
	FilepathField *string

	// List of fields with metadata content
	MetadataFields []string

	// Field containing the title of the document
	TitleField *string

	// Field containing the url of the document
	URLField *string

	// List of fields with vector content
	VectorFields []string
}

FieldMapping - Field mapping configuration class

func (FieldMapping) MarshalJSON 

func (f FieldMapping) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FieldMapping.

func (*FieldMapping) UnmarshalJSON 

func (f *FieldMapping) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FieldMapping.

type FileDatasetVersion 

type FileDatasetVersion struct {
	// REQUIRED; URI of the data ([example](https://go.microsoft.com/fwlink/?linkid=2202330))
	DataURI *string

	// CONSTANT; Dataset type
	// Field has constant value DatasetTypeURIFile, any specified value is ignored.
	Type *DatasetType

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The version of the resource
	Version *string

	// The Azure Storage Account connection name. Required if startPendingUploadVersion was not called before creating the Dataset
	ConnectionName *string

	// The asset description text.
	Description *string

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// READ-ONLY; Asset ID, a unique identifier for the asset
	ID *string

	// READ-ONLY; Indicates if the dataset holds a reference to the storage, or the dataset manages storage itself. If true, the
	// underlying data will not be deleted when the dataset version is deleted
	IsReference *bool
}

FileDatasetVersion Definition

func (*FileDatasetVersion) GetDatasetVersion 

func (f *FileDatasetVersion) GetDatasetVersion() *DatasetVersion

GetDatasetVersion implements the DatasetVersionClassification interface for type FileDatasetVersion.

func (FileDatasetVersion) MarshalJSON 

func (f FileDatasetVersion) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FileDatasetVersion.

func (*FileDatasetVersion) UnmarshalJSON 

func (f *FileDatasetVersion) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FileDatasetVersion.

type FileSearchTool 

type FileSearchTool struct {
	// CONSTANT; The type of the file search tool. Always `file_search`.
	// Field has constant value ToolTypeFileSearch, any specified value is ignored.
	Type *ToolType

	// REQUIRED; The IDs of the vector stores to search.
	VectorStoreIDs []string

	// Deprecated. This property is deprecated and will be removed in a future version.
	Description *string
	Filters     map[string]any

	// The maximum number of results to return. This number should be between 1 and 50 inclusive.
	MaxNumResults *int64

	// Deprecated. This property is deprecated and will be removed in a future version.
	Name *string

	// Ranking options for search.
	RankingOptions *RankingOptions

	// Deprecated. This property is deprecated and will be removed in a future version.
	ToolConfigs map[string]*ToolConfig
}

FileSearchTool - File search

A tool that searches for relevant content from uploaded files. Learn more about the [file search tool](https://platform.openai.com/docs/guides/tools-file-search).

func (*FileSearchTool) GetTool 

func (f *FileSearchTool) GetTool() *Tool

GetTool implements the ToolClassification interface for type FileSearchTool.

func (FileSearchTool) MarshalJSON 

func (f FileSearchTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FileSearchTool.

func (*FileSearchTool) UnmarshalJSON 

func (f *FileSearchTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FileSearchTool.

type FileSearchToolboxTool 

type FileSearchToolboxTool struct {
	// CONSTANT; Field has constant value ToolboxToolTypeFileSearch, any specified value is ignored.
	Type *ToolboxToolType

	// Optional user-defined description for this tool or configuration.
	Description *string
	Filters     map[string]any

	// The maximum number of results to return. This number should be between 1 and 50 inclusive.
	MaxNumResults *int64

	// Optional user-defined name for this tool or configuration.
	Name *string

	// Ranking options for search.
	RankingOptions *RankingOptions

	// Deprecated. This property is deprecated and will be removed in a future version.
	ToolConfigs map[string]*ToolConfig

	// The IDs of the vector stores to search.
	VectorStoreIDs []string
}

FileSearchToolboxTool - A file search tool stored in a toolbox.

func (*FileSearchToolboxTool) GetToolboxTool 

func (f *FileSearchToolboxTool) GetToolboxTool() *ToolboxTool

GetToolboxTool implements the ToolboxToolClassification interface for type FileSearchToolboxTool.

func (FileSearchToolboxTool) MarshalJSON 

func (f FileSearchToolboxTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FileSearchToolboxTool.

func (*FileSearchToolboxTool) UnmarshalJSON 

func (f *FileSearchToolboxTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FileSearchToolboxTool.

type FolderDatasetVersion 

type FolderDatasetVersion struct {
	// REQUIRED; URI of the data ([example](https://go.microsoft.com/fwlink/?linkid=2202330))
	DataURI *string

	// CONSTANT; Dataset type
	// Field has constant value DatasetTypeURIFolder, any specified value is ignored.
	Type *DatasetType

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The version of the resource
	Version *string

	// The Azure Storage Account connection name. Required if startPendingUploadVersion was not called before creating the Dataset
	ConnectionName *string

	// The asset description text.
	Description *string

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// READ-ONLY; Asset ID, a unique identifier for the asset
	ID *string

	// READ-ONLY; Indicates if the dataset holds a reference to the storage, or the dataset manages storage itself. If true, the
	// underlying data will not be deleted when the dataset version is deleted
	IsReference *bool
}

FolderDatasetVersion - FileDatasetVersion Definition

func (*FolderDatasetVersion) GetDatasetVersion 

func (f *FolderDatasetVersion) GetDatasetVersion() *DatasetVersion

GetDatasetVersion implements the DatasetVersionClassification interface for type FolderDatasetVersion.

func (FolderDatasetVersion) MarshalJSON 

func (f FolderDatasetVersion) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FolderDatasetVersion.

func (*FolderDatasetVersion) UnmarshalJSON 

func (f *FolderDatasetVersion) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FolderDatasetVersion.

type FunctionShellToolParam 

type FunctionShellToolParam struct {
	// CONSTANT; The type of the shell tool. Always `shell`.
	// Field has constant value ToolTypeShell, any specified value is ignored.
	Type *ToolType

	// Deprecated. This property is deprecated and will be removed in a future version.
	Description *string
	Environment FunctionShellToolParamEnvironmentClassification

	// Deprecated. This property is deprecated and will be removed in a future version.
	Name *string

	// Deprecated. This property is deprecated and will be removed in a future version.
	ToolConfigs map[string]*ToolConfig
}

FunctionShellToolParam - Shell tool

A tool that allows the model to execute shell commands.

func (*FunctionShellToolParam) GetTool 

func (f *FunctionShellToolParam) GetTool() *Tool

GetTool implements the ToolClassification interface for type FunctionShellToolParam.

func (FunctionShellToolParam) MarshalJSON 

func (f FunctionShellToolParam) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FunctionShellToolParam.

func (*FunctionShellToolParam) UnmarshalJSON 

func (f *FunctionShellToolParam) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FunctionShellToolParam.

type FunctionShellToolParamEnvironment 

type FunctionShellToolParamEnvironment struct {
	// REQUIRED
	Type *FunctionShellToolParamEnvironmentType
}

func (*FunctionShellToolParamEnvironment) GetFunctionShellToolParamEnvironment 

func (f *FunctionShellToolParamEnvironment) GetFunctionShellToolParamEnvironment() *FunctionShellToolParamEnvironment

GetFunctionShellToolParamEnvironment implements the FunctionShellToolParamEnvironmentClassification interface for type FunctionShellToolParamEnvironment.

func (FunctionShellToolParamEnvironment) MarshalJSON 

func (f FunctionShellToolParamEnvironment) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FunctionShellToolParamEnvironment.

func (*FunctionShellToolParamEnvironment) UnmarshalJSON 

func (f *FunctionShellToolParamEnvironment) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FunctionShellToolParamEnvironment.

type FunctionShellToolParamEnvironmentClassification 

type FunctionShellToolParamEnvironmentClassification interface {
	// GetFunctionShellToolParamEnvironment returns the FunctionShellToolParamEnvironment content of the underlying type.
	GetFunctionShellToolParamEnvironment() *FunctionShellToolParamEnvironment
}

FunctionShellToolParamEnvironmentClassification provides polymorphic access to related types. Call the interface's GetFunctionShellToolParamEnvironment() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *ContainerAutoParam, *FunctionShellToolParamEnvironment, *FunctionShellToolParamEnvironmentContainerReferenceParam, *FunctionShellToolParamEnvironmentLocalEnvironmentParam

type FunctionShellToolParamEnvironmentContainerReferenceParam 

type FunctionShellToolParamEnvironmentContainerReferenceParam struct {
	// REQUIRED; The ID of the referenced container.
	ContainerID *string

	// CONSTANT; References a container created with the /v1/containers endpoint
	// Field has constant value FunctionShellToolParamEnvironmentTypeContainerReference, any specified value is ignored.
	Type *FunctionShellToolParamEnvironmentType
}

func (*FunctionShellToolParamEnvironmentContainerReferenceParam) GetFunctionShellToolParamEnvironment 

func (f *FunctionShellToolParamEnvironmentContainerReferenceParam) GetFunctionShellToolParamEnvironment() *FunctionShellToolParamEnvironment

GetFunctionShellToolParamEnvironment implements the FunctionShellToolParamEnvironmentClassification interface for type FunctionShellToolParamEnvironmentContainerReferenceParam.

func (FunctionShellToolParamEnvironmentContainerReferenceParam) MarshalJSON 

func (f FunctionShellToolParamEnvironmentContainerReferenceParam) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FunctionShellToolParamEnvironmentContainerReferenceParam.

func (*FunctionShellToolParamEnvironmentContainerReferenceParam) UnmarshalJSON 

func (f *FunctionShellToolParamEnvironmentContainerReferenceParam) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FunctionShellToolParamEnvironmentContainerReferenceParam.

type FunctionShellToolParamEnvironmentLocalEnvironmentParam 

type FunctionShellToolParamEnvironmentLocalEnvironmentParam struct {
	// CONSTANT; Use a local computer environment.
	// Field has constant value FunctionShellToolParamEnvironmentTypeLocal, any specified value is ignored.
	Type *FunctionShellToolParamEnvironmentType

	// An optional list of skills.
	Skills []LocalSkillParam
}

func (*FunctionShellToolParamEnvironmentLocalEnvironmentParam) GetFunctionShellToolParamEnvironment 

func (f *FunctionShellToolParamEnvironmentLocalEnvironmentParam) GetFunctionShellToolParamEnvironment() *FunctionShellToolParamEnvironment

GetFunctionShellToolParamEnvironment implements the FunctionShellToolParamEnvironmentClassification interface for type FunctionShellToolParamEnvironmentLocalEnvironmentParam.

func (FunctionShellToolParamEnvironmentLocalEnvironmentParam) MarshalJSON 

func (f FunctionShellToolParamEnvironmentLocalEnvironmentParam) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FunctionShellToolParamEnvironmentLocalEnvironmentParam.

func (*FunctionShellToolParamEnvironmentLocalEnvironmentParam) UnmarshalJSON 

func (f *FunctionShellToolParamEnvironmentLocalEnvironmentParam) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FunctionShellToolParamEnvironmentLocalEnvironmentParam.

type FunctionShellToolParamEnvironmentType 

type FunctionShellToolParamEnvironmentType string
const (
	FunctionShellToolParamEnvironmentTypeContainerAuto      FunctionShellToolParamEnvironmentType = "container_auto"
	FunctionShellToolParamEnvironmentTypeContainerReference FunctionShellToolParamEnvironmentType = "container_reference"
	FunctionShellToolParamEnvironmentTypeLocal              FunctionShellToolParamEnvironmentType = "local"
)

func PossibleFunctionShellToolParamEnvironmentTypeValues 

func PossibleFunctionShellToolParamEnvironmentTypeValues() []FunctionShellToolParamEnvironmentType

PossibleFunctionShellToolParamEnvironmentTypeValues returns the possible values for the FunctionShellToolParamEnvironmentType const type.

type FunctionTool 

type FunctionTool struct {
	// REQUIRED; The name of the function to call.
	Name *string

	// REQUIRED
	Parameters map[string]any

	// REQUIRED
	Strict *bool

	// CONSTANT; The type of the function tool. Always `function`.
	// Field has constant value ToolTypeFunction, any specified value is ignored.
	Type *ToolType

	// Whether this function is deferred and loaded via tool search.
	DeferLoading *bool
	Description  *string
}

FunctionTool - Function

Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).

func (*FunctionTool) GetTool 

func (f *FunctionTool) GetTool() *Tool

GetTool implements the ToolClassification interface for type FunctionTool.

func (FunctionTool) MarshalJSON 

func (f FunctionTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FunctionTool.

func (*FunctionTool) UnmarshalJSON 

func (f *FunctionTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FunctionTool.

type GrammarSyntax1 

type GrammarSyntax1 string
const (
	GrammarSyntax1Lark  GrammarSyntax1 = "lark"
	GrammarSyntax1Regex GrammarSyntax1 = "regex"
)

func PossibleGrammarSyntax1Values 

func PossibleGrammarSyntax1Values() []GrammarSyntax1

PossibleGrammarSyntax1Values returns the possible values for the GrammarSyntax1 const type.

type HourlyRecurrenceSchedule 

type HourlyRecurrenceSchedule struct {
	// CONSTANT; Field has constant value RecurrenceTypeHourly, any specified value is ignored.
	Type *RecurrenceType
}

HourlyRecurrenceSchedule - Hourly recurrence schedule.

func (*HourlyRecurrenceSchedule) GetRecurrenceSchedule 

func (h *HourlyRecurrenceSchedule) GetRecurrenceSchedule() *RecurrenceSchedule

GetRecurrenceSchedule implements the RecurrenceScheduleClassification interface for type HourlyRecurrenceSchedule.

func (HourlyRecurrenceSchedule) MarshalJSON 

func (h HourlyRecurrenceSchedule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HourlyRecurrenceSchedule.

func (*HourlyRecurrenceSchedule) UnmarshalJSON 

func (h *HourlyRecurrenceSchedule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HourlyRecurrenceSchedule.

type HumanEvaluationPreviewRuleAction 

type HumanEvaluationPreviewRuleAction struct {
	// REQUIRED; Human evaluation template Id.
	TemplateID *string

	// CONSTANT; Field has constant value EvaluationRuleActionTypeHumanEvaluationPreview, any specified value is ignored.
	Type *EvaluationRuleActionType
}

HumanEvaluationPreviewRuleAction - Evaluation rule action for human evaluation.

func (*HumanEvaluationPreviewRuleAction) GetEvaluationRuleAction 

func (h *HumanEvaluationPreviewRuleAction) GetEvaluationRuleAction() *EvaluationRuleAction

GetEvaluationRuleAction implements the EvaluationRuleActionClassification interface for type HumanEvaluationPreviewRuleAction.

func (HumanEvaluationPreviewRuleAction) MarshalJSON 

func (h HumanEvaluationPreviewRuleAction) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HumanEvaluationPreviewRuleAction.

func (*HumanEvaluationPreviewRuleAction) UnmarshalJSON 

func (h *HumanEvaluationPreviewRuleAction) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HumanEvaluationPreviewRuleAction.

type HybridSearchOptions 

type HybridSearchOptions struct {
	// REQUIRED; The weight of the embedding in the reciprocal ranking fusion.
	EmbeddingWeight *float64

	// REQUIRED; The weight of the text in the reciprocal ranking fusion.
	TextWeight *float64
}

func (HybridSearchOptions) MarshalJSON 

func (h HybridSearchOptions) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HybridSearchOptions.

func (*HybridSearchOptions) UnmarshalJSON 

func (h *HybridSearchOptions) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HybridSearchOptions.

type ImageGenActionEnum 

type ImageGenActionEnum string
const (
	ImageGenActionEnumAuto     ImageGenActionEnum = "auto"
	ImageGenActionEnumEdit     ImageGenActionEnum = "edit"
	ImageGenActionEnumGenerate ImageGenActionEnum = "generate"
)

func PossibleImageGenActionEnumValues 

func PossibleImageGenActionEnumValues() []ImageGenActionEnum

PossibleImageGenActionEnumValues returns the possible values for the ImageGenActionEnum const type.

type ImageGenTool 

type ImageGenTool struct {
	// CONSTANT; The type of the image generation tool. Always `image_generation`.
	// Field has constant value ToolTypeImageGeneration, any specified value is ignored.
	Type *ToolType

	// Whether to generate a new image or edit an existing image. Default: `auto`.
	Action *ImageGenActionEnum

	// Background type for the generated image. One of `transparent`,
	// `opaque`, or `auto`. Default: `auto`.
	Background *ImageGenToolBackground

	// Deprecated. This property is deprecated and will be removed in a future version.
	Description   *string
	InputFidelity *InputFidelity

	// Optional mask for inpainting. Contains `image_url`
	// (string, optional) and `file_id` (string, optional).
	InputImageMask *ImageGenToolInputImageMask
	Model          *ImageGenToolModel

	// Moderation level for the generated image. Default: `auto`.
	Moderation *ImageGenToolModeration

	// Deprecated. This property is deprecated and will be removed in a future version.
	Name *string

	// Compression level for the output image. Default: 100.
	OutputCompression *int64

	// The output format of the generated image. One of `png`, `webp`, or
	// `jpeg`. Default: `png`.
	OutputFormat *ImageGenToolOutputFormat

	// Number of partial images to generate in streaming mode, from 0 (default value) to 3.
	PartialImages *int64

	// The quality of the generated image. One of `low`, `medium`, `high`,
	// or `auto`. Default: `auto`.
	Quality *ImageGenToolQuality

	// The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as
	// `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect
	// ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution
	// is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`,
	// `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic
	// sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`,
	// or `1024x1792`.
	Size *ImageGenToolSize

	// Deprecated. This property is deprecated and will be removed in a future version.
	ToolConfigs map[string]*ToolConfig
}

ImageGenTool - Image generation tool

A tool that generates images using the GPT image models.

func (*ImageGenTool) GetTool 

func (i *ImageGenTool) GetTool() *Tool

GetTool implements the ToolClassification interface for type ImageGenTool.

func (ImageGenTool) MarshalJSON 

func (i ImageGenTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ImageGenTool.

func (*ImageGenTool) UnmarshalJSON 

func (i *ImageGenTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ImageGenTool.

type ImageGenToolBackground 

type ImageGenToolBackground string
const (
	ImageGenToolBackgroundAuto        ImageGenToolBackground = "auto"
	ImageGenToolBackgroundOpaque      ImageGenToolBackground = "opaque"
	ImageGenToolBackgroundTransparent ImageGenToolBackground = "transparent"
)

func PossibleImageGenToolBackgroundValues 

func PossibleImageGenToolBackgroundValues() []ImageGenToolBackground

PossibleImageGenToolBackgroundValues returns the possible values for the ImageGenToolBackground const type.

type ImageGenToolInputImageMask 

type ImageGenToolInputImageMask struct {
	FileID   *string
	ImageURL *string
}

func (ImageGenToolInputImageMask) MarshalJSON 

func (i ImageGenToolInputImageMask) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ImageGenToolInputImageMask.

func (*ImageGenToolInputImageMask) UnmarshalJSON 

func (i *ImageGenToolInputImageMask) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ImageGenToolInputImageMask.

type ImageGenToolModel 

type ImageGenToolModel string
const (
	ImageGenToolModelGptImage1     ImageGenToolModel = "gpt-image-1"
	ImageGenToolModelGptImage15    ImageGenToolModel = "gpt-image-1.5"
	ImageGenToolModelGptImage1Mini ImageGenToolModel = "gpt-image-1-mini"
)

func PossibleImageGenToolModelValues 

func PossibleImageGenToolModelValues() []ImageGenToolModel

PossibleImageGenToolModelValues returns the possible values for the ImageGenToolModel const type.

type ImageGenToolModeration 

type ImageGenToolModeration string
const (
	ImageGenToolModerationAuto ImageGenToolModeration = "auto"
	ImageGenToolModerationLow  ImageGenToolModeration = "low"
)

func PossibleImageGenToolModerationValues 

func PossibleImageGenToolModerationValues() []ImageGenToolModeration

PossibleImageGenToolModerationValues returns the possible values for the ImageGenToolModeration const type.

type ImageGenToolOutputFormat 

type ImageGenToolOutputFormat string
const (
	ImageGenToolOutputFormatJPEG ImageGenToolOutputFormat = "jpeg"
	ImageGenToolOutputFormatPNG  ImageGenToolOutputFormat = "png"
	ImageGenToolOutputFormatWebp ImageGenToolOutputFormat = "webp"
)

func PossibleImageGenToolOutputFormatValues 

func PossibleImageGenToolOutputFormatValues() []ImageGenToolOutputFormat

PossibleImageGenToolOutputFormatValues returns the possible values for the ImageGenToolOutputFormat const type.

type ImageGenToolQuality 

type ImageGenToolQuality string
const (
	ImageGenToolQualityAuto   ImageGenToolQuality = "auto"
	ImageGenToolQualityHigh   ImageGenToolQuality = "high"
	ImageGenToolQualityLow    ImageGenToolQuality = "low"
	ImageGenToolQualityMedium ImageGenToolQuality = "medium"
)

func PossibleImageGenToolQualityValues 

func PossibleImageGenToolQualityValues() []ImageGenToolQuality

PossibleImageGenToolQualityValues returns the possible values for the ImageGenToolQuality const type.

type ImageGenToolSize 

type ImageGenToolSize string
const (
	ImageGenToolSize1024X1024 ImageGenToolSize = "1024x1024"
	ImageGenToolSize1024X1536 ImageGenToolSize = "1024x1536"
	ImageGenToolSize1536X1024 ImageGenToolSize = "1536x1024"
	ImageGenToolSizeAuto      ImageGenToolSize = "auto"
)

func PossibleImageGenToolSizeValues 

func PossibleImageGenToolSizeValues() []ImageGenToolSize

PossibleImageGenToolSizeValues returns the possible values for the ImageGenToolSize const type.

type Index 

type Index struct {
	// REQUIRED; Type of index
	Type *IndexType

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The version of the resource
	Version *string

	// The asset description text.
	Description *string

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// READ-ONLY; Asset ID, a unique identifier for the asset
	ID *string
}

Index resource Definition

func (*Index) GetIndex 

func (i *Index) GetIndex() *Index

GetIndex implements the IndexClassification interface for type Index.

func (Index) MarshalJSON 

func (i Index) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Index.

func (*Index) UnmarshalJSON 

func (i *Index) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Index.

type IndexClassification 

type IndexClassification interface {
	// GetIndex returns the Index content of the underlying type.
	GetIndex() *Index
}

IndexClassification provides polymorphic access to related types. Call the interface's GetIndex() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AzureAISearchIndex, *CosmosDBIndex, *Index, *ManagedAzureAISearchIndex

type IndexType 

type IndexType string
const (
	// IndexTypeAzureSearch - Azure search
	IndexTypeAzureSearch IndexType = "AzureSearch"
	// IndexTypeCosmosDB - CosmosDB
	IndexTypeCosmosDB IndexType = "CosmosDBNoSqlVectorStore"
	// IndexTypeManagedAzureSearch - Managed Azure Search
	IndexTypeManagedAzureSearch IndexType = "ManagedAzureSearch"
)

func PossibleIndexTypeValues 

func PossibleIndexTypeValues() []IndexType

PossibleIndexTypeValues returns the possible values for the IndexType const type.

type IndexesClient 

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

IndexesClient contains the methods for the Indexes group. Don't use this type directly, use Client.NewIndexesClient instead.

Generated from API version v1

func (*IndexesClient) CreateOrUpdateVersion 

func (client *IndexesClient) CreateOrUpdateVersion(ctx context.Context, name string, indexParam IndexClassification, version string, options *IndexesClientCreateOrUpdateVersionOptions) (IndexesClientCreateOrUpdateVersionResponse, error)

CreateOrUpdateVersion - Create or update a version

Create a new or update an existing Index with the given version id If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the resource
  • indexParam - The Index to create or update.
  • version - The specific version id of the Index to create or update.
  • options - IndexesClientCreateOrUpdateVersionOptions contains the optional parameters for the IndexesClient.CreateOrUpdateVersion method.

func (*IndexesClient) DeleteVersion 

func (client *IndexesClient) DeleteVersion(ctx context.Context, name string, version string, options *IndexesClientDeleteVersionOptions) (IndexesClientDeleteVersionResponse, error)

DeleteVersion - Delete a version

Delete the specific version of the Index. The service returns 204 No Content if the Index was deleted successfully or if the Index does not exist. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the resource
  • version - The version of the Index to delete.
  • options - IndexesClientDeleteVersionOptions contains the optional parameters for the IndexesClient.DeleteVersion method.

func (*IndexesClient) GetVersion 

func (client *IndexesClient) GetVersion(ctx context.Context, name string, version string, options *IndexesClientGetVersionOptions) (IndexesClientGetVersionResponse, error)

GetVersion - Get a version

Get the specific version of the Index. The service returns 404 Not Found error if the Index does not exist. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the resource
  • version - The specific version id of the Index to retrieve.
  • options - IndexesClientGetVersionOptions contains the optional parameters for the IndexesClient.GetVersion method.

func (*IndexesClient) NewListLatestPager 

func (client *IndexesClient) NewListLatestPager(options *IndexesClientListLatestOptions) *runtime.Pager[IndexesClientListLatestResponse]

NewListLatestPager - List latest versions

List the latest version of each Index

  • options - IndexesClientListLatestOptions contains the optional parameters for the IndexesClient.NewListLatestPager method.

func (*IndexesClient) NewListVersionsPager 

func (client *IndexesClient) NewListVersionsPager(name string, options *IndexesClientListVersionsOptions) *runtime.Pager[IndexesClientListVersionsResponse]

NewListVersionsPager - List versions

List all versions of the given Index

  • name - The name of the resource
  • options - IndexesClientListVersionsOptions contains the optional parameters for the IndexesClient.NewListVersionsPager method.

type IndexesClientCreateOrUpdateVersionOptions 

type IndexesClientCreateOrUpdateVersionOptions struct {
}

IndexesClientCreateOrUpdateVersionOptions contains the optional parameters for the IndexesClient.CreateOrUpdateVersion method.

type IndexesClientCreateOrUpdateVersionResponse 

type IndexesClientCreateOrUpdateVersionResponse struct {
	// Index resource Definition
	IndexClassification
}

IndexesClientCreateOrUpdateVersionResponse contains the response from method IndexesClient.CreateOrUpdateVersion.

func (*IndexesClientCreateOrUpdateVersionResponse) UnmarshalJSON 

func (i *IndexesClientCreateOrUpdateVersionResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IndexesClientCreateOrUpdateVersionResponse.

type IndexesClientDeleteVersionOptions 

type IndexesClientDeleteVersionOptions struct {
}

IndexesClientDeleteVersionOptions contains the optional parameters for the IndexesClient.DeleteVersion method.

type IndexesClientDeleteVersionResponse 

type IndexesClientDeleteVersionResponse struct {
}

IndexesClientDeleteVersionResponse contains the response from method IndexesClient.DeleteVersion.

type IndexesClientGetVersionOptions 

type IndexesClientGetVersionOptions struct {
}

IndexesClientGetVersionOptions contains the optional parameters for the IndexesClient.GetVersion method.

type IndexesClientGetVersionResponse 

type IndexesClientGetVersionResponse struct {
	// Index resource Definition
	IndexClassification
}

IndexesClientGetVersionResponse contains the response from method IndexesClient.GetVersion.

func (*IndexesClientGetVersionResponse) UnmarshalJSON 

func (i *IndexesClientGetVersionResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IndexesClientGetVersionResponse.

type IndexesClientListLatestOptions 

type IndexesClientListLatestOptions struct {
}

IndexesClientListLatestOptions contains the optional parameters for the IndexesClient.NewListLatestPager method.

type IndexesClientListLatestResponse 

type IndexesClientListLatestResponse struct {
	// Paged collection of Index items
	PagedIndex
}

IndexesClientListLatestResponse contains the response from method IndexesClient.NewListLatestPager.

type IndexesClientListVersionsOptions 

type IndexesClientListVersionsOptions struct {
}

IndexesClientListVersionsOptions contains the optional parameters for the IndexesClient.NewListVersionsPager method.

type IndexesClientListVersionsResponse 

type IndexesClientListVersionsResponse struct {
	// Paged collection of Index items
	PagedIndex
}

IndexesClientListVersionsResponse contains the response from method IndexesClient.NewListVersionsPager.

type InlineSkillParam 

type InlineSkillParam struct {
	// REQUIRED; The description of the skill.
	Description *string

	// REQUIRED; The name of the skill.
	Name *string

	// REQUIRED; Inline skill payload
	Source *InlineSkillSourceParam

	// CONSTANT; Defines an inline skill for this request.
	// Field has constant value ContainerSkillTypeInline, any specified value is ignored.
	Type *ContainerSkillType
}

func (*InlineSkillParam) GetContainerSkill 

func (i *InlineSkillParam) GetContainerSkill() *ContainerSkill

GetContainerSkill implements the ContainerSkillClassification interface for type InlineSkillParam.

func (InlineSkillParam) MarshalJSON 

func (i InlineSkillParam) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InlineSkillParam.

func (*InlineSkillParam) UnmarshalJSON 

func (i *InlineSkillParam) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InlineSkillParam.

type InlineSkillSourceParam 

type InlineSkillSourceParam struct {
	// REQUIRED; Base64-encoded skill zip bundle.
	Data *string

	// CONSTANT; The media type of the inline skill payload. Must be `application/zip`.
	// Field has constant value "application/zip", any specified value is ignored.
	MediaType *string

	// CONSTANT; The type of the inline skill source. Must be `base64`.
	// Field has constant value "base64", any specified value is ignored.
	Type *string
}

InlineSkillSourceParam - Inline skill payload

func (InlineSkillSourceParam) MarshalJSON 

func (i InlineSkillSourceParam) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InlineSkillSourceParam.

func (*InlineSkillSourceParam) UnmarshalJSON 

func (i *InlineSkillSourceParam) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InlineSkillSourceParam.

type InputFidelity 

type InputFidelity string

InputFidelity - Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for `gpt-image-1` and `gpt-image-1.5` and later models, unsupported for `gpt-image-1-mini`. Supports `high` and `low`. Defaults to `low`. 

const (
	InputFidelityHigh InputFidelity = "high"
	InputFidelityLow  InputFidelity = "low"
)

func PossibleInputFidelityValues 

func PossibleInputFidelityValues() []InputFidelity

PossibleInputFidelityValues returns the possible values for the InputFidelity const type.

type Insight 

type Insight struct {
	// REQUIRED; User friendly display name for the insight.
	DisplayName *string

	// REQUIRED; Request for the insights analysis.
	Request InsightRequestClassification

	// READ-ONLY; The unique identifier for the insights report.
	ID *string

	// READ-ONLY; Metadata about the insights report.
	Metadata *InsightsMetadata

	// READ-ONLY; The current state of the insights.
	State *OperationState

	// READ-ONLY; The result of the insights report.
	Result InsightResultClassification
}

Insight - The response body for cluster insights.

func (Insight) MarshalJSON 

func (i Insight) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Insight.

func (*Insight) UnmarshalJSON 

func (i *Insight) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Insight.

type InsightCluster 

type InsightCluster struct {
	// REQUIRED; Description of the analysis cluster.
	Description *string

	// REQUIRED; The id of the analysis cluster.
	ID *string

	// REQUIRED; Label for the cluster
	Label *string

	// REQUIRED; Suggestion for the cluster
	Suggestion *string

	// REQUIRED; The title of the suggestion for the cluster
	SuggestionTitle *string

	// REQUIRED; The weight of the analysis cluster. This indicate number of samples in the cluster.
	Weight *int32

	// List of samples that belong to this cluster. Empty if samples are part of subclusters.
	Samples []InsightSampleClassification

	// List of subclusters within this cluster. Empty if no subclusters exist.
	SubClusters []InsightCluster
}

InsightCluster - A cluster of analysis samples.

func (InsightCluster) MarshalJSON 

func (i InsightCluster) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InsightCluster.

func (*InsightCluster) UnmarshalJSON 

func (i *InsightCluster) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InsightCluster.

type InsightModelConfiguration 

type InsightModelConfiguration struct {
	// REQUIRED; The model deployment to be evaluated. Accepts either the deployment name alone or with the connection name as
	// '{connectionName}/<modelDeploymentName>'.
	ModelDeploymentName *string
}

InsightModelConfiguration - Configuration of the model used in the insight generation.

func (InsightModelConfiguration) MarshalJSON 

func (i InsightModelConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InsightModelConfiguration.

func (*InsightModelConfiguration) UnmarshalJSON 

func (i *InsightModelConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InsightModelConfiguration.

type InsightRequest 

type InsightRequest struct {
	// REQUIRED; The type of request.
	Type *InsightType
}

InsightRequest - The request of the insights report.

func (*InsightRequest) GetInsightRequest 

func (i *InsightRequest) GetInsightRequest() *InsightRequest

GetInsightRequest implements the InsightRequestClassification interface for type InsightRequest.

func (InsightRequest) MarshalJSON 

func (i InsightRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InsightRequest.

func (*InsightRequest) UnmarshalJSON 

func (i *InsightRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InsightRequest.

type InsightRequestClassification 

type InsightRequestClassification interface {
	// GetInsightRequest returns the InsightRequest content of the underlying type.
	GetInsightRequest() *InsightRequest
}

InsightRequestClassification provides polymorphic access to related types. Call the interface's GetInsightRequest() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AgentClusterInsightRequest, *EvaluationComparisonInsightRequest, *EvaluationRunClusterInsightRequest, *InsightRequest

type InsightResult 

type InsightResult struct {
	// REQUIRED; The type of insights result.
	Type *InsightType
}

InsightResult - The result of the insights.

func (*InsightResult) GetInsightResult 

func (i *InsightResult) GetInsightResult() *InsightResult

GetInsightResult implements the InsightResultClassification interface for type InsightResult.

func (InsightResult) MarshalJSON 

func (i InsightResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InsightResult.

func (*InsightResult) UnmarshalJSON 

func (i *InsightResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InsightResult.

type InsightResultClassification 

type InsightResultClassification interface {
	// GetInsightResult returns the InsightResult content of the underlying type.
	GetInsightResult() *InsightResult
}

InsightResultClassification provides polymorphic access to related types. Call the interface's GetInsightResult() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AgentClusterInsightResult, *EvaluationComparisonInsightResult, *EvaluationRunClusterInsightResult, *InsightResult

type InsightSample 

type InsightSample struct {
	// REQUIRED; Info about the correlation for the analysis sample.
	CorrelationInfo map[string]any

	// REQUIRED; Features to help with additional filtering of data in UX.
	Features map[string]any

	// REQUIRED; The unique identifier for the analysis sample.
	ID *string

	// REQUIRED; Sample type
	Type *SampleType
}

InsightSample - A sample from the analysis.

func (*InsightSample) GetInsightSample 

func (i *InsightSample) GetInsightSample() *InsightSample

GetInsightSample implements the InsightSampleClassification interface for type InsightSample.

func (InsightSample) MarshalJSON 

func (i InsightSample) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InsightSample.

func (*InsightSample) UnmarshalJSON 

func (i *InsightSample) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InsightSample.

type InsightSampleClassification 

type InsightSampleClassification interface {
	// GetInsightSample returns the InsightSample content of the underlying type.
	GetInsightSample() *InsightSample
}

InsightSampleClassification provides polymorphic access to related types. Call the interface's GetInsightSample() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *EvaluationResultSample, *InsightSample

type InsightScheduleTask 

type InsightScheduleTask struct {
	// REQUIRED; The insight payload.
	Insight *Insight

	// CONSTANT; Field has constant value ScheduleTaskTypeInsight, any specified value is ignored.
	Type *ScheduleTaskType

	// Configuration for the task.
	Configuration map[string]*string
}

InsightScheduleTask - Insight task for the schedule.

func (*InsightScheduleTask) GetScheduleTask 

func (i *InsightScheduleTask) GetScheduleTask() *ScheduleTask

GetScheduleTask implements the ScheduleTaskClassification interface for type InsightScheduleTask.

func (InsightScheduleTask) MarshalJSON 

func (i InsightScheduleTask) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InsightScheduleTask.

func (*InsightScheduleTask) UnmarshalJSON 

func (i *InsightScheduleTask) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InsightScheduleTask.

type InsightSummary 

type InsightSummary struct {
	// REQUIRED; Method used for clustering.
	Method *string

	// REQUIRED; Total number of samples analyzed.
	SampleCount *int32

	// REQUIRED; Total number of unique clusters.
	UniqueClusterCount *int32

	// REQUIRED; Total number of unique subcluster labels.
	UniqueSubclusterCount *int32

	// REQUIRED; Token usage while performing clustering analysis
	Usage *ClusterTokenUsage
}

InsightSummary - Summary of the error cluster analysis.

func (InsightSummary) MarshalJSON 

func (i InsightSummary) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InsightSummary.

func (*InsightSummary) UnmarshalJSON 

func (i *InsightSummary) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InsightSummary.

type InsightType 

type InsightType string

InsightType - The request of the insights. 

const (
	// InsightTypeAgentClusterInsight - Cluster Insight on an Agent.
	InsightTypeAgentClusterInsight InsightType = "AgentClusterInsight"
	// InsightTypeEvaluationComparison - Evaluation Comparison.
	InsightTypeEvaluationComparison InsightType = "EvaluationComparison"
	// InsightTypeEvaluationRunClusterInsight - Insights on an Evaluation run result.
	InsightTypeEvaluationRunClusterInsight InsightType = "EvaluationRunClusterInsight"
)

func PossibleInsightTypeValues 

func PossibleInsightTypeValues() []InsightType

PossibleInsightTypeValues returns the possible values for the InsightType const type.

type InsightsClient 

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

InsightsClient contains the methods for the Insights group. Don't use this type directly, use Client.NewInsightsClient instead.

Generated from API version v1

func (*InsightsClient) Generate 

func (client *InsightsClient) Generate(ctx context.Context, insight Insight, options *InsightsClientGenerateOptions) (InsightsClientGenerateResponse, error)

Generate - Generate insights

Generates an insights report from the provided evaluation configuration. If the operation fails it returns an *azcore.ResponseError type.

  • insight - Complete evaluation configuration including data source, evaluators, and result settings
  • options - InsightsClientGenerateOptions contains the optional parameters for the InsightsClient.Generate method.

func (*InsightsClient) Get 

func (client *InsightsClient) Get(ctx context.Context, id string, options *InsightsClientGetOptions) (InsightsClientGetResponse, error)

Get - Get an insight

Retrieves the specified insight report and its results. If the operation fails it returns an *azcore.ResponseError type.

  • id - The unique identifier for the insights report.
  • options - InsightsClientGetOptions contains the optional parameters for the InsightsClient.Get method.

func (*InsightsClient) NewListPager 

func (client *InsightsClient) NewListPager(options *InsightsClientListOptions) *runtime.Pager[InsightsClientListResponse]

NewListPager - List insights

Returns insights in reverse chronological order, with the most recent entries first.

  • options - InsightsClientListOptions contains the optional parameters for the InsightsClient.NewListPager method.

type InsightsClientGenerateOptions 

type InsightsClientGenerateOptions struct {
	// A feature flag opt-in required when using preview operations or modifying persisted preview resources.
	FoundryFeatures *string

	// Timestamp indicating when this request was first initiated. Used in conjunction with repeatability-request-id for idempotency
	// control.
	RepeatabilityFirstSent *time.Time

	// Unique, client-generated identifier for ensuring request idempotency. Use the same ID for retries to prevent duplicate
	// evaluations.
	RepeatabilityRequestID *string
}

InsightsClientGenerateOptions contains the optional parameters for the InsightsClient.Generate method.

type InsightsClientGenerateResponse 

type InsightsClientGenerateResponse struct {
	// The response body for cluster insights.
	Insight
}

InsightsClientGenerateResponse contains the response from method InsightsClient.Generate.

type InsightsClientGetOptions 

type InsightsClientGetOptions struct {
	// A feature flag opt-in required when using preview operations or modifying persisted preview resources.
	FoundryFeatures *string

	// Whether to include coordinates for visualization in the response. Defaults to false.
	IncludeCoordinates *bool
}

InsightsClientGetOptions contains the optional parameters for the InsightsClient.Get method.

type InsightsClientGetResponse 

type InsightsClientGetResponse struct {
	// The response body for cluster insights.
	Insight
}

InsightsClientGetResponse contains the response from method InsightsClient.Get.

type InsightsClientListOptions 

type InsightsClientListOptions struct {
	// Filter by the agent name.
	AgentName *string

	// Filter by the evaluation ID.
	EvalID *string

	// A feature flag opt-in required when using preview operations or modifying persisted preview resources.
	FoundryFeatures *string

	// Whether to include coordinates for visualization in the response. Defaults to false.
	IncludeCoordinates *bool

	// Filter by the evaluation run ID.
	RunID *string

	// Filter by the type of analysis.
	Type *InsightType
}

InsightsClientListOptions contains the optional parameters for the InsightsClient.NewListPager method.

type InsightsClientListResponse 

type InsightsClientListResponse struct {
	// Paged collection of Insight items
	PagedInsight
}

InsightsClientListResponse contains the response from method InsightsClient.NewListPager.

type InsightsMetadata 

type InsightsMetadata struct {
	// REQUIRED; The timestamp when the insights were created.
	CreatedAt *time.Time

	// The timestamp when the insights were completed.
	CompletedAt *time.Time
}

InsightsMetadata - Metadata about the insights.

func (InsightsMetadata) MarshalJSON 

func (i InsightsMetadata) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InsightsMetadata.

func (*InsightsMetadata) UnmarshalJSON 

func (i *InsightsMetadata) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InsightsMetadata.

type JobStatus 

type JobStatus string

JobStatus - Extensible status values shared by Foundry jobs. 

const (
	// JobStatusCancelled - Job was cancelled by the caller.
	JobStatusCancelled JobStatus = "cancelled"
	// JobStatusFailed - Job failed.
	JobStatusFailed JobStatus = "failed"
	// JobStatusInProgress - Job is actively processing.
	JobStatusInProgress JobStatus = "in_progress"
	// JobStatusQueued - Job is waiting to start.
	JobStatusQueued JobStatus = "queued"
	// JobStatusSucceeded - Job completed successfully.
	JobStatusSucceeded JobStatus = "succeeded"
)

func PossibleJobStatusValues 

func PossibleJobStatusValues() []JobStatus

PossibleJobStatusValues returns the possible values for the JobStatus const type.

type ListVersionsRequestType 

type ListVersionsRequestType string
const (
	ListVersionsRequestTypeAll ListVersionsRequestType = "all"
	// ListVersionsRequestTypeBuiltIn - Built-in evaluator (Microsoft provided)
	ListVersionsRequestTypeBuiltIn ListVersionsRequestType = "builtin"
	// ListVersionsRequestTypeCustom - Custom evaluator
	ListVersionsRequestTypeCustom ListVersionsRequestType = "custom"
)

func PossibleListVersionsRequestTypeValues 

func PossibleListVersionsRequestTypeValues() []ListVersionsRequestType

PossibleListVersionsRequestTypeValues returns the possible values for the ListVersionsRequestType const type.

type LocalShellToolParam 

type LocalShellToolParam struct {
	// CONSTANT; The type of the local shell tool. Always `local_shell`.
	// Field has constant value ToolTypeLocalShell, any specified value is ignored.
	Type *ToolType

	// Deprecated. This property is deprecated and will be removed in a future version.
	Description *string

	// Deprecated. This property is deprecated and will be removed in a future version.
	Name *string

	// Deprecated. This property is deprecated and will be removed in a future version.
	ToolConfigs map[string]*ToolConfig
}

LocalShellToolParam - Local shell tool

A tool that allows the model to execute shell commands in a local environment.

func (*LocalShellToolParam) GetTool 

func (l *LocalShellToolParam) GetTool() *Tool

GetTool implements the ToolClassification interface for type LocalShellToolParam.

func (LocalShellToolParam) MarshalJSON 

func (l LocalShellToolParam) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LocalShellToolParam.

func (*LocalShellToolParam) UnmarshalJSON 

func (l *LocalShellToolParam) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LocalShellToolParam.

type LocalSkillParam 

type LocalSkillParam struct {
	// REQUIRED; The description of the skill.
	Description *string

	// REQUIRED; The name of the skill.
	Name *string

	// REQUIRED; The path to the directory containing the skill.
	Path *string
}

func (LocalSkillParam) MarshalJSON 

func (l LocalSkillParam) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LocalSkillParam.

func (*LocalSkillParam) UnmarshalJSON 

func (l *LocalSkillParam) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LocalSkillParam.

type MCPTool 

type MCPTool struct {
	// REQUIRED; A label for this MCP server, used to identify it in tool calls.
	ServerLabel *string

	// CONSTANT; The type of the MCP tool. Always `mcp`.
	// Field has constant value ToolTypeMcp, any specified value is ignored.
	Type         *ToolType
	AllowedTools any

	// An OAuth access token that can be used with a remote MCP server, either
	// with a custom MCP server URL or a service connector. Your application
	// must handle the OAuth authorization flow and provide the token here.
	Authorization *string

	// Identifier for service connectors, like those available in ChatGPT. One of
	// `server_url` or `connector_id` must be provided. Learn more about service
	// connectors [here](/docs/guides/tools-remote-mcp#connectors).
	// Currently supported `connector_id` values are:
	// - Dropbox: `connector_dropbox`
	// - Gmail: `connector_gmail`
	// - Google Calendar: `connector_googlecalendar`
	// - Google Drive: `connector_googledrive`
	// - Microsoft Teams: `connector_microsoftteams`
	// - Outlook Calendar: `connector_outlookcalendar`
	// - Outlook Email: `connector_outlookemail`
	// - SharePoint: `connector_sharepoint`
	ConnectorID *MCPToolConnectorID

	// Whether this MCP tool is deferred and discovered via tool search.
	DeferLoading *bool
	Headers      map[string]*string

	// The connection ID in the project for the MCP server. The connection stores authentication and other connection details
	// needed to connect to the MCP server.
	ProjectConnectionID *string
	RequireApproval     *string

	// Optional description of the MCP server, used to provide more context.
	ServerDescription *string

	// The URL for the MCP server. One of `server_url` or `connector_id` must be
	// provided.
	ServerURL *string

	// Deprecated. This property is deprecated and will be removed in a future version.
	ToolConfigs map[string]*ToolConfig
}

MCPTool - MCP tool

Give the model access to additional tools via remote Model Context Protocol (MCP) servers. [Learn more about MCP](/docs/guides/tools-remote-mcp).

func (*MCPTool) GetTool 

func (m *MCPTool) GetTool() *Tool

GetTool implements the ToolClassification interface for type MCPTool.

func (MCPTool) MarshalJSON 

func (m MCPTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MCPTool.

func (*MCPTool) UnmarshalJSON 

func (m *MCPTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MCPTool.

type MCPToolConnectorID 

type MCPToolConnectorID string
const (
	MCPToolConnectorIDConnectorDropbox         MCPToolConnectorID = "connector_dropbox"
	MCPToolConnectorIDConnectorGmail           MCPToolConnectorID = "connector_gmail"
	MCPToolConnectorIDConnectorGooglecalendar  MCPToolConnectorID = "connector_googlecalendar"
	MCPToolConnectorIDConnectorGoogledrive     MCPToolConnectorID = "connector_googledrive"
	MCPToolConnectorIDConnectorMicrosoftteams  MCPToolConnectorID = "connector_microsoftteams"
	MCPToolConnectorIDConnectorOutlookcalendar MCPToolConnectorID = "connector_outlookcalendar"
	MCPToolConnectorIDConnectorOutlookemail    MCPToolConnectorID = "connector_outlookemail"
	MCPToolConnectorIDConnectorSharepoint      MCPToolConnectorID = "connector_sharepoint"
)

func PossibleMCPToolConnectorIDValues 

func PossibleMCPToolConnectorIDValues() []MCPToolConnectorID

PossibleMCPToolConnectorIDValues returns the possible values for the MCPToolConnectorID const type.

type MCPToolboxTool 

type MCPToolboxTool struct {
	// REQUIRED; A label for this MCP server, used to identify it in tool calls.
	ServerLabel *string

	// CONSTANT; Field has constant value ToolboxToolTypeMcp, any specified value is ignored.
	Type         *ToolboxToolType
	AllowedTools any

	// An OAuth access token that can be used with a remote MCP server, either
	// with a custom MCP server URL or a service connector. Your application
	// must handle the OAuth authorization flow and provide the token here.
	Authorization *string

	// Identifier for service connectors, like those available in ChatGPT. One of
	// `server_url` or `connector_id` must be provided. Learn more about service
	// connectors [here](/docs/guides/tools-remote-mcp#connectors).
	// Currently supported `connector_id` values are:
	// - Dropbox: `connector_dropbox`
	// - Gmail: `connector_gmail`
	// - Google Calendar: `connector_googlecalendar`
	// - Google Drive: `connector_googledrive`
	// - Microsoft Teams: `connector_microsoftteams`
	// - Outlook Calendar: `connector_outlookcalendar`
	// - Outlook Email: `connector_outlookemail`
	// - SharePoint: `connector_sharepoint`
	ConnectorID *MCPToolConnectorID

	// Whether this MCP tool is deferred and discovered via tool search.
	DeferLoading *bool

	// Optional user-defined description for this tool or configuration.
	Description *string
	Headers     map[string]*string

	// Optional user-defined name for this tool or configuration.
	Name *string

	// The connection ID in the project for the MCP server. The connection stores authentication and other connection details
	// needed to connect to the MCP server.
	ProjectConnectionID *string
	RequireApproval     *string

	// Optional description of the MCP server, used to provide more context.
	ServerDescription *string

	// The URL for the MCP server. One of `server_url` or `connector_id` must be
	// provided.
	ServerURL *string

	// Deprecated. This property is deprecated and will be removed in a future version.
	ToolConfigs map[string]*ToolConfig
}

MCPToolboxTool - An MCP tool stored in a toolbox.

func (*MCPToolboxTool) GetToolboxTool 

func (m *MCPToolboxTool) GetToolboxTool() *ToolboxTool

GetToolboxTool implements the ToolboxToolClassification interface for type MCPToolboxTool.

func (MCPToolboxTool) MarshalJSON 

func (m MCPToolboxTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MCPToolboxTool.

func (*MCPToolboxTool) UnmarshalJSON 

func (m *MCPToolboxTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MCPToolboxTool.

type ManagedAzureAISearchIndex 

type ManagedAzureAISearchIndex struct {
	// CONSTANT; Type of index
	// Field has constant value IndexTypeManagedAzureSearch, any specified value is ignored.
	Type *IndexType

	// REQUIRED; Vector store id of managed index
	VectorStoreID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The version of the resource
	Version *string

	// The asset description text.
	Description *string

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// READ-ONLY; Asset ID, a unique identifier for the asset
	ID *string
}

ManagedAzureAISearchIndex - Managed Azure AI Search Index Definition

func (*ManagedAzureAISearchIndex) GetIndex 

func (m *ManagedAzureAISearchIndex) GetIndex() *Index

GetIndex implements the IndexClassification interface for type ManagedAzureAISearchIndex.

func (ManagedAzureAISearchIndex) MarshalJSON 

func (m ManagedAzureAISearchIndex) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedAzureAISearchIndex.

func (*ManagedAzureAISearchIndex) UnmarshalJSON 

func (m *ManagedAzureAISearchIndex) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedAzureAISearchIndex.

type MemoryItem 

type MemoryItem struct {
	// REQUIRED; The content of the memory.
	Content *string

	// REQUIRED; The kind of the memory item.
	Kind *MemoryItemKind

	// REQUIRED; The unique ID of the memory item.
	MemoryID *string

	// REQUIRED; The namespace that logically groups and isolates memories, such as a user ID.
	Scope *string

	// REQUIRED; The last update time of the memory item.
	UpdatedAt *time.Time
}

MemoryItem - A single memory item stored in the memory store, containing content and metadata.

func (*MemoryItem) GetMemoryItem 

func (m *MemoryItem) GetMemoryItem() *MemoryItem

GetMemoryItem implements the MemoryItemClassification interface for type MemoryItem.

func (MemoryItem) MarshalJSON 

func (m MemoryItem) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MemoryItem.

func (*MemoryItem) UnmarshalJSON 

func (m *MemoryItem) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MemoryItem.

type MemoryItemClassification 

type MemoryItemClassification interface {
	// GetMemoryItem returns the MemoryItem content of the underlying type.
	GetMemoryItem() *MemoryItem
}

MemoryItemClassification provides polymorphic access to related types. Call the interface's GetMemoryItem() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *ChatSummaryMemoryItem, *MemoryItem, *ProceduralMemoryItem, *UserProfileMemoryItem

type MemoryItemKind 

type MemoryItemKind string

MemoryItemKind - Memory item kind. 

const (
	// MemoryItemKindChatSummary - Summary of chat conversations.
	MemoryItemKindChatSummary MemoryItemKind = "chat_summary"
	// MemoryItemKindProcedural - Routine procedures extracted from conversations.
	MemoryItemKindProcedural MemoryItemKind = "procedural"
	// MemoryItemKindUserProfile - User profile information extracted from conversations.
	MemoryItemKindUserProfile MemoryItemKind = "user_profile"
)

func PossibleMemoryItemKindValues 

func PossibleMemoryItemKindValues() []MemoryItemKind

PossibleMemoryItemKindValues returns the possible values for the MemoryItemKind const type.

type MemoryOperation 

type MemoryOperation struct {
	// REQUIRED; The type of memory operation being performed.
	Kind *MemoryOperationKind

	// REQUIRED; The memory item to create, update, or delete.
	MemoryItem MemoryItemClassification
}

MemoryOperation - Represents a single memory operation (create, update, or delete) performed on a memory item.

func (MemoryOperation) MarshalJSON 

func (m MemoryOperation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MemoryOperation.

func (*MemoryOperation) UnmarshalJSON 

func (m *MemoryOperation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MemoryOperation.

type MemoryOperationKind 

type MemoryOperationKind string

MemoryOperationKind - Memory operation kind. 

const (
	// MemoryOperationKindCreate - Create a new memory item.
	MemoryOperationKindCreate MemoryOperationKind = "create"
	// MemoryOperationKindDelete - Delete an existing memory item.
	MemoryOperationKindDelete MemoryOperationKind = "delete"
	// MemoryOperationKindUpdate - Update an existing memory item.
	MemoryOperationKindUpdate MemoryOperationKind = "update"
)

func PossibleMemoryOperationKindValues 

func PossibleMemoryOperationKindValues() []MemoryOperationKind

PossibleMemoryOperationKindValues returns the possible values for the MemoryOperationKind const type.

type MemorySearchItem 

type MemorySearchItem struct {
	// REQUIRED; Retrieved memory item.
	MemoryItem MemoryItemClassification
}

MemorySearchItem - A retrieved memory item from memory search.

func (MemorySearchItem) MarshalJSON 

func (m MemorySearchItem) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MemorySearchItem.

func (*MemorySearchItem) UnmarshalJSON 

func (m *MemorySearchItem) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MemorySearchItem.

type MemorySearchPreviewTool 

type MemorySearchPreviewTool struct {
	// REQUIRED; The name of the memory store to use.
	MemoryStoreName *string

	// REQUIRED; The namespace used to group and isolate memories, such as a user ID.
	// Limits which memories can be retrieved or updated.
	// Use special variable `{{$userId}}` to scope memories to the current signed-in user.
	Scope *string

	// CONSTANT; The type of the tool. Always `memory_search_preview`.
	// Field has constant value ToolTypeMemorySearchPreview, any specified value is ignored.
	Type *ToolType

	// Options for searching the memory store.
	SearchOptions *MemorySearchResultOptions

	// Time to wait before updating memories after inactivity (seconds). Default 300.
	UpdateDelay *int32
}

MemorySearchPreviewTool - A tool for integrating memories into the agent.

func (*MemorySearchPreviewTool) GetTool 

func (m *MemorySearchPreviewTool) GetTool() *Tool

GetTool implements the ToolClassification interface for type MemorySearchPreviewTool.

func (MemorySearchPreviewTool) MarshalJSON 

func (m MemorySearchPreviewTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MemorySearchPreviewTool.

func (*MemorySearchPreviewTool) UnmarshalJSON 

func (m *MemorySearchPreviewTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MemorySearchPreviewTool.

type MemorySearchResultOptions 

type MemorySearchResultOptions struct {
	// Maximum number of memory items to return.
	MaxMemories *int32
}

MemorySearchResultOptions - Memory search options.

func (MemorySearchResultOptions) MarshalJSON 

func (m MemorySearchResultOptions) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MemorySearchResultOptions.

func (*MemorySearchResultOptions) UnmarshalJSON 

func (m *MemorySearchResultOptions) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MemorySearchResultOptions.

type MemoryStoreDefaultDefinition 

type MemoryStoreDefaultDefinition struct {
	// REQUIRED; The name or identifier of the chat completion model deployment used for memory processing.
	ChatModel *string

	// REQUIRED; The name or identifier of the embedding model deployment used for memory processing.
	EmbeddingModel *string

	// CONSTANT; The kind of the memory store.
	// Field has constant value MemoryStoreKindDefault, any specified value is ignored.
	Kind *MemoryStoreKind

	// Default memory store options.
	Options *MemoryStoreDefaultOptions
}

MemoryStoreDefaultDefinition - Default memory store implementation.

func (*MemoryStoreDefaultDefinition) GetMemoryStoreDefinition 

func (m *MemoryStoreDefaultDefinition) GetMemoryStoreDefinition() *MemoryStoreDefinition

GetMemoryStoreDefinition implements the MemoryStoreDefinitionClassification interface for type MemoryStoreDefaultDefinition.

func (MemoryStoreDefaultDefinition) MarshalJSON 

func (m MemoryStoreDefaultDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MemoryStoreDefaultDefinition.

func (*MemoryStoreDefaultDefinition) UnmarshalJSON 

func (m *MemoryStoreDefaultDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MemoryStoreDefaultDefinition.

type MemoryStoreDefaultOptions 

type MemoryStoreDefaultOptions struct {
	// REQUIRED; Whether to enable chat summary extraction and storage. Defaults to `true`.
	ChatSummaryEnabled *bool

	// REQUIRED; Whether to enable user profile extraction and storage. Default is true.
	UserProfileEnabled *bool

	// The default time-to-live for memories in seconds. A value of `0` indicates that memories do not expire. Defaults to `0`.
	DefaultTTLSeconds *int32

	// Whether to enable procedural memory extraction and storage. The service defaults to `true` if a value is not specified
	// by the caller.
	ProceduralMemoryEnabled *bool

	// Specific categories or types of user profile information to extract and store.
	UserProfileDetails *string
}

MemoryStoreDefaultOptions - Default memory store configurations.

func (MemoryStoreDefaultOptions) MarshalJSON 

func (m MemoryStoreDefaultOptions) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MemoryStoreDefaultOptions.

func (*MemoryStoreDefaultOptions) UnmarshalJSON 

func (m *MemoryStoreDefaultOptions) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MemoryStoreDefaultOptions.

type MemoryStoreDefinition 

type MemoryStoreDefinition struct {
	// REQUIRED; The kind of the memory store.
	Kind *MemoryStoreKind
}

MemoryStoreDefinition - Base definition for memory store configurations.

func (*MemoryStoreDefinition) GetMemoryStoreDefinition 

func (m *MemoryStoreDefinition) GetMemoryStoreDefinition() *MemoryStoreDefinition

GetMemoryStoreDefinition implements the MemoryStoreDefinitionClassification interface for type MemoryStoreDefinition.

func (MemoryStoreDefinition) MarshalJSON 

func (m MemoryStoreDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MemoryStoreDefinition.

func (*MemoryStoreDefinition) UnmarshalJSON 

func (m *MemoryStoreDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MemoryStoreDefinition.

type MemoryStoreDefinitionClassification 

type MemoryStoreDefinitionClassification interface {
	// GetMemoryStoreDefinition returns the MemoryStoreDefinition content of the underlying type.
	GetMemoryStoreDefinition() *MemoryStoreDefinition
}

MemoryStoreDefinitionClassification provides polymorphic access to related types. Call the interface's GetMemoryStoreDefinition() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *MemoryStoreDefaultDefinition, *MemoryStoreDefinition

type MemoryStoreDeleteScopeResult 

type MemoryStoreDeleteScopeResult struct {
	// REQUIRED; Whether the deletion operation was successful.
	Deleted *bool

	// REQUIRED; The name of the memory store.
	Name *string

	// REQUIRED; The object type. Always 'memory_store.scope.deleted'.
	Object *MemoryStoreObjectType

	// REQUIRED; The scope from which memories were deleted.
	Scope *string
}

MemoryStoreDeleteScopeResult - Response for deleting memories from a scope.

func (MemoryStoreDeleteScopeResult) MarshalJSON 

func (m MemoryStoreDeleteScopeResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MemoryStoreDeleteScopeResult.

func (*MemoryStoreDeleteScopeResult) UnmarshalJSON 

func (m *MemoryStoreDeleteScopeResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MemoryStoreDeleteScopeResult.

type MemoryStoreKind 

type MemoryStoreKind string

MemoryStoreKind - The type of memory store implementation to use. 

const (
	// MemoryStoreKindDefault - The default memory store implementation.
	MemoryStoreKindDefault MemoryStoreKind = "default"
)

func PossibleMemoryStoreKindValues 

func PossibleMemoryStoreKindValues() []MemoryStoreKind

PossibleMemoryStoreKindValues returns the possible values for the MemoryStoreKind const type.

type MemoryStoreObject 

type MemoryStoreObject struct {
	// REQUIRED; The Unix timestamp (seconds) when the memory store was created.
	CreatedAt *time.Time

	// REQUIRED; The definition of the memory store.
	Definition MemoryStoreDefinitionClassification

	// REQUIRED; The unique identifier of the memory store.
	ID *string

	// REQUIRED; The name of the memory store.
	Name *string

	// REQUIRED; The object type, which is always 'memory_store'.
	Object *MemoryStoreObjectType

	// REQUIRED; The Unix timestamp (seconds) when the memory store was last updated.
	UpdatedAt *time.Time

	// A human-readable description of the memory store.
	Description *string

	// Arbitrary key-value metadata to associate with the memory store.
	Metadata map[string]*string
}

MemoryStoreObject - A memory store that can store and retrieve user memories.

func (MemoryStoreObject) MarshalJSON 

func (m MemoryStoreObject) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MemoryStoreObject.

func (*MemoryStoreObject) UnmarshalJSON 

func (m *MemoryStoreObject) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MemoryStoreObject.

type MemoryStoreObjectType 

type MemoryStoreObjectType string
const (
	MemoryStoreObjectTypeMemoryDeleted           MemoryStoreObjectType = "memory_store.item.deleted"
	MemoryStoreObjectTypeMemoryStore             MemoryStoreObjectType = "memory_store"
	MemoryStoreObjectTypeMemoryStoreDeleted      MemoryStoreObjectType = "memory_store.deleted"
	MemoryStoreObjectTypeMemoryStoreScopeDeleted MemoryStoreObjectType = "memory_store.scope.deleted"
)

func PossibleMemoryStoreObjectTypeValues 

func PossibleMemoryStoreObjectTypeValues() []MemoryStoreObjectType

PossibleMemoryStoreObjectTypeValues returns the possible values for the MemoryStoreObjectType const type.

type MemoryStoreOperationUsage 

type MemoryStoreOperationUsage struct {
	// REQUIRED; The number of embedding tokens.
	EmbeddingTokens *int32

	// REQUIRED; The number of input tokens.
	InputTokens *int64

	// REQUIRED; A detailed breakdown of the input tokens.
	InputTokensDetails *ResponseUsageInputTokensDetails

	// REQUIRED; The number of output tokens.
	OutputTokens *int64

	// REQUIRED; A detailed breakdown of the output tokens.
	OutputTokensDetails *ResponseUsageOutputTokensDetails

	// REQUIRED; The total number of tokens used.
	TotalTokens *int64
}

MemoryStoreOperationUsage - Usage statistics of a memory store operation.

func (MemoryStoreOperationUsage) MarshalJSON 

func (m MemoryStoreOperationUsage) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MemoryStoreOperationUsage.

func (*MemoryStoreOperationUsage) UnmarshalJSON 

func (m *MemoryStoreOperationUsage) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MemoryStoreOperationUsage.

type MemoryStoreSearchResult 

type MemoryStoreSearchResult struct {
	// REQUIRED; Related memory items found during the search operation.
	Memories []MemorySearchItem

	// REQUIRED; The unique ID of this search request. Use this value as previous_search_id in subsequent requests to perform
	// incremental searches.
	SearchID *string

	// REQUIRED; Usage statistics associated with the memory search operation.
	Usage *MemoryStoreOperationUsage
}

MemoryStoreSearchResult - Memory search response.

func (MemoryStoreSearchResult) MarshalJSON 

func (m MemoryStoreSearchResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MemoryStoreSearchResult.

func (*MemoryStoreSearchResult) UnmarshalJSON 

func (m *MemoryStoreSearchResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MemoryStoreSearchResult.

type MemoryStoreUpdateCompletedResult 

type MemoryStoreUpdateCompletedResult struct {
	// REQUIRED; A list of individual memory operations that were performed during the update.
	MemoryOperations []MemoryOperation

	// REQUIRED; Usage statistics associated with the memory update operation.
	Usage *MemoryStoreOperationUsage
}

MemoryStoreUpdateCompletedResult - Memory update result.

func (MemoryStoreUpdateCompletedResult) MarshalJSON 

func (m MemoryStoreUpdateCompletedResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MemoryStoreUpdateCompletedResult.

func (*MemoryStoreUpdateCompletedResult) UnmarshalJSON 

func (m *MemoryStoreUpdateCompletedResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MemoryStoreUpdateCompletedResult.

type MemoryStoreUpdateResult 

type MemoryStoreUpdateResult struct {
	// REQUIRED; The status of the memory update operation. One of "queued", "in_progress", "completed", "failed", or "superseded".
	Status *MemoryStoreUpdateStatus

	// REQUIRED; The unique ID of this update request. Use this value as previous_update_id in subsequent requests to perform
	// incremental updates.
	UpdateID *string

	// Error object that describes the error when status is "failed".
	Error *Error

	// The result of memory store update operation when status is "completed".
	Result *MemoryStoreUpdateCompletedResult

	// The update_id the operation was superseded by when status is "superseded".
	SupersededBy *string
}

MemoryStoreUpdateResult - Provides the status of a memory store update operation.

func (MemoryStoreUpdateResult) MarshalJSON 

func (m MemoryStoreUpdateResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MemoryStoreUpdateResult.

func (*MemoryStoreUpdateResult) UnmarshalJSON 

func (m *MemoryStoreUpdateResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MemoryStoreUpdateResult.

type MemoryStoreUpdateStatus 

type MemoryStoreUpdateStatus string

MemoryStoreUpdateStatus - Status of a memory store update operation. 

const (
	MemoryStoreUpdateStatusCompleted  MemoryStoreUpdateStatus = "completed"
	MemoryStoreUpdateStatusFailed     MemoryStoreUpdateStatus = "failed"
	MemoryStoreUpdateStatusInProgress MemoryStoreUpdateStatus = "in_progress"
	MemoryStoreUpdateStatusQueued     MemoryStoreUpdateStatus = "queued"
	MemoryStoreUpdateStatusSuperseded MemoryStoreUpdateStatus = "superseded"
)

func PossibleMemoryStoreUpdateStatusValues 

func PossibleMemoryStoreUpdateStatusValues() []MemoryStoreUpdateStatus

PossibleMemoryStoreUpdateStatusValues returns the possible values for the MemoryStoreUpdateStatus const type.

type MemoryStoresClient 

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

MemoryStoresClient contains the methods for the MemoryStores group. Don't use this type directly, use Client.NewMemoryStoresClient instead.

Generated from API version v1

func (*MemoryStoresClient) BeginUpdateMemories 

func (client *MemoryStoresClient) BeginUpdateMemories(ctx context.Context, name string, scope string, options *MemoryStoresClientBeginUpdateMemoriesOptions) (*runtime.Poller[MemoryStoresClientUpdateMemoriesResponse], error)

BeginUpdateMemories - Update memories

Starts an update that writes conversation memories into the specified memory store. The operation returns a long-running status location for polling the update result. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the memory store to update.
  • scope - The namespace that logically groups and isolates memories, such as a user ID.
  • options - MemoryStoresClientBeginUpdateMemoriesOptions contains the optional parameters for the MemoryStoresClient.BeginUpdateMemories method.

func (*MemoryStoresClient) CreateMemory 

func (client *MemoryStoresClient) CreateMemory(ctx context.Context, name string, scope string, content string, kind MemoryItemKind, options *MemoryStoresClientCreateMemoryOptions) (MemoryStoresClientCreateMemoryResponse, error)

CreateMemory - Create a memory item

Creates a memory item in the specified memory store. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the memory store.
  • scope - The namespace that logically groups and isolates memories, such as a user ID.
  • content - The content of the memory.
  • kind - The kind of the memory item.
  • options - MemoryStoresClientCreateMemoryOptions contains the optional parameters for the MemoryStoresClient.CreateMemory method.

func (*MemoryStoresClient) CreateMemoryStore 

func (client *MemoryStoresClient) CreateMemoryStore(ctx context.Context, name string, definition MemoryStoreDefinitionClassification, options *MemoryStoresClientCreateMemoryStoreOptions) (MemoryStoresClientCreateMemoryStoreResponse, error)

CreateMemoryStore - Create a memory store

Creates a memory store resource with the provided configuration. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the memory store.
  • definition - The memory store definition.
  • options - MemoryStoresClientCreateMemoryStoreOptions contains the optional parameters for the MemoryStoresClient.CreateMemoryStore method.

func (*MemoryStoresClient) DeleteMemory 

func (client *MemoryStoresClient) DeleteMemory(ctx context.Context, name string, memoryID string, options *MemoryStoresClientDeleteMemoryOptions) (MemoryStoresClientDeleteMemoryResponse, error)

DeleteMemory - Delete a memory item

Deletes the specified memory item from the memory store. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the memory store.
  • memoryID - The ID of the memory item to delete.
  • options - MemoryStoresClientDeleteMemoryOptions contains the optional parameters for the MemoryStoresClient.DeleteMemory method.

func (*MemoryStoresClient) DeleteMemoryStore 

func (client *MemoryStoresClient) DeleteMemoryStore(ctx context.Context, name string, options *MemoryStoresClientDeleteMemoryStoreOptions) (MemoryStoresClientDeleteMemoryStoreResponse, error)

DeleteMemoryStore - Delete a memory store

Deletes the specified memory store. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the memory store to delete.
  • options - MemoryStoresClientDeleteMemoryStoreOptions contains the optional parameters for the MemoryStoresClient.DeleteMemoryStore method.

func (*MemoryStoresClient) DeleteScope 

func (client *MemoryStoresClient) DeleteScope(ctx context.Context, name string, scope string, options *MemoryStoresClientDeleteScopeOptions) (MemoryStoresClientDeleteScopeResponse, error)

DeleteScope - Delete memories by scope

Deletes all memories in the specified memory store that are associated with the provided scope. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the memory store.
  • scope - The namespace that logically groups and isolates memories to delete, such as a user ID.
  • options - MemoryStoresClientDeleteScopeOptions contains the optional parameters for the MemoryStoresClient.DeleteScope method.

func (*MemoryStoresClient) GetMemory 

func (client *MemoryStoresClient) GetMemory(ctx context.Context, name string, memoryID string, options *MemoryStoresClientGetMemoryOptions) (MemoryStoresClientGetMemoryResponse, error)

GetMemory - Get a memory item

Retrieves the specified memory item from the memory store. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the memory store.
  • memoryID - The ID of the memory item to retrieve.
  • options - MemoryStoresClientGetMemoryOptions contains the optional parameters for the MemoryStoresClient.GetMemory method.

func (*MemoryStoresClient) GetMemoryStore 

func (client *MemoryStoresClient) GetMemoryStore(ctx context.Context, name string, options *MemoryStoresClientGetMemoryStoreOptions) (MemoryStoresClientGetMemoryStoreResponse, error)

GetMemoryStore - Get a memory store

Retrieves the specified memory store and its current configuration. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the memory store to retrieve.
  • options - MemoryStoresClientGetMemoryStoreOptions contains the optional parameters for the MemoryStoresClient.GetMemoryStore method.

func (*MemoryStoresClient) GetUpdateResult 

func (client *MemoryStoresClient) GetUpdateResult(ctx context.Context, name string, updateID string, options *MemoryStoresClientGetUpdateResultOptions) (MemoryStoresClientGetUpdateResultResponse, error)

GetUpdateResult - Get an update result

Retrieves the status and result of a memory store update operation. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the memory store.
  • updateID - The ID of the memory update operation.
  • options - MemoryStoresClientGetUpdateResultOptions contains the optional parameters for the MemoryStoresClient.GetUpdateResult method.

func (*MemoryStoresClient) NewListMemoriesPager 

func (client *MemoryStoresClient) NewListMemoriesPager(name string, scope string, options *MemoryStoresClientListMemoriesOptions) *runtime.Pager[MemoryStoresClientListMemoriesResponse]

NewListMemoriesPager - List memory items

Returns memory items from the specified memory store.

  • name - The name of the memory store.
  • scope - The namespace that logically groups and isolates memories, such as a user ID.
  • options - MemoryStoresClientListMemoriesOptions contains the optional parameters for the MemoryStoresClient.NewListMemoriesPager method.

func (*MemoryStoresClient) NewListMemoryStoresPager 

func (client *MemoryStoresClient) NewListMemoryStoresPager(options *MemoryStoresClientListMemoryStoresOptions) *runtime.Pager[MemoryStoresClientListMemoryStoresResponse]

NewListMemoryStoresPager - List memory stores

Returns the memory stores available to the caller.

  • options - MemoryStoresClientListMemoryStoresOptions contains the optional parameters for the MemoryStoresClient.NewListMemoryStoresPager method.

func (*MemoryStoresClient) SearchMemories 

func (client *MemoryStoresClient) SearchMemories(ctx context.Context, name string, scope string, options *MemoryStoresClientSearchMemoriesOptions) (MemoryStoresClientSearchMemoriesResponse, error)

SearchMemories - Search memories

Searches the specified memory store for memories relevant to the provided conversation context. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the memory store to search.
  • scope - The namespace that logically groups and isolates memories, such as a user ID.
  • options - MemoryStoresClientSearchMemoriesOptions contains the optional parameters for the MemoryStoresClient.SearchMemories method.

func (*MemoryStoresClient) UpdateMemory 

func (client *MemoryStoresClient) UpdateMemory(ctx context.Context, name string, memoryID string, content string, options *MemoryStoresClientUpdateMemoryOptions) (MemoryStoresClientUpdateMemoryResponse, error)

UpdateMemory - Update a memory item

Updates the specified memory item in the memory store. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the memory store.
  • memoryID - The ID of the memory item to update.
  • content - The updated content of the memory.
  • options - MemoryStoresClientUpdateMemoryOptions contains the optional parameters for the MemoryStoresClient.UpdateMemory method.

func (*MemoryStoresClient) UpdateMemoryStore 

func (client *MemoryStoresClient) UpdateMemoryStore(ctx context.Context, name string, options *MemoryStoresClientUpdateMemoryStoreOptions) (MemoryStoresClientUpdateMemoryStoreResponse, error)

UpdateMemoryStore - Update a memory store

Updates the specified memory store with the supplied configuration changes. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the memory store to update.
  • options - MemoryStoresClientUpdateMemoryStoreOptions contains the optional parameters for the MemoryStoresClient.UpdateMemoryStore method.

type MemoryStoresClientBeginUpdateMemoriesOptions 

type MemoryStoresClientBeginUpdateMemoriesOptions struct {
	// A list of messages to store in memory. Each item is represented as a map with keys such as `type`, `role`, and `content`,
	// similar to OpenAI response input items. Only message items are currently processed; other item types are ignored.
	Items []map[string]any

	// The unique ID of the previous update request, enabling incremental memory updates from where the last operation left off.
	PreviousUpdateID *string

	// Resumes the long-running operation from the provided token.
	ResumeToken string

	// Timeout period before processing the memory update in seconds.
	// If a new update request is received during this period, it will cancel the current request and reset the timeout.
	// Set to 0 to immediately trigger the update without delay.
	// Defaults to 300 (5 minutes).
	UpdateDelay *int32
}

MemoryStoresClientBeginUpdateMemoriesOptions contains the optional parameters for the MemoryStoresClient.BeginUpdateMemories method.

type MemoryStoresClientCreateMemoryOptions 

type MemoryStoresClientCreateMemoryOptions struct {
}

MemoryStoresClientCreateMemoryOptions contains the optional parameters for the MemoryStoresClient.CreateMemory method.

type MemoryStoresClientCreateMemoryResponse 

type MemoryStoresClientCreateMemoryResponse struct {
	// A single memory item stored in the memory store, containing content and metadata.
	MemoryItemClassification
}

MemoryStoresClientCreateMemoryResponse contains the response from method MemoryStoresClient.CreateMemory.

func (*MemoryStoresClientCreateMemoryResponse) UnmarshalJSON 

func (m *MemoryStoresClientCreateMemoryResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MemoryStoresClientCreateMemoryResponse.

type MemoryStoresClientCreateMemoryStoreOptions 

type MemoryStoresClientCreateMemoryStoreOptions struct {
	// A human-readable description of the memory store.
	Description *string

	// Arbitrary key-value metadata to associate with the memory store.
	Metadata map[string]*string
}

MemoryStoresClientCreateMemoryStoreOptions contains the optional parameters for the MemoryStoresClient.CreateMemoryStore method.

type MemoryStoresClientCreateMemoryStoreResponse 

type MemoryStoresClientCreateMemoryStoreResponse struct {
	// A memory store that can store and retrieve user memories.
	MemoryStoreObject
}

MemoryStoresClientCreateMemoryStoreResponse contains the response from method MemoryStoresClient.CreateMemoryStore.

type MemoryStoresClientDeleteMemoryOptions 

type MemoryStoresClientDeleteMemoryOptions struct {
}

MemoryStoresClientDeleteMemoryOptions contains the optional parameters for the MemoryStoresClient.DeleteMemory method.

type MemoryStoresClientDeleteMemoryResponse 

type MemoryStoresClientDeleteMemoryResponse struct {
	// Response for deleting a memory item from a memory store.
	DeleteMemoryResponse
}

MemoryStoresClientDeleteMemoryResponse contains the response from method MemoryStoresClient.DeleteMemory.

type MemoryStoresClientDeleteMemoryStoreOptions 

type MemoryStoresClientDeleteMemoryStoreOptions struct {
}

MemoryStoresClientDeleteMemoryStoreOptions contains the optional parameters for the MemoryStoresClient.DeleteMemoryStore method.

type MemoryStoresClientDeleteMemoryStoreResponse 

type MemoryStoresClientDeleteMemoryStoreResponse struct {
	DeleteMemoryStoreResult
}

MemoryStoresClientDeleteMemoryStoreResponse contains the response from method MemoryStoresClient.DeleteMemoryStore.

type MemoryStoresClientDeleteScopeOptions 

type MemoryStoresClientDeleteScopeOptions struct {
}

MemoryStoresClientDeleteScopeOptions contains the optional parameters for the MemoryStoresClient.DeleteScope method.

type MemoryStoresClientDeleteScopeResponse 

type MemoryStoresClientDeleteScopeResponse struct {
	// Response for deleting memories from a scope.
	MemoryStoreDeleteScopeResult
}

MemoryStoresClientDeleteScopeResponse contains the response from method MemoryStoresClient.DeleteScope.

type MemoryStoresClientGetMemoryOptions 

type MemoryStoresClientGetMemoryOptions struct {
}

MemoryStoresClientGetMemoryOptions contains the optional parameters for the MemoryStoresClient.GetMemory method.

type MemoryStoresClientGetMemoryResponse 

type MemoryStoresClientGetMemoryResponse struct {
	// A single memory item stored in the memory store, containing content and metadata.
	MemoryItemClassification
}

MemoryStoresClientGetMemoryResponse contains the response from method MemoryStoresClient.GetMemory.

func (*MemoryStoresClientGetMemoryResponse) UnmarshalJSON 

func (m *MemoryStoresClientGetMemoryResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MemoryStoresClientGetMemoryResponse.

type MemoryStoresClientGetMemoryStoreOptions 

type MemoryStoresClientGetMemoryStoreOptions struct {
}

MemoryStoresClientGetMemoryStoreOptions contains the optional parameters for the MemoryStoresClient.GetMemoryStore method.

type MemoryStoresClientGetMemoryStoreResponse 

type MemoryStoresClientGetMemoryStoreResponse struct {
	// A memory store that can store and retrieve user memories.
	MemoryStoreObject
}

MemoryStoresClientGetMemoryStoreResponse contains the response from method MemoryStoresClient.GetMemoryStore.

type MemoryStoresClientGetUpdateResultOptions 

type MemoryStoresClientGetUpdateResultOptions struct {
}

MemoryStoresClientGetUpdateResultOptions contains the optional parameters for the MemoryStoresClient.GetUpdateResult method.

type MemoryStoresClientGetUpdateResultResponse 

type MemoryStoresClientGetUpdateResultResponse struct {
	// Provides the status of a memory store update operation.
	MemoryStoreUpdateResult
}

MemoryStoresClientGetUpdateResultResponse contains the response from method MemoryStoresClient.GetUpdateResult.

type MemoryStoresClientListMemoriesOptions 

type MemoryStoresClientListMemoriesOptions struct {
	// A cursor for use in pagination. `after` is an object ID that defines your place in the list.
	// For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
	// subsequent call can include after=obj_foo in order to fetch the next page of the list.
	After *string

	// A cursor for use in pagination. `before` is an object ID that defines your place in the list.
	// For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
	// subsequent call can include before=obj_foo in order to fetch the previous page of the list.
	Before *string

	// The kind of the memory item.
	Kind *MemoryItemKind

	// A limit on the number of objects to be returned. Limit can range between 1 and 100, and the
	// default is 20.
	Limit *int32

	// Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`
	// for descending order.
	Order *PageOrder
}

MemoryStoresClientListMemoriesOptions contains the optional parameters for the MemoryStoresClient.NewListMemoriesPager method.

type MemoryStoresClientListMemoriesResponse 

type MemoryStoresClientListMemoriesResponse struct {
	// The response data for a requested list of items.
	AgentsPagedResultMemoryItem
}

MemoryStoresClientListMemoriesResponse contains the response from method MemoryStoresClient.NewListMemoriesPager.

type MemoryStoresClientListMemoryStoresOptions 

type MemoryStoresClientListMemoryStoresOptions struct {
	// A cursor for use in pagination. `after` is an object ID that defines your place in the list.
	// For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
	// subsequent call can include after=obj_foo in order to fetch the next page of the list.
	After *string

	// A cursor for use in pagination. `before` is an object ID that defines your place in the list.
	// For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
	// subsequent call can include before=obj_foo in order to fetch the previous page of the list.
	Before *string

	// A limit on the number of objects to be returned. Limit can range between 1 and 100, and the
	// default is 20.
	Limit *int32

	// Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`
	// for descending order.
	Order *PageOrder
}

MemoryStoresClientListMemoryStoresOptions contains the optional parameters for the MemoryStoresClient.NewListMemoryStoresPager method.

type MemoryStoresClientListMemoryStoresResponse 

type MemoryStoresClientListMemoryStoresResponse struct {
	// The response data for a requested list of items.
	AgentsPagedResultMemoryStoreObject
}

MemoryStoresClientListMemoryStoresResponse contains the response from method MemoryStoresClient.NewListMemoryStoresPager.

type MemoryStoresClientSearchMemoriesOptions 

type MemoryStoresClientSearchMemoriesOptions struct {
	// A list of messages used to search for relevant memories. Each item is represented as a map with keys such as `type`, `role`,
	// and `content`, similar to OpenAI response input items. Only message items are currently processed; other item types are
	// ignored.
	Items []map[string]any

	// Memory search options.
	Options *MemorySearchResultOptions

	// The unique ID of the previous search request, enabling incremental memory search from where the last operation left off.
	PreviousSearchID *string
}

MemoryStoresClientSearchMemoriesOptions contains the optional parameters for the MemoryStoresClient.SearchMemories method.

type MemoryStoresClientSearchMemoriesResponse 

type MemoryStoresClientSearchMemoriesResponse struct {
	// Memory search response.
	MemoryStoreSearchResult
}

MemoryStoresClientSearchMemoriesResponse contains the response from method MemoryStoresClient.SearchMemories.

type MemoryStoresClientUpdateMemoriesResponse 

type MemoryStoresClientUpdateMemoriesResponse struct {
	// Memory update result.
	MemoryStoreUpdateCompletedResult
}

MemoryStoresClientUpdateMemoriesResponse contains the response from method MemoryStoresClient.BeginUpdateMemories.

type MemoryStoresClientUpdateMemoryOptions 

type MemoryStoresClientUpdateMemoryOptions struct {
}

MemoryStoresClientUpdateMemoryOptions contains the optional parameters for the MemoryStoresClient.UpdateMemory method.

type MemoryStoresClientUpdateMemoryResponse 

type MemoryStoresClientUpdateMemoryResponse struct {
	// A single memory item stored in the memory store, containing content and metadata.
	MemoryItemClassification
}

MemoryStoresClientUpdateMemoryResponse contains the response from method MemoryStoresClient.UpdateMemory.

func (*MemoryStoresClientUpdateMemoryResponse) UnmarshalJSON 

func (m *MemoryStoresClientUpdateMemoryResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MemoryStoresClientUpdateMemoryResponse.

type MemoryStoresClientUpdateMemoryStoreOptions 

type MemoryStoresClientUpdateMemoryStoreOptions struct {
	// A human-readable description of the memory store.
	Description *string

	// Arbitrary key-value metadata to associate with the memory store.
	Metadata map[string]*string
}

MemoryStoresClientUpdateMemoryStoreOptions contains the optional parameters for the MemoryStoresClient.UpdateMemoryStore method.

type MemoryStoresClientUpdateMemoryStoreResponse 

type MemoryStoresClientUpdateMemoryStoreResponse struct {
	// A memory store that can store and retrieve user memories.
	MemoryStoreObject
}

MemoryStoresClientUpdateMemoryStoreResponse contains the response from method MemoryStoresClient.UpdateMemoryStore.

type MicrosoftFabricPreviewTool 

type MicrosoftFabricPreviewTool struct {
	// REQUIRED; The fabric data agent tool parameters.
	FabricDataagentPreview *FabricDataAgentToolParameters

	// CONSTANT; The object type, which is always 'fabric_dataagent_preview'.
	// Field has constant value ToolTypeFabricDataagentPreview, any specified value is ignored.
	Type *ToolType
}

MicrosoftFabricPreviewTool - The input definition information for a Microsoft Fabric tool as used to configure an agent.

func (*MicrosoftFabricPreviewTool) GetTool 

func (m *MicrosoftFabricPreviewTool) GetTool() *Tool

GetTool implements the ToolClassification interface for type MicrosoftFabricPreviewTool.

func (MicrosoftFabricPreviewTool) MarshalJSON 

func (m MicrosoftFabricPreviewTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MicrosoftFabricPreviewTool.

func (*MicrosoftFabricPreviewTool) UnmarshalJSON 

func (m *MicrosoftFabricPreviewTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MicrosoftFabricPreviewTool.

type ModelDeployment 

type ModelDeployment struct {
	// REQUIRED; The type of the deployment
	Type *DeploymentType

	// READ-ONLY; Capabilities of deployed model
	Capabilities map[string]*string

	// READ-ONLY; Publisher-specific name of the deployed model
	ModelName *string

	// READ-ONLY; Name of the deployed model's publisher
	ModelPublisher *string

	// READ-ONLY; Publisher-specific version of the deployed model
	ModelVersion *string

	// READ-ONLY; Name of the deployment
	Name *string

	// READ-ONLY; Sku of the model deployment
	SKU *SKU

	// READ-ONLY; Name of the connection the deployment comes from
	ConnectionName *string
}

ModelDeployment - Model Deployment Definition

func (*ModelDeployment) GetDeployment 

func (m *ModelDeployment) GetDeployment() *Deployment

GetDeployment implements the DeploymentClassification interface for type ModelDeployment.

func (ModelDeployment) MarshalJSON 

func (m ModelDeployment) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ModelDeployment.

func (*ModelDeployment) UnmarshalJSON 

func (m *ModelDeployment) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ModelDeployment.

type ModelSamplingParams 

type ModelSamplingParams struct {
	// The maximum number of tokens allowed in the completion.
	MaxCompletionTokens *int32

	// The random seed for reproducibility. Defaults to 42.
	Seed *int32

	// The temperature parameter for sampling. Defaults to 1.0.
	Temperature *float32

	// The top-p parameter for nucleus sampling. Defaults to 1.0.
	TopP *float32
}

ModelSamplingParams - Represents a set of parameters used to control the sampling behavior of a language model during text generation.

func (ModelSamplingParams) MarshalJSON 

func (m ModelSamplingParams) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ModelSamplingParams.

func (*ModelSamplingParams) UnmarshalJSON 

func (m *ModelSamplingParams) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ModelSamplingParams.

type MonthlyRecurrenceSchedule 

type MonthlyRecurrenceSchedule struct {
	// REQUIRED; Days of the month for the recurrence schedule.
	DaysOfMonth []int32

	// CONSTANT; Monthly recurrence type.
	// Field has constant value RecurrenceTypeMonthly, any specified value is ignored.
	Type *RecurrenceType
}

MonthlyRecurrenceSchedule - Monthly recurrence schedule.

func (*MonthlyRecurrenceSchedule) GetRecurrenceSchedule 

func (m *MonthlyRecurrenceSchedule) GetRecurrenceSchedule() *RecurrenceSchedule

GetRecurrenceSchedule implements the RecurrenceScheduleClassification interface for type MonthlyRecurrenceSchedule.

func (MonthlyRecurrenceSchedule) MarshalJSON 

func (m MonthlyRecurrenceSchedule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MonthlyRecurrenceSchedule.

func (*MonthlyRecurrenceSchedule) UnmarshalJSON 

func (m *MonthlyRecurrenceSchedule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MonthlyRecurrenceSchedule.

type NamespaceToolParam 

type NamespaceToolParam struct {
	// REQUIRED; A description of the namespace shown to the model.
	Description *string

	// REQUIRED; The namespace name used in tool calls (for example, `crm`).
	Name *string

	// REQUIRED; The function/custom tools available inside this namespace.
	Tools []map[string]any

	// CONSTANT; The type of the tool. Always `namespace`.
	// Field has constant value ToolTypeNamespace, any specified value is ignored.
	Type *ToolType
}

NamespaceToolParam - Namespace

Groups function/custom tools under a shared namespace.

func (*NamespaceToolParam) GetTool 

func (n *NamespaceToolParam) GetTool() *Tool

GetTool implements the ToolClassification interface for type NamespaceToolParam.

func (NamespaceToolParam) MarshalJSON 

func (n NamespaceToolParam) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NamespaceToolParam.

func (*NamespaceToolParam) UnmarshalJSON 

func (n *NamespaceToolParam) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NamespaceToolParam.

type NoAuthenticationCredentials 

type NoAuthenticationCredentials struct {
	// READ-ONLY; The credential type
	Type *CredentialType
}

NoAuthenticationCredentials - Credentials that do not require authentication

func (*NoAuthenticationCredentials) GetBaseCredentials 

func (n *NoAuthenticationCredentials) GetBaseCredentials() *BaseCredentials

GetBaseCredentials implements the BaseCredentialsClassification interface for type NoAuthenticationCredentials.

func (NoAuthenticationCredentials) MarshalJSON 

func (n NoAuthenticationCredentials) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NoAuthenticationCredentials.

func (*NoAuthenticationCredentials) UnmarshalJSON 

func (n *NoAuthenticationCredentials) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NoAuthenticationCredentials.

type OneTimeTrigger 

type OneTimeTrigger struct {
	// REQUIRED; Date and time for the one-time trigger in ISO 8601 format.
	TriggerAt *time.Time

	// CONSTANT; Field has constant value TriggerTypeOneTime, any specified value is ignored.
	Type *TriggerType

	// Time zone for the one-time trigger. Defaults to `UTC`.
	TimeZone *string
}

OneTimeTrigger - One-time trigger.

func (*OneTimeTrigger) GetTrigger 

func (o *OneTimeTrigger) GetTrigger() *Trigger

GetTrigger implements the TriggerClassification interface for type OneTimeTrigger.

func (OneTimeTrigger) MarshalJSON 

func (o OneTimeTrigger) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OneTimeTrigger.

func (*OneTimeTrigger) UnmarshalJSON 

func (o *OneTimeTrigger) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OneTimeTrigger.

type OpenAPIAnonymousAuthDetails 

type OpenAPIAnonymousAuthDetails struct {
	// CONSTANT; The object type, which is always 'anonymous'.
	// Field has constant value OpenAPIAuthTypeAnonymous, any specified value is ignored.
	Type *OpenAPIAuthType
}

OpenAPIAnonymousAuthDetails - Security details for OpenApi anonymous authentication

func (*OpenAPIAnonymousAuthDetails) GetOpenAPIAuthDetails 

func (o *OpenAPIAnonymousAuthDetails) GetOpenAPIAuthDetails() *OpenAPIAuthDetails

GetOpenAPIAuthDetails implements the OpenAPIAuthDetailsClassification interface for type OpenAPIAnonymousAuthDetails.

func (OpenAPIAnonymousAuthDetails) MarshalJSON 

func (o OpenAPIAnonymousAuthDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OpenAPIAnonymousAuthDetails.

func (*OpenAPIAnonymousAuthDetails) UnmarshalJSON 

func (o *OpenAPIAnonymousAuthDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OpenAPIAnonymousAuthDetails.

type OpenAPIAuthDetails 

type OpenAPIAuthDetails struct {
	// REQUIRED; The type of authentication, must be anonymous/project_connection/managed_identity
	Type *OpenAPIAuthType
}

OpenAPIAuthDetails - authentication details for OpenApiFunctionDefinition

func (*OpenAPIAuthDetails) GetOpenAPIAuthDetails 

func (o *OpenAPIAuthDetails) GetOpenAPIAuthDetails() *OpenAPIAuthDetails

GetOpenAPIAuthDetails implements the OpenAPIAuthDetailsClassification interface for type OpenAPIAuthDetails.

func (OpenAPIAuthDetails) MarshalJSON 

func (o OpenAPIAuthDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OpenAPIAuthDetails.

func (*OpenAPIAuthDetails) UnmarshalJSON 

func (o *OpenAPIAuthDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OpenAPIAuthDetails.

type OpenAPIAuthDetailsClassification 

type OpenAPIAuthDetailsClassification interface {
	// GetOpenAPIAuthDetails returns the OpenAPIAuthDetails content of the underlying type.
	GetOpenAPIAuthDetails() *OpenAPIAuthDetails
}

OpenAPIAuthDetailsClassification provides polymorphic access to related types. Call the interface's GetOpenAPIAuthDetails() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *OpenAPIAnonymousAuthDetails, *OpenAPIAuthDetails, *OpenAPIManagedAuthDetails, *OpenAPIProjectConnectionAuthDetails

type OpenAPIAuthType 

type OpenAPIAuthType string

OpenAPIAuthType - Authentication type for OpenApi endpoint. Allowed types are: - Anonymous (no authentication required) - Project Connection (requires project_connection_id to endpoint, as setup in AI Foundry) - Managed_Identity (requires audience for identity based auth) 

const (
	OpenAPIAuthTypeAnonymous         OpenAPIAuthType = "anonymous"
	OpenAPIAuthTypeManagedIdentity   OpenAPIAuthType = "managed_identity"
	OpenAPIAuthTypeProjectConnection OpenAPIAuthType = "project_connection"
)

func PossibleOpenAPIAuthTypeValues 

func PossibleOpenAPIAuthTypeValues() []OpenAPIAuthType

PossibleOpenAPIAuthTypeValues returns the possible values for the OpenAPIAuthType const type.

type OpenAPIFunctionDefinition 

type OpenAPIFunctionDefinition struct {
	// REQUIRED; Open API authentication details
	Auth OpenAPIAuthDetailsClassification

	// REQUIRED; The name of the function to be called.
	Name *string

	// REQUIRED; The openapi function shape, described as a JSON Schema object.
	Spec map[string]any

	// List of OpenAPI spec parameters that will use user-provided defaults
	DefaultParams []string

	// A description of what the function does, used by the model to choose when and how to call the function.
	Description *string

	// READ-ONLY; List of function definitions used by OpenApi tool
	Functions []OpenAPIFunctionDefinitionFunction
}

OpenAPIFunctionDefinition - The input definition information for an openapi function.

func (OpenAPIFunctionDefinition) MarshalJSON 

func (o OpenAPIFunctionDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OpenAPIFunctionDefinition.

func (*OpenAPIFunctionDefinition) UnmarshalJSON 

func (o *OpenAPIFunctionDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OpenAPIFunctionDefinition.

type OpenAPIFunctionDefinitionFunction 

type OpenAPIFunctionDefinitionFunction struct {
	// REQUIRED; The name of the function to be called.
	Name *string

	// REQUIRED; The parameters the functions accepts, described as a JSON Schema object.
	Parameters map[string]any

	// A description of what the function does, used by the model to choose when and how to call the function.
	Description *string
}

func (OpenAPIFunctionDefinitionFunction) MarshalJSON 

func (o OpenAPIFunctionDefinitionFunction) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OpenAPIFunctionDefinitionFunction.

func (*OpenAPIFunctionDefinitionFunction) UnmarshalJSON 

func (o *OpenAPIFunctionDefinitionFunction) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OpenAPIFunctionDefinitionFunction.

type OpenAPIManagedAuthDetails 

type OpenAPIManagedAuthDetails struct {
	// REQUIRED; Connection auth security details
	SecurityScheme *OpenAPIManagedSecurityScheme

	// CONSTANT; The object type, which is always 'managed_identity'.
	// Field has constant value OpenAPIAuthTypeManagedIdentity, any specified value is ignored.
	Type *OpenAPIAuthType
}

OpenAPIManagedAuthDetails - Security details for OpenApi managed_identity authentication

func (*OpenAPIManagedAuthDetails) GetOpenAPIAuthDetails 

func (o *OpenAPIManagedAuthDetails) GetOpenAPIAuthDetails() *OpenAPIAuthDetails

GetOpenAPIAuthDetails implements the OpenAPIAuthDetailsClassification interface for type OpenAPIManagedAuthDetails.

func (OpenAPIManagedAuthDetails) MarshalJSON 

func (o OpenAPIManagedAuthDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OpenAPIManagedAuthDetails.

func (*OpenAPIManagedAuthDetails) UnmarshalJSON 

func (o *OpenAPIManagedAuthDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OpenAPIManagedAuthDetails.

type OpenAPIManagedSecurityScheme 

type OpenAPIManagedSecurityScheme struct {
	// REQUIRED; Authentication scope for managed_identity auth type
	Audience *string
}

OpenAPIManagedSecurityScheme - Security scheme for OpenApi managed_identity authentication

func (OpenAPIManagedSecurityScheme) MarshalJSON 

func (o OpenAPIManagedSecurityScheme) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OpenAPIManagedSecurityScheme.

func (*OpenAPIManagedSecurityScheme) UnmarshalJSON 

func (o *OpenAPIManagedSecurityScheme) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OpenAPIManagedSecurityScheme.

type OpenAPIProjectConnectionAuthDetails 

type OpenAPIProjectConnectionAuthDetails struct {
	// REQUIRED; Project connection auth security details
	SecurityScheme *OpenAPIProjectConnectionSecurityScheme

	// CONSTANT; The object type, which is always 'project_connection'.
	// Field has constant value OpenAPIAuthTypeProjectConnection, any specified value is ignored.
	Type *OpenAPIAuthType
}

OpenAPIProjectConnectionAuthDetails - Security details for OpenApi project connection authentication

func (*OpenAPIProjectConnectionAuthDetails) GetOpenAPIAuthDetails 

func (o *OpenAPIProjectConnectionAuthDetails) GetOpenAPIAuthDetails() *OpenAPIAuthDetails

GetOpenAPIAuthDetails implements the OpenAPIAuthDetailsClassification interface for type OpenAPIProjectConnectionAuthDetails.

func (OpenAPIProjectConnectionAuthDetails) MarshalJSON 

func (o OpenAPIProjectConnectionAuthDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OpenAPIProjectConnectionAuthDetails.

func (*OpenAPIProjectConnectionAuthDetails) UnmarshalJSON 

func (o *OpenAPIProjectConnectionAuthDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OpenAPIProjectConnectionAuthDetails.

type OpenAPIProjectConnectionSecurityScheme 

type OpenAPIProjectConnectionSecurityScheme struct {
	// REQUIRED; Project connection id for Project Connection auth type
	ProjectConnectionID *string
}

OpenAPIProjectConnectionSecurityScheme - Security scheme for OpenApi managed_identity authentication

func (OpenAPIProjectConnectionSecurityScheme) MarshalJSON 

func (o OpenAPIProjectConnectionSecurityScheme) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OpenAPIProjectConnectionSecurityScheme.

func (*OpenAPIProjectConnectionSecurityScheme) UnmarshalJSON 

func (o *OpenAPIProjectConnectionSecurityScheme) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OpenAPIProjectConnectionSecurityScheme.

type OpenAPITool 

type OpenAPITool struct {
	// REQUIRED; The openapi function definition.
	Openapi *OpenAPIFunctionDefinition

	// CONSTANT; The object type, which is always 'openapi'.
	// Field has constant value ToolTypeOpenapi, any specified value is ignored.
	Type *ToolType

	// Deprecated. This property is deprecated and will be removed in a future version.
	ToolConfigs map[string]*ToolConfig
}

OpenAPITool - The input definition information for an OpenAPI tool as used to configure an agent.

func (*OpenAPITool) GetTool 

func (o *OpenAPITool) GetTool() *Tool

GetTool implements the ToolClassification interface for type OpenAPITool.

func (OpenAPITool) MarshalJSON 

func (o OpenAPITool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OpenAPITool.

func (*OpenAPITool) UnmarshalJSON 

func (o *OpenAPITool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OpenAPITool.

type OpenAPIToolboxTool 

type OpenAPIToolboxTool struct {
	// REQUIRED; The openapi function definition.
	Openapi *OpenAPIFunctionDefinition

	// CONSTANT; Field has constant value ToolboxToolTypeOpenapi, any specified value is ignored.
	Type *ToolboxToolType

	// Optional user-defined description for this tool or configuration.
	Description *string

	// Optional user-defined name for this tool or configuration.
	Name *string

	// Deprecated. This property is deprecated and will be removed in a future version.
	ToolConfigs map[string]*ToolConfig
}

OpenAPIToolboxTool - An OpenAPI tool stored in a toolbox.

func (*OpenAPIToolboxTool) GetToolboxTool 

func (o *OpenAPIToolboxTool) GetToolboxTool() *ToolboxTool

GetToolboxTool implements the ToolboxToolClassification interface for type OpenAPIToolboxTool.

func (OpenAPIToolboxTool) MarshalJSON 

func (o OpenAPIToolboxTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OpenAPIToolboxTool.

func (*OpenAPIToolboxTool) UnmarshalJSON 

func (o *OpenAPIToolboxTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OpenAPIToolboxTool.

type OperationState 

type OperationState string

OperationState - Enum describing allowed operation states. 

const (
	// OperationStateCanceled - The operation has been canceled by the user.
	OperationStateCanceled OperationState = "Canceled"
	// OperationStateFailed - The operation has failed.
	OperationStateFailed OperationState = "Failed"
	// OperationStateNotStarted - The operation has not started.
	OperationStateNotStarted OperationState = "NotStarted"
	// OperationStateRunning - The operation is in progress.
	OperationStateRunning OperationState = "Running"
	// OperationStateSucceeded - The operation has completed successfully.
	OperationStateSucceeded OperationState = "Succeeded"
)

func PossibleOperationStateValues 

func PossibleOperationStateValues() []OperationState

PossibleOperationStateValues returns the possible values for the OperationState const type.

type PageOrder 

type PageOrder string
const (
	PageOrderAsc  PageOrder = "asc"
	PageOrderDesc PageOrder = "desc"
)

func PossiblePageOrderValues 

func PossiblePageOrderValues() []PageOrder

PossiblePageOrderValues returns the possible values for the PageOrder const type.

type PagedConnection 

type PagedConnection struct {
	// REQUIRED; The Connection items on this page
	Value []Connection

	// The link to the next page of items
	NextLink *string
}

PagedConnection - Paged collection of Connection items

func (PagedConnection) MarshalJSON 

func (p PagedConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PagedConnection.

func (*PagedConnection) UnmarshalJSON 

func (p *PagedConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PagedConnection.

type PagedDatasetVersion 

type PagedDatasetVersion struct {
	// REQUIRED; The DatasetVersion items on this page
	Value []DatasetVersionClassification

	// The link to the next page of items
	NextLink *string
}

PagedDatasetVersion - Paged collection of DatasetVersion items

func (PagedDatasetVersion) MarshalJSON 

func (p PagedDatasetVersion) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PagedDatasetVersion.

func (*PagedDatasetVersion) UnmarshalJSON 

func (p *PagedDatasetVersion) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PagedDatasetVersion.

type PagedDeployment 

type PagedDeployment struct {
	// REQUIRED; The Deployment items on this page
	Value []DeploymentClassification

	// The link to the next page of items
	NextLink *string
}

PagedDeployment - Paged collection of Deployment items

func (PagedDeployment) MarshalJSON 

func (p PagedDeployment) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PagedDeployment.

func (*PagedDeployment) UnmarshalJSON 

func (p *PagedDeployment) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PagedDeployment.

type PagedEvaluationRule 

type PagedEvaluationRule struct {
	// REQUIRED; The EvaluationRule items on this page
	Value []EvaluationRule

	// The link to the next page of items
	NextLink *string
}

PagedEvaluationRule - Paged collection of EvaluationRule items

func (PagedEvaluationRule) MarshalJSON 

func (p PagedEvaluationRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PagedEvaluationRule.

func (*PagedEvaluationRule) UnmarshalJSON 

func (p *PagedEvaluationRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PagedEvaluationRule.

type PagedEvaluationTaxonomy 

type PagedEvaluationTaxonomy struct {
	// REQUIRED; The EvaluationTaxonomy items on this page
	Value []EvaluationTaxonomy

	// The link to the next page of items
	NextLink *string
}

PagedEvaluationTaxonomy - Paged collection of EvaluationTaxonomy items

func (PagedEvaluationTaxonomy) MarshalJSON 

func (p PagedEvaluationTaxonomy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PagedEvaluationTaxonomy.

func (*PagedEvaluationTaxonomy) UnmarshalJSON 

func (p *PagedEvaluationTaxonomy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PagedEvaluationTaxonomy.

type PagedEvaluatorVersion 

type PagedEvaluatorVersion struct {
	// REQUIRED; The EvaluatorVersion items on this page
	Value []EvaluatorVersion

	// The link to the next page of items
	NextLink *string
}

PagedEvaluatorVersion - Paged collection of EvaluatorVersion items

func (PagedEvaluatorVersion) MarshalJSON 

func (p PagedEvaluatorVersion) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PagedEvaluatorVersion.

func (*PagedEvaluatorVersion) UnmarshalJSON 

func (p *PagedEvaluatorVersion) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PagedEvaluatorVersion.

type PagedIndex 

type PagedIndex struct {
	// REQUIRED; The Index items on this page
	Value []IndexClassification

	// The link to the next page of items
	NextLink *string
}

PagedIndex - Paged collection of Index items

func (PagedIndex) MarshalJSON 

func (p PagedIndex) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PagedIndex.

func (*PagedIndex) UnmarshalJSON 

func (p *PagedIndex) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PagedIndex.

type PagedInsight 

type PagedInsight struct {
	// REQUIRED; The Insight items on this page
	Value []Insight

	// The link to the next page of items
	NextLink *string
}

PagedInsight - Paged collection of Insight items

func (PagedInsight) MarshalJSON 

func (p PagedInsight) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PagedInsight.

func (*PagedInsight) UnmarshalJSON 

func (p *PagedInsight) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PagedInsight.

type PagedRedTeam 

type PagedRedTeam struct {
	// REQUIRED; The RedTeam items on this page
	Value []RedTeam

	// The link to the next page of items
	NextLink *string
}

PagedRedTeam - Paged collection of RedTeam items

func (PagedRedTeam) MarshalJSON 

func (p PagedRedTeam) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PagedRedTeam.

func (*PagedRedTeam) UnmarshalJSON 

func (p *PagedRedTeam) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PagedRedTeam.

type PagedSchedule 

type PagedSchedule struct {
	// REQUIRED; The Schedule items on this page
	Value []Schedule

	// The link to the next page of items
	NextLink *string
}

PagedSchedule - Paged collection of Schedule items

func (PagedSchedule) MarshalJSON 

func (p PagedSchedule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PagedSchedule.

func (*PagedSchedule) UnmarshalJSON 

func (p *PagedSchedule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PagedSchedule.

type PagedScheduleRun 

type PagedScheduleRun struct {
	// REQUIRED; The ScheduleRun items on this page
	Value []ScheduleRun

	// The link to the next page of items
	NextLink *string
}

PagedScheduleRun - Paged collection of ScheduleRun items

func (PagedScheduleRun) MarshalJSON 

func (p PagedScheduleRun) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PagedScheduleRun.

func (*PagedScheduleRun) UnmarshalJSON 

func (p *PagedScheduleRun) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PagedScheduleRun.

type PendingUploadRequest 

type PendingUploadRequest struct {
	// CONSTANT; The type of pending upload.
	// Field has constant value PendingUploadTypeBlobReference, any specified value is ignored.
	PendingUploadType *PendingUploadType

	// Azure Storage Account connection name to use for generating temporary SAS token
	ConnectionName *string

	// If PendingUploadId is not provided, a random GUID will be used.
	PendingUploadID *string
}

PendingUploadRequest - Represents a request for a pending upload.

func (PendingUploadRequest) MarshalJSON 

func (p PendingUploadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PendingUploadRequest.

func (*PendingUploadRequest) UnmarshalJSON 

func (p *PendingUploadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PendingUploadRequest.

type PendingUploadResponse 

type PendingUploadResponse struct {
	// REQUIRED; Container-level read, write, list SAS.
	BlobReference *BlobReference

	// REQUIRED; ID for this upload request.
	PendingUploadID *string

	// REQUIRED; The type of pending upload.
	PendingUploadType *PendingUploadType

	// Version of asset to be created if user did not specify version when initially creating upload
	Version *string
}

PendingUploadResponse - Represents the response for a pending upload request

func (PendingUploadResponse) MarshalJSON 

func (p PendingUploadResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PendingUploadResponse.

func (*PendingUploadResponse) UnmarshalJSON 

func (p *PendingUploadResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PendingUploadResponse.

type PendingUploadType 

type PendingUploadType string

PendingUploadType - The type of pending upload. 

const (
	// PendingUploadTypeBlobReference - Deprecated: the service never read this value and silently ignored it. Use TemporaryBlobReference
	// instead.
	PendingUploadTypeBlobReference PendingUploadType = "BlobReference"
	// PendingUploadTypeNone - No pending upload.
	PendingUploadTypeNone PendingUploadType = "None"
	// PendingUploadTypeTemporaryBlobReference - Temporary blob reference.
	PendingUploadTypeTemporaryBlobReference PendingUploadType = "TemporaryBlobReference"
)

func PossiblePendingUploadTypeValues 

func PossiblePendingUploadTypeValues() []PendingUploadType

PossiblePendingUploadTypeValues returns the possible values for the PendingUploadType const type.

type ProceduralMemoryItem 

type ProceduralMemoryItem struct {
	// REQUIRED; The content of the memory.
	Content *string

	// REQUIRED; The kind of the memory item.
	Kind *MemoryItemKind

	// REQUIRED; The unique ID of the memory item.
	MemoryID *string

	// REQUIRED; The namespace that logically groups and isolates memories, such as a user ID.
	Scope *string

	// REQUIRED; The last update time of the memory item.
	UpdatedAt *time.Time
}

ProceduralMemoryItem - A memory item containing a procedure extracted from conversations.

func (*ProceduralMemoryItem) GetMemoryItem 

func (p *ProceduralMemoryItem) GetMemoryItem() *MemoryItem

GetMemoryItem implements the MemoryItemClassification interface for type ProceduralMemoryItem.

func (ProceduralMemoryItem) MarshalJSON 

func (p ProceduralMemoryItem) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProceduralMemoryItem.

func (*ProceduralMemoryItem) UnmarshalJSON 

func (p *ProceduralMemoryItem) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProceduralMemoryItem.

type PromptBasedEvaluatorDefinition 

type PromptBasedEvaluatorDefinition struct {
	// REQUIRED; The prompt text used for evaluation
	PromptText *string

	// CONSTANT; Field has constant value EvaluatorDefinitionTypePrompt, any specified value is ignored.
	Type *EvaluatorDefinitionType

	// The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required.
	DataSchema map[string]any

	// The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required.
	InitParameters map[string]any

	// List of output metrics produced by this evaluator
	Metrics map[string]*EvaluatorMetric
}

PromptBasedEvaluatorDefinition - Prompt-based evaluator

func (*PromptBasedEvaluatorDefinition) GetEvaluatorDefinition 

func (p *PromptBasedEvaluatorDefinition) GetEvaluatorDefinition() *EvaluatorDefinition

GetEvaluatorDefinition implements the EvaluatorDefinitionClassification interface for type PromptBasedEvaluatorDefinition.

func (PromptBasedEvaluatorDefinition) MarshalJSON 

func (p PromptBasedEvaluatorDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PromptBasedEvaluatorDefinition.

func (*PromptBasedEvaluatorDefinition) UnmarshalJSON 

func (p *PromptBasedEvaluatorDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PromptBasedEvaluatorDefinition.

type PromptEvaluatorGenerationJobSource 

type PromptEvaluatorGenerationJobSource struct {
	// REQUIRED; Inline prompt text (e.g., agent description, policy text, supplementary context).
	Prompt *string

	// CONSTANT; The source type for this source, which is Prompt.
	// Field has constant value EvaluatorGenerationJobSourceTypePrompt, any specified value is ignored.
	Type *EvaluatorGenerationJobSourceType

	// Optional description of what this source represents — helps the pipeline interpret its content (e.g., 'Company refund policy
	// document' or 'Describes the agent's core capabilities').
	Description *string
}

PromptEvaluatorGenerationJobSource - Prompt source for evaluator generation jobs — inline text provided by the user.

func (*PromptEvaluatorGenerationJobSource) GetEvaluatorGenerationJobSource 

func (p *PromptEvaluatorGenerationJobSource) GetEvaluatorGenerationJobSource() *EvaluatorGenerationJobSource

GetEvaluatorGenerationJobSource implements the EvaluatorGenerationJobSourceClassification interface for type PromptEvaluatorGenerationJobSource.

func (PromptEvaluatorGenerationJobSource) MarshalJSON 

func (p PromptEvaluatorGenerationJobSource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PromptEvaluatorGenerationJobSource.

func (*PromptEvaluatorGenerationJobSource) UnmarshalJSON 

func (p *PromptEvaluatorGenerationJobSource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PromptEvaluatorGenerationJobSource.

type RaiConfig 

type RaiConfig struct {
	// REQUIRED; The name of the RAI policy to apply.
	RaiPolicyName *string
}

RaiConfig - Configuration for Responsible AI (RAI) content filtering and safety features.

func (RaiConfig) MarshalJSON 

func (r RaiConfig) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RaiConfig.

func (*RaiConfig) UnmarshalJSON 

func (r *RaiConfig) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RaiConfig.

type RankerVersionType 

type RankerVersionType string
const (
	RankerVersionTypeAuto            RankerVersionType = "auto"
	RankerVersionTypeDefault20241115 RankerVersionType = "default-2024-11-15"
)

func PossibleRankerVersionTypeValues 

func PossibleRankerVersionTypeValues() []RankerVersionType

PossibleRankerVersionTypeValues returns the possible values for the RankerVersionType const type.

type RankingOptions 

type RankingOptions struct {
	// Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when
	// hybrid search is enabled.
	HybridSearch *HybridSearchOptions

	// The ranker to use for the file search.
	Ranker *RankerVersionType

	// The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the
	// most relevant results, but may return fewer results.
	ScoreThreshold *float64
}

func (RankingOptions) MarshalJSON 

func (r RankingOptions) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RankingOptions.

func (*RankingOptions) UnmarshalJSON 

func (r *RankingOptions) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RankingOptions.

type RecurrenceSchedule 

type RecurrenceSchedule struct {
	// REQUIRED; Recurrence type for the recurrence schedule.
	Type *RecurrenceType
}

RecurrenceSchedule - Recurrence schedule model.

func (*RecurrenceSchedule) GetRecurrenceSchedule 

func (r *RecurrenceSchedule) GetRecurrenceSchedule() *RecurrenceSchedule

GetRecurrenceSchedule implements the RecurrenceScheduleClassification interface for type RecurrenceSchedule.

func (RecurrenceSchedule) MarshalJSON 

func (r RecurrenceSchedule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RecurrenceSchedule.

func (*RecurrenceSchedule) UnmarshalJSON 

func (r *RecurrenceSchedule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RecurrenceSchedule.

type RecurrenceScheduleClassification 

type RecurrenceScheduleClassification interface {
	// GetRecurrenceSchedule returns the RecurrenceSchedule content of the underlying type.
	GetRecurrenceSchedule() *RecurrenceSchedule
}

RecurrenceScheduleClassification provides polymorphic access to related types. Call the interface's GetRecurrenceSchedule() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *DailyRecurrenceSchedule, *HourlyRecurrenceSchedule, *MonthlyRecurrenceSchedule, *RecurrenceSchedule, *WeeklyRecurrenceSchedule

type RecurrenceTrigger 

type RecurrenceTrigger struct {
	// REQUIRED; Interval for the recurrence schedule.
	Interval *int32

	// REQUIRED; Recurrence schedule for the recurrence trigger.
	Schedule RecurrenceScheduleClassification

	// CONSTANT; Type of the trigger.
	// Field has constant value TriggerTypeRecurrence, any specified value is ignored.
	Type *TriggerType

	// End time for the recurrence schedule in ISO 8601 format.
	EndTime *time.Time

	// Start time for the recurrence schedule in ISO 8601 format.
	StartTime *time.Time

	// Time zone for the recurrence schedule. Defaults to `UTC`.
	TimeZone *string
}

RecurrenceTrigger - Recurrence based trigger.

func (*RecurrenceTrigger) GetTrigger 

func (r *RecurrenceTrigger) GetTrigger() *Trigger

GetTrigger implements the TriggerClassification interface for type RecurrenceTrigger.

func (RecurrenceTrigger) MarshalJSON 

func (r RecurrenceTrigger) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RecurrenceTrigger.

func (*RecurrenceTrigger) UnmarshalJSON 

func (r *RecurrenceTrigger) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RecurrenceTrigger.

type RecurrenceType 

type RecurrenceType string

RecurrenceType - Recurrence type. 

const (
	// RecurrenceTypeDaily - Daily recurrence pattern.
	RecurrenceTypeDaily RecurrenceType = "Daily"
	// RecurrenceTypeHourly - Hourly recurrence pattern.
	RecurrenceTypeHourly RecurrenceType = "Hourly"
	// RecurrenceTypeMonthly - Monthly recurrence pattern.
	RecurrenceTypeMonthly RecurrenceType = "Monthly"
	// RecurrenceTypeWeekly - Weekly recurrence pattern.
	RecurrenceTypeWeekly RecurrenceType = "Weekly"
)

func PossibleRecurrenceTypeValues 

func PossibleRecurrenceTypeValues() []RecurrenceType

PossibleRecurrenceTypeValues returns the possible values for the RecurrenceType const type.

type RedTeam 

type RedTeam struct {
	// REQUIRED; Target configuration for the red-team run.
	Target RedTeamTargetConfigClassification

	// READ-ONLY; Identifier of the red team run.
	Name *string

	// Application scenario for the red team operation, to generate scenario specific attacks.
	ApplicationScenario *string

	// List of attack strategies or nested lists of attack strategies.
	AttackStrategies []AttackStrategy

	// Name of the red-team run.
	DisplayName *string

	// Number of simulation rounds.
	NumTurns *int32

	// Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.
	Properties map[string]*string

	// List of risk categories to generate attack objectives for.
	RiskCategories []RiskCategory

	// Simulation-only or Simulation + Evaluation. If `true` the scan outputs conversation not evaluation result. The service
	// defaults to `false` if a value is not specified by the caller.
	SimulationOnly *bool

	// Red team's tags. Unlike properties, tags are fully mutable.
	Tags map[string]*string

	// READ-ONLY; Status of the red-team. It is set by service and is read-only.
	Status *string
}

RedTeam - Red team details.

func (RedTeam) MarshalJSON 

func (r RedTeam) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RedTeam.

func (*RedTeam) UnmarshalJSON 

func (r *RedTeam) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RedTeam.

type RedTeamTargetConfig 

type RedTeamTargetConfig struct {
	// REQUIRED; Type of the model configuration.
	Type *string
}

RedTeamTargetConfig - Abstract class for target configuration.

func (*RedTeamTargetConfig) GetRedTeamTargetConfig 

func (r *RedTeamTargetConfig) GetRedTeamTargetConfig() *RedTeamTargetConfig

GetRedTeamTargetConfig implements the RedTeamTargetConfigClassification interface for type RedTeamTargetConfig.

func (RedTeamTargetConfig) MarshalJSON 

func (r RedTeamTargetConfig) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RedTeamTargetConfig.

func (*RedTeamTargetConfig) UnmarshalJSON 

func (r *RedTeamTargetConfig) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RedTeamTargetConfig.

type RedTeamTargetConfigClassification 

type RedTeamTargetConfigClassification interface {
	// GetRedTeamTargetConfig returns the RedTeamTargetConfig content of the underlying type.
	GetRedTeamTargetConfig() *RedTeamTargetConfig
}

RedTeamTargetConfigClassification provides polymorphic access to related types. Call the interface's GetRedTeamTargetConfig() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AzureOpenAIModelConfiguration, *RedTeamTargetConfig

type RedTeamsClient 

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

RedTeamsClient contains the methods for the RedTeams group. Don't use this type directly, use Client.NewRedTeamsClient instead.

Generated from API version v1

func (*RedTeamsClient) Create 

func (client *RedTeamsClient) Create(ctx context.Context, redTeam RedTeam, options *RedTeamsClientCreateOptions) (RedTeamsClientCreateResponse, error)

Create - Create a redteam run

Submits a new redteam run for execution with the provided configuration. If the operation fails it returns an *azcore.ResponseError type.

  • redTeam - Redteam to be run
  • options - RedTeamsClientCreateOptions contains the optional parameters for the RedTeamsClient.Create method.

func (*RedTeamsClient) Get 

func (client *RedTeamsClient) Get(ctx context.Context, name string, options *RedTeamsClientGetOptions) (RedTeamsClientGetResponse, error)

Get - Get a redteam

Retrieves the specified redteam and its configuration. If the operation fails it returns an *azcore.ResponseError type.

  • name - Identifier of the red team run.
  • options - RedTeamsClientGetOptions contains the optional parameters for the RedTeamsClient.Get method.

func (*RedTeamsClient) NewListPager 

func (client *RedTeamsClient) NewListPager(options *RedTeamsClientListOptions) *runtime.Pager[RedTeamsClientListResponse]

NewListPager - List redteams

Returns the redteams available in the current project.

  • options - RedTeamsClientListOptions contains the optional parameters for the RedTeamsClient.NewListPager method.

type RedTeamsClientCreateOptions 

type RedTeamsClientCreateOptions struct {
}

RedTeamsClientCreateOptions contains the optional parameters for the RedTeamsClient.Create method.

type RedTeamsClientCreateResponse 

type RedTeamsClientCreateResponse struct {
	// Red team details.
	RedTeam
}

RedTeamsClientCreateResponse contains the response from method RedTeamsClient.Create.

type RedTeamsClientGetOptions 

type RedTeamsClientGetOptions struct {
}

RedTeamsClientGetOptions contains the optional parameters for the RedTeamsClient.Get method.

type RedTeamsClientGetResponse 

type RedTeamsClientGetResponse struct {
	// Red team details.
	RedTeam
}

RedTeamsClientGetResponse contains the response from method RedTeamsClient.Get.

type RedTeamsClientListOptions 

type RedTeamsClientListOptions struct {
}

RedTeamsClientListOptions contains the optional parameters for the RedTeamsClient.NewListPager method.

type RedTeamsClientListResponse 

type RedTeamsClientListResponse struct {
	// Paged collection of RedTeam items
	PagedRedTeam
}

RedTeamsClientListResponse contains the response from method RedTeamsClient.NewListPager.

type ReminderPreviewTool 

type ReminderPreviewTool struct {
	// CONSTANT; The type of the tool. Always `reminder_preview`.
	// Field has constant value ToolTypeReminderPreview, any specified value is ignored.
	Type *ToolType

	// Optional user-defined description for this tool or configuration.
	Description *string

	// Optional user-defined name for this tool or configuration.
	Name *string
}

ReminderPreviewTool - A built-in tool that schedules the agent to re-invoke itself after a delay. The model passes a single `minutes` argument (positive integer) when calling this tool. The service creates a one-shot timer routine that fires after the specified delay and re-invokes the agent on the same conversation thread. No pre-created routine is required.

func (*ReminderPreviewTool) GetTool 

func (r *ReminderPreviewTool) GetTool() *Tool

GetTool implements the ToolClassification interface for type ReminderPreviewTool.

func (ReminderPreviewTool) MarshalJSON 

func (r ReminderPreviewTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ReminderPreviewTool.

func (*ReminderPreviewTool) UnmarshalJSON 

func (r *ReminderPreviewTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ReminderPreviewTool.

type ReminderPreviewToolboxTool 

type ReminderPreviewToolboxTool struct {
	// CONSTANT; Field has constant value ToolboxToolTypeReminderPreview, any specified value is ignored.
	Type *ToolboxToolType

	// Optional user-defined description for this tool or configuration.
	Description *string

	// Optional user-defined name for this tool or configuration.
	Name *string

	// Per-tool configuration map. Keys are tool names or `*` (catch-all default).
	// Resolution order: exact tool name match takes priority over `*`.
	// Unknown tool names are silently ignored at runtime.
	ToolConfigs map[string]*ToolConfig
}

ReminderPreviewToolboxTool - A reminder tool stored in a toolbox.

func (*ReminderPreviewToolboxTool) GetToolboxTool 

func (r *ReminderPreviewToolboxTool) GetToolboxTool() *ToolboxTool

GetToolboxTool implements the ToolboxToolClassification interface for type ReminderPreviewToolboxTool.

func (ReminderPreviewToolboxTool) MarshalJSON 

func (r ReminderPreviewToolboxTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ReminderPreviewToolboxTool.

func (*ReminderPreviewToolboxTool) UnmarshalJSON 

func (r *ReminderPreviewToolboxTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ReminderPreviewToolboxTool.

type ResponseUsageInputTokensDetails 

type ResponseUsageInputTokensDetails struct {
	// REQUIRED
	CachedTokens *int64
}

func (ResponseUsageInputTokensDetails) MarshalJSON 

func (r ResponseUsageInputTokensDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResponseUsageInputTokensDetails.

func (*ResponseUsageInputTokensDetails) UnmarshalJSON 

func (r *ResponseUsageInputTokensDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResponseUsageInputTokensDetails.

type ResponseUsageOutputTokensDetails 

type ResponseUsageOutputTokensDetails struct {
	// REQUIRED
	ReasoningTokens *int64
}

func (ResponseUsageOutputTokensDetails) MarshalJSON 

func (r ResponseUsageOutputTokensDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResponseUsageOutputTokensDetails.

func (*ResponseUsageOutputTokensDetails) UnmarshalJSON 

func (r *ResponseUsageOutputTokensDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResponseUsageOutputTokensDetails.

type RiskCategory 

type RiskCategory string

RiskCategory - Risk category for the attack objective. 

const (
	// RiskCategoryCodeVulnerability - Represents content that contains vulnerabilities in code.
	RiskCategoryCodeVulnerability RiskCategory = "CodeVulnerability"
	// RiskCategoryHateUnfairness - Represents content related to hate or unfairness.
	RiskCategoryHateUnfairness RiskCategory = "HateUnfairness"
	// RiskCategoryProhibitedActions - Represents content that involves prohibited actions.
	RiskCategoryProhibitedActions RiskCategory = "ProhibitedActions"
	// RiskCategoryProtectedMaterial - Represents content that involves illegal activities.
	RiskCategoryProtectedMaterial RiskCategory = "ProtectedMaterial"
	// RiskCategorySelfHarm - Represents content related to self-harm.
	RiskCategorySelfHarm RiskCategory = "SelfHarm"
	// RiskCategorySensitiveDataLeakage - Represents content that involves sensitive data leakage.
	RiskCategorySensitiveDataLeakage RiskCategory = "SensitiveDataLeakage"
	// RiskCategorySexual - Represents content of a sexual nature.
	RiskCategorySexual RiskCategory = "Sexual"
	// RiskCategoryTaskAdherence - Represents content that involves task adherence.
	RiskCategoryTaskAdherence RiskCategory = "TaskAdherence"
	// RiskCategoryUngroundedAttributes - Represents content that lacks a solid grounding in fact.
	RiskCategoryUngroundedAttributes RiskCategory = "UngroundedAttributes"
	// RiskCategoryViolence - Represents content related to violence.
	RiskCategoryViolence RiskCategory = "Violence"
)

func PossibleRiskCategoryValues 

func PossibleRiskCategoryValues() []RiskCategory

PossibleRiskCategoryValues returns the possible values for the RiskCategory const type.

type RubricBasedEvaluatorDefinition 

type RubricBasedEvaluatorDefinition struct {
	// REQUIRED; The set of dimensions — the scoring blueprint used by the LLM judge. Quality evaluators include a non-editable
	// residual dimension with id 'general_quality' (always_applicable: true); safety evaluators include 'general_policy_compliance'.
	// Both use the same Dimension structure.
	Dimensions []Dimension

	// CONSTANT; Field has constant value EvaluatorDefinitionTypeRubric, any specified value is ignored.
	Type *EvaluatorDefinitionType

	// The JSON schema (Draft 2020-12) for the evaluator's input data. This includes parameters like type, properties, required.
	DataSchema map[string]any

	// The JSON schema (Draft 2020-12) for the evaluator's input parameters. This includes parameters like type, properties, required.
	InitParameters map[string]any

	// List of output metrics produced by this evaluator
	Metrics map[string]*EvaluatorMetric

	// Pass/fail threshold for the aggregate rubric score, on the same normalized 0.0-1.0 scale as the emitted `score`. When the
	// runtime weighted average meets or exceeds this value, the result is `pass`. Defaults to 0.5 (equivalent to a raw 1-5 weighted
	// average of 3.0). The 'any dimension scored 1 → fail' rule still applies regardless of this threshold.
	PassThreshold *float32
}

RubricBasedEvaluatorDefinition - Rubric-based evaluator definition — stores dimensions produced by the generate API. Used for both quality and safety evaluators.

func (*RubricBasedEvaluatorDefinition) GetEvaluatorDefinition 

func (r *RubricBasedEvaluatorDefinition) GetEvaluatorDefinition() *EvaluatorDefinition

GetEvaluatorDefinition implements the EvaluatorDefinitionClassification interface for type RubricBasedEvaluatorDefinition.

func (RubricBasedEvaluatorDefinition) MarshalJSON 

func (r RubricBasedEvaluatorDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RubricBasedEvaluatorDefinition.

func (*RubricBasedEvaluatorDefinition) UnmarshalJSON 

func (r *RubricBasedEvaluatorDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RubricBasedEvaluatorDefinition.

type SASCredentials 

type SASCredentials struct {
	// READ-ONLY; The credential type
	Type *CredentialType

	// READ-ONLY; SAS token
	SasToken *string
}

SASCredentials - Shared Access Signature (SAS) credential definition

func (*SASCredentials) GetBaseCredentials 

func (s *SASCredentials) GetBaseCredentials() *BaseCredentials

GetBaseCredentials implements the BaseCredentialsClassification interface for type SASCredentials.

func (SASCredentials) MarshalJSON 

func (s SASCredentials) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SASCredentials.

func (*SASCredentials) UnmarshalJSON 

func (s *SASCredentials) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SASCredentials.

type SKU 

type SKU struct {
	// REQUIRED; Sku capacity
	Capacity *int64

	// REQUIRED; Sku family
	Family *string

	// REQUIRED; Sku name
	Name *string

	// REQUIRED; Sku size
	Size *string

	// REQUIRED; Sku tier
	Tier *string
}

SKU - Sku information

func (SKU) MarshalJSON 

func (s SKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SKU.

func (*SKU) UnmarshalJSON 

func (s *SKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKU.

type SampleType 

type SampleType string

SampleType - The type of sample used in the analysis. 

const (
	// SampleTypeEvaluationResultSample - A sample from the evaluation result.
	SampleTypeEvaluationResultSample SampleType = "EvaluationResultSample"
)

func PossibleSampleTypeValues 

func PossibleSampleTypeValues() []SampleType

PossibleSampleTypeValues returns the possible values for the SampleType const type.

type Schedule 

type Schedule struct {
	// REQUIRED; Enabled status of the schedule.
	Enabled *bool

	// REQUIRED; Task for the schedule.
	Task ScheduleTaskClassification

	// REQUIRED; Trigger for the schedule.
	Trigger TriggerClassification

	// READ-ONLY; Identifier of the schedule.
	ScheduleID *string

	// READ-ONLY; System metadata for the resource.
	SystemData map[string]*string

	// Description of the schedule.
	Description *string

	// Name of the schedule.
	DisplayName *string

	// Schedule's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.
	Properties map[string]*string

	// Schedule's tags. Unlike properties, tags are fully mutable.
	Tags map[string]*string

	// READ-ONLY; Provisioning status of the schedule.
	ProvisioningStatus *ScheduleProvisioningStatus
}

Schedule model.

func (Schedule) MarshalJSON 

func (s Schedule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Schedule.

func (*Schedule) UnmarshalJSON 

func (s *Schedule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Schedule.

type ScheduleProvisioningStatus 

type ScheduleProvisioningStatus string

ScheduleProvisioningStatus - Schedule provisioning status. 

const (
	// ScheduleProvisioningStatusCreating - Represents the creation status of the schedule.
	ScheduleProvisioningStatusCreating ScheduleProvisioningStatus = "Creating"
	// ScheduleProvisioningStatusDeleting - Represents the deleting status of the schedule.
	ScheduleProvisioningStatusDeleting ScheduleProvisioningStatus = "Deleting"
	// ScheduleProvisioningStatusFailed - Represents the failed status of the schedule.
	ScheduleProvisioningStatusFailed ScheduleProvisioningStatus = "Failed"
	// ScheduleProvisioningStatusSucceeded - Represents the succeeded status of the schedule.
	ScheduleProvisioningStatusSucceeded ScheduleProvisioningStatus = "Succeeded"
	// ScheduleProvisioningStatusUpdating - Represents the updating status of the schedule.
	ScheduleProvisioningStatusUpdating ScheduleProvisioningStatus = "Updating"
)

func PossibleScheduleProvisioningStatusValues 

func PossibleScheduleProvisioningStatusValues() []ScheduleProvisioningStatus

PossibleScheduleProvisioningStatusValues returns the possible values for the ScheduleProvisioningStatus const type.

type ScheduleRun 

type ScheduleRun struct {
	// REQUIRED; Identifier of the schedule.
	ScheduleID *string

	// Trigger time of the schedule run.
	TriggerTime *time.Time

	// READ-ONLY; Properties of the schedule run.
	Properties map[string]*string

	// READ-ONLY; Identifier of the schedule run.
	RunID *string

	// READ-ONLY; Trigger success status of the schedule run.
	Success *bool

	// READ-ONLY; Error information for the schedule run.
	Error *string
}

ScheduleRun - Schedule run model.

func (ScheduleRun) MarshalJSON 

func (s ScheduleRun) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ScheduleRun.

func (*ScheduleRun) UnmarshalJSON 

func (s *ScheduleRun) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ScheduleRun.

type ScheduleTask 

type ScheduleTask struct {
	// REQUIRED; Type of the task.
	Type *ScheduleTaskType

	// Configuration for the task.
	Configuration map[string]*string
}

ScheduleTask - Schedule task model.

func (*ScheduleTask) GetScheduleTask 

func (s *ScheduleTask) GetScheduleTask() *ScheduleTask

GetScheduleTask implements the ScheduleTaskClassification interface for type ScheduleTask.

func (ScheduleTask) MarshalJSON 

func (s ScheduleTask) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ScheduleTask.

func (*ScheduleTask) UnmarshalJSON 

func (s *ScheduleTask) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ScheduleTask.

type ScheduleTaskClassification 

type ScheduleTaskClassification interface {
	// GetScheduleTask returns the ScheduleTask content of the underlying type.
	GetScheduleTask() *ScheduleTask
}

ScheduleTaskClassification provides polymorphic access to related types. Call the interface's GetScheduleTask() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *EvaluationScheduleTask, *InsightScheduleTask, *ScheduleTask

type ScheduleTaskType 

type ScheduleTaskType string

ScheduleTaskType - Type of the task. 

const (
	// ScheduleTaskTypeEvaluation - Evaluation task.
	ScheduleTaskTypeEvaluation ScheduleTaskType = "Evaluation"
	// ScheduleTaskTypeInsight - Insight task.
	ScheduleTaskTypeInsight ScheduleTaskType = "Insight"
)

func PossibleScheduleTaskTypeValues 

func PossibleScheduleTaskTypeValues() []ScheduleTaskType

PossibleScheduleTaskTypeValues returns the possible values for the ScheduleTaskType const type.

type SchedulesClient 

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

SchedulesClient contains the methods for the Schedules group. Don't use this type directly, use Client.NewSchedulesClient instead.

Generated from API version v1

func (*SchedulesClient) CreateOrUpdate 

func (client *SchedulesClient) CreateOrUpdate(ctx context.Context, scheduleID string, schedule Schedule, options *SchedulesClientCreateOrUpdateOptions) (SchedulesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update a schedule

Creates a new schedule or updates an existing schedule with the supplied definition. If the operation fails it returns an *azcore.ResponseError type.

  • scheduleID - Identifier of the schedule.
  • schedule - The resource instance.
  • options - SchedulesClientCreateOrUpdateOptions contains the optional parameters for the SchedulesClient.CreateOrUpdate method.

func (*SchedulesClient) Delete 

func (client *SchedulesClient) Delete(ctx context.Context, scheduleID string, options *SchedulesClientDeleteOptions) (SchedulesClientDeleteResponse, error)

Delete - Delete a schedule

Deletes the specified schedule resource. If the operation fails it returns an *azcore.ResponseError type.

  • scheduleID - Identifier of the schedule.
  • options - SchedulesClientDeleteOptions contains the optional parameters for the SchedulesClient.Delete method.

func (*SchedulesClient) Get 

func (client *SchedulesClient) Get(ctx context.Context, scheduleID string, options *SchedulesClientGetOptions) (SchedulesClientGetResponse, error)

Get - Get a schedule

Retrieves the specified schedule resource. If the operation fails it returns an *azcore.ResponseError type.

  • scheduleID - Identifier of the schedule.
  • options - SchedulesClientGetOptions contains the optional parameters for the SchedulesClient.Get method.

func (*SchedulesClient) GetRun 

func (client *SchedulesClient) GetRun(ctx context.Context, scheduleID string, runID string, options *SchedulesClientGetRunOptions) (SchedulesClientGetRunResponse, error)

GetRun - Get a schedule run

Retrieves the specified run for a schedule. If the operation fails it returns an *azcore.ResponseError type.

  • scheduleID - The unique identifier of the schedule.
  • runID - The unique identifier of the schedule run.
  • options - SchedulesClientGetRunOptions contains the optional parameters for the SchedulesClient.GetRun method.

func (*SchedulesClient) NewListPager 

func (client *SchedulesClient) NewListPager(options *SchedulesClientListOptions) *runtime.Pager[SchedulesClientListResponse]

NewListPager - List schedules

Returns schedules that match the supplied type and enabled filters.

  • options - SchedulesClientListOptions contains the optional parameters for the SchedulesClient.NewListPager method.

func (*SchedulesClient) NewListRunsPager 

func (client *SchedulesClient) NewListRunsPager(scheduleID string, options *SchedulesClientListRunsOptions) *runtime.Pager[SchedulesClientListRunsResponse]

NewListRunsPager - List schedule runs

Returns schedule runs that match the supplied filters.

  • scheduleID - Identifier of the schedule.
  • options - SchedulesClientListRunsOptions contains the optional parameters for the SchedulesClient.NewListRunsPager method.

type SchedulesClientCreateOrUpdateOptions 

type SchedulesClientCreateOrUpdateOptions struct {
}

SchedulesClientCreateOrUpdateOptions contains the optional parameters for the SchedulesClient.CreateOrUpdate method.

type SchedulesClientCreateOrUpdateResponse 

type SchedulesClientCreateOrUpdateResponse struct {
	// Schedule model.
	Schedule
}

SchedulesClientCreateOrUpdateResponse contains the response from method SchedulesClient.CreateOrUpdate.

type SchedulesClientDeleteOptions 

type SchedulesClientDeleteOptions struct {
}

SchedulesClientDeleteOptions contains the optional parameters for the SchedulesClient.Delete method.

type SchedulesClientDeleteResponse 

type SchedulesClientDeleteResponse struct {
}

SchedulesClientDeleteResponse contains the response from method SchedulesClient.Delete.

type SchedulesClientGetOptions 

type SchedulesClientGetOptions struct {
}

SchedulesClientGetOptions contains the optional parameters for the SchedulesClient.Get method.

type SchedulesClientGetResponse 

type SchedulesClientGetResponse struct {
	// Schedule model.
	Schedule
}

SchedulesClientGetResponse contains the response from method SchedulesClient.Get.

type SchedulesClientGetRunOptions 

type SchedulesClientGetRunOptions struct {
}

SchedulesClientGetRunOptions contains the optional parameters for the SchedulesClient.GetRun method.

type SchedulesClientGetRunResponse 

type SchedulesClientGetRunResponse struct {
	// Schedule run model.
	ScheduleRun
}

SchedulesClientGetRunResponse contains the response from method SchedulesClient.GetRun.

type SchedulesClientListOptions 

type SchedulesClientListOptions struct {
	// Filter by the enabled status.
	Enabled *bool

	// Filter by the type of schedule.
	Type *ScheduleTaskType
}

SchedulesClientListOptions contains the optional parameters for the SchedulesClient.NewListPager method.

type SchedulesClientListResponse 

type SchedulesClientListResponse struct {
	// Paged collection of Schedule items
	PagedSchedule
}

SchedulesClientListResponse contains the response from method SchedulesClient.NewListPager.

type SchedulesClientListRunsOptions 

type SchedulesClientListRunsOptions struct {
	// Filter by the enabled status.
	Enabled *bool

	// Filter by the type of schedule.
	Type *ScheduleTaskType
}

SchedulesClientListRunsOptions contains the optional parameters for the SchedulesClient.NewListRunsPager method.

type SchedulesClientListRunsResponse 

type SchedulesClientListRunsResponse struct {
	// Paged collection of ScheduleRun items
	PagedScheduleRun
}

SchedulesClientListRunsResponse contains the response from method SchedulesClient.NewListRunsPager.

type SearchContentType 

type SearchContentType string
const (
	SearchContentTypeImage SearchContentType = "image"
	SearchContentTypeText  SearchContentType = "text"
)

func PossibleSearchContentTypeValues 

func PossibleSearchContentTypeValues() []SearchContentType

PossibleSearchContentTypeValues returns the possible values for the SearchContentType const type.

type SearchContextSize 

type SearchContextSize string
const (
	SearchContextSizeHigh   SearchContextSize = "high"
	SearchContextSizeLow    SearchContextSize = "low"
	SearchContextSizeMedium SearchContextSize = "medium"
)

func PossibleSearchContextSizeValues 

func PossibleSearchContextSizeValues() []SearchContextSize

PossibleSearchContextSizeValues returns the possible values for the SearchContextSize const type.

type SharepointGroundingToolParameters 

type SharepointGroundingToolParameters struct {
	// The project connections attached to this tool. There can be a maximum of 1 connection
	// resource attached to the tool.
	ProjectConnections []ToolProjectConnection
}

SharepointGroundingToolParameters - The sharepoint grounding tool parameters.

func (SharepointGroundingToolParameters) MarshalJSON 

func (s SharepointGroundingToolParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SharepointGroundingToolParameters.

func (*SharepointGroundingToolParameters) UnmarshalJSON 

func (s *SharepointGroundingToolParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SharepointGroundingToolParameters.

type SharepointPreviewTool 

type SharepointPreviewTool struct {
	// REQUIRED; The sharepoint grounding tool parameters.
	SharepointGroundingPreview *SharepointGroundingToolParameters

	// CONSTANT; The object type, which is always 'sharepoint_grounding_preview'.
	// Field has constant value ToolTypeSharepointGroundingPreview, any specified value is ignored.
	Type *ToolType
}

SharepointPreviewTool - The input definition information for a sharepoint tool as used to configure an agent.

func (*SharepointPreviewTool) GetTool 

func (s *SharepointPreviewTool) GetTool() *Tool

GetTool implements the ToolClassification interface for type SharepointPreviewTool.

func (SharepointPreviewTool) MarshalJSON 

func (s SharepointPreviewTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SharepointPreviewTool.

func (*SharepointPreviewTool) UnmarshalJSON 

func (s *SharepointPreviewTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SharepointPreviewTool.

type SkillReferenceParam 

type SkillReferenceParam struct {
	// REQUIRED; The ID of the referenced skill.
	SkillID *string

	// CONSTANT; References a skill created with the /v1/skills endpoint.
	// Field has constant value ContainerSkillTypeSkillReference, any specified value is ignored.
	Type *ContainerSkillType

	// Optional skill version. Use a positive integer or 'latest'. Omit for default.
	Version *string
}

func (*SkillReferenceParam) GetContainerSkill 

func (s *SkillReferenceParam) GetContainerSkill() *ContainerSkill

GetContainerSkill implements the ContainerSkillClassification interface for type SkillReferenceParam.

func (SkillReferenceParam) MarshalJSON 

func (s SkillReferenceParam) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SkillReferenceParam.

func (*SkillReferenceParam) UnmarshalJSON 

func (s *SkillReferenceParam) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SkillReferenceParam.

type StructuredOutputDefinition 

type StructuredOutputDefinition struct {
	// REQUIRED; A description of the output to emit. Used by the model to determine when to emit the output.
	Description *string

	// REQUIRED; The name of the structured output.
	Name *string

	// REQUIRED; The JSON schema for the structured output.
	Schema map[string]any

	// REQUIRED; Whether to enforce strict validation. Default `true`.
	Strict *bool
}

StructuredOutputDefinition - A structured output that can be produced by the agent.

func (StructuredOutputDefinition) MarshalJSON 

func (s StructuredOutputDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StructuredOutputDefinition.

func (*StructuredOutputDefinition) UnmarshalJSON 

func (s *StructuredOutputDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StructuredOutputDefinition.

type Target 

type Target struct {
	// REQUIRED; The type of target.
	Type *string
}

Target - Base class for targets with discriminator support.

func (*Target) GetTarget 

func (t *Target) GetTarget() *Target

GetTarget implements the TargetClassification interface for type Target.

func (Target) MarshalJSON 

func (t Target) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Target.

func (*Target) UnmarshalJSON 

func (t *Target) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Target.

type TargetClassification 

type TargetClassification interface {
	// GetTarget returns the Target content of the underlying type.
	GetTarget() *Target
}

TargetClassification provides polymorphic access to related types. Call the interface's GetTarget() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AzureAIAgentTarget, *AzureAIModelTarget, *Target

type TaxonomyCategory 

type TaxonomyCategory struct {
	// REQUIRED; Unique identifier of the taxonomy category.
	ID *string

	// REQUIRED; Name of the taxonomy category.
	Name *string

	// REQUIRED; Risk category associated with this taxonomy category.
	RiskCategory *RiskCategory

	// REQUIRED; List of taxonomy sub categories.
	SubCategories []TaxonomySubCategory

	// Description of the taxonomy category.
	Description *string

	// Additional properties for the taxonomy category.
	Properties map[string]*string
}

TaxonomyCategory - Taxonomy category definition.

func (TaxonomyCategory) MarshalJSON 

func (t TaxonomyCategory) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TaxonomyCategory.

func (*TaxonomyCategory) UnmarshalJSON 

func (t *TaxonomyCategory) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TaxonomyCategory.

type TaxonomySubCategory 

type TaxonomySubCategory struct {
	// REQUIRED; List of taxonomy items under this sub-category.
	Enabled *bool

	// REQUIRED; Unique identifier of the taxonomy sub-category.
	ID *string

	// REQUIRED; Name of the taxonomy sub-category.
	Name *string

	// Description of the taxonomy sub-category.
	Description *string

	// Additional properties for the taxonomy sub-category.
	Properties map[string]*string
}

TaxonomySubCategory - Taxonomy sub-category definition.

func (TaxonomySubCategory) MarshalJSON 

func (t TaxonomySubCategory) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TaxonomySubCategory.

func (*TaxonomySubCategory) UnmarshalJSON 

func (t *TaxonomySubCategory) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TaxonomySubCategory.

type Tool 

type Tool struct {
	// REQUIRED
	Type *ToolType
}

Tool - A tool that can be used to generate a response.

func (*Tool) GetTool 

func (t *Tool) GetTool() *Tool

GetTool implements the ToolClassification interface for type Tool.

func (Tool) MarshalJSON 

func (t Tool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Tool.

func (*Tool) UnmarshalJSON 

func (t *Tool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Tool.

type ToolClassification 

type ToolClassification interface {
	// GetTool returns the Tool content of the underlying type.
	GetTool() *Tool
}

ToolClassification provides polymorphic access to related types. Call the interface's GetTool() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *A2APreviewTool, *ApplyPatchToolParam, *AzureAISearchTool, *AzureFunctionTool, *BingCustomSearchPreviewTool, *BingGroundingTool, - *BrowserAutomationPreviewTool, *CaptureStructuredOutputsTool, *CodeInterpreterTool, *ComputerTool, *ComputerUsePreviewTool, - *CustomToolParam, *FabricIQPreviewTool, *FileSearchTool, *FunctionShellToolParam, *FunctionTool, *ImageGenTool, *LocalShellToolParam, - *MCPTool, *MemorySearchPreviewTool, *MicrosoftFabricPreviewTool, *NamespaceToolParam, *OpenAPITool, *ReminderPreviewTool, - *SharepointPreviewTool, *Tool, *ToolSearchToolParam, *WebSearchPreviewTool, *WebSearchTool, *WorkIQPreviewTool

type ToolConfig 

type ToolConfig struct {
	// Additional text indexed for tool_search. Supplements the native tool description
	// to improve discoverability. Does not alter `tools/list` output.
	AdditionalSearchText *string

	// When true, the tool is always included in agent context and visible in `tools/list`.
	// When false (default), the tool is hidden from `tools/list` and only discoverable via `tool_search`.
	Pin *bool
}

ToolConfig - Per-tool configuration that controls tool visibility and search behavior.

func (ToolConfig) MarshalJSON 

func (t ToolConfig) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ToolConfig.

func (*ToolConfig) UnmarshalJSON 

func (t *ToolConfig) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ToolConfig.

type ToolDescription 

type ToolDescription struct {
	// A brief description of the tool's purpose.
	Description *string

	// The name of the tool.
	Name *string
}

ToolDescription - Description of a tool that can be used by an agent.

func (ToolDescription) MarshalJSON 

func (t ToolDescription) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ToolDescription.

func (*ToolDescription) UnmarshalJSON 

func (t *ToolDescription) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ToolDescription.

type ToolProjectConnection 

type ToolProjectConnection struct {
	// REQUIRED; A project connection in a ToolProjectConnectionList attached to this tool.
	ProjectConnectionID *string
}

ToolProjectConnection - A project connection resource.

func (ToolProjectConnection) MarshalJSON 

func (t ToolProjectConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ToolProjectConnection.

func (*ToolProjectConnection) UnmarshalJSON 

func (t *ToolProjectConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ToolProjectConnection.

type ToolSearchExecutionType 

type ToolSearchExecutionType string
const (
	ToolSearchExecutionTypeClient ToolSearchExecutionType = "client"
	ToolSearchExecutionTypeServer ToolSearchExecutionType = "server"
)

func PossibleToolSearchExecutionTypeValues 

func PossibleToolSearchExecutionTypeValues() []ToolSearchExecutionType

PossibleToolSearchExecutionTypeValues returns the possible values for the ToolSearchExecutionType const type.

type ToolSearchToolParam 

type ToolSearchToolParam struct {
	// CONSTANT; The type of the tool. Always `tool_search`.
	// Field has constant value ToolTypeToolSearch, any specified value is ignored.
	Type        *ToolType
	Description *string

	// Whether tool search is executed by the server or by the client.
	Execution  *ToolSearchExecutionType
	Parameters *EmptyModelParam
}

ToolSearchToolParam - Tool search tool

Hosted or BYOT tool search configuration for deferred tools.

func (*ToolSearchToolParam) GetTool 

func (t *ToolSearchToolParam) GetTool() *Tool

GetTool implements the ToolClassification interface for type ToolSearchToolParam.

func (ToolSearchToolParam) MarshalJSON 

func (t ToolSearchToolParam) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ToolSearchToolParam.

func (*ToolSearchToolParam) UnmarshalJSON 

func (t *ToolSearchToolParam) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ToolSearchToolParam.

type ToolType 

type ToolType string
const (
	ToolTypeA2APreview                 ToolType = "a2a_preview"
	ToolTypeApplyPatch                 ToolType = "apply_patch"
	ToolTypeAzureAiSearch              ToolType = "azure_ai_search"
	ToolTypeAzureFunction              ToolType = "azure_function"
	ToolTypeBingCustomSearchPreview    ToolType = "bing_custom_search_preview"
	ToolTypeBingGrounding              ToolType = "bing_grounding"
	ToolTypeBrowserAutomationPreview   ToolType = "browser_automation_preview"
	ToolTypeCaptureStructuredOutputs   ToolType = "capture_structured_outputs"
	ToolTypeCodeInterpreter            ToolType = "code_interpreter"
	ToolTypeComputer                   ToolType = "computer"
	ToolTypeComputerUsePreview         ToolType = "computer_use_preview"
	ToolTypeCustom                     ToolType = "custom"
	ToolTypeFabricDataagentPreview     ToolType = "fabric_dataagent_preview"
	ToolTypeFabricIqPreview            ToolType = "fabric_iq_preview"
	ToolTypeFileSearch                 ToolType = "file_search"
	ToolTypeFunction                   ToolType = "function"
	ToolTypeImageGeneration            ToolType = "image_generation"
	ToolTypeLocalShell                 ToolType = "local_shell"
	ToolTypeMcp                        ToolType = "mcp"
	ToolTypeMemorySearchPreview        ToolType = "memory_search_preview"
	ToolTypeNamespace                  ToolType = "namespace"
	ToolTypeOpenapi                    ToolType = "openapi"
	ToolTypeReminderPreview            ToolType = "reminder_preview"
	ToolTypeSharepointGroundingPreview ToolType = "sharepoint_grounding_preview"
	ToolTypeShell                      ToolType = "shell"
	ToolTypeToolSearch                 ToolType = "tool_search"
	ToolTypeToolboxSearchPreview       ToolType = "toolbox_search_preview"
	ToolTypeWebSearch                  ToolType = "web_search"
	ToolTypeWebSearchPreview           ToolType = "web_search_preview"
	ToolTypeWorkIqPreview              ToolType = "work_iq_preview"
)

func PossibleToolTypeValues 

func PossibleToolTypeValues() []ToolType

PossibleToolTypeValues returns the possible values for the ToolType const type.

type ToolboxObject 

type ToolboxObject struct {
	// REQUIRED; The version identifier that the toolbox currently points to. Defaults to the latest version. Can be changed via
	// updateToolbox.
	DefaultVersion *string

	// REQUIRED; The unique identifier of the toolbox.
	ID *string

	// REQUIRED; The name of the toolbox.
	Name *string
}

ToolboxObject - A toolbox that stores reusable tool definitions for agents.

func (ToolboxObject) MarshalJSON 

func (t ToolboxObject) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ToolboxObject.

func (*ToolboxObject) UnmarshalJSON 

func (t *ToolboxObject) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ToolboxObject.

type ToolboxPolicies 

type ToolboxPolicies struct {
	// Responsible AI content filtering configuration.
	RaiConfig *RaiConfig
}

ToolboxPolicies - Policy configuration for a toolbox, including content safety and other governance settings.

func (ToolboxPolicies) MarshalJSON 

func (t ToolboxPolicies) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ToolboxPolicies.

func (*ToolboxPolicies) UnmarshalJSON 

func (t *ToolboxPolicies) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ToolboxPolicies.

type ToolboxSearchPreviewToolboxTool 

type ToolboxSearchPreviewToolboxTool struct {
	// CONSTANT; The type of the tool. Always `toolbox_search_preview`.
	// Field has constant value ToolboxToolTypeToolboxSearchPreview, any specified value is ignored.
	Type *ToolboxToolType

	// Optional user-defined description for this tool or configuration.
	Description *string

	// Optional user-defined name for this tool or configuration.
	Name *string

	// Per-tool configuration map. Keys are tool names or `*` (catch-all default).
	// Resolution order: exact tool name match takes priority over `*`.
	// Unknown tool names are silently ignored at runtime.
	ToolConfigs map[string]*ToolConfig
}

ToolboxSearchPreviewToolboxTool - A toolbox search tool stored in a toolbox.

func (*ToolboxSearchPreviewToolboxTool) GetToolboxTool 

func (t *ToolboxSearchPreviewToolboxTool) GetToolboxTool() *ToolboxTool

GetToolboxTool implements the ToolboxToolClassification interface for type ToolboxSearchPreviewToolboxTool.

func (ToolboxSearchPreviewToolboxTool) MarshalJSON 

func (t ToolboxSearchPreviewToolboxTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ToolboxSearchPreviewToolboxTool.

func (*ToolboxSearchPreviewToolboxTool) UnmarshalJSON 

func (t *ToolboxSearchPreviewToolboxTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ToolboxSearchPreviewToolboxTool.

type ToolboxSkill 

type ToolboxSkill struct {
	// REQUIRED; The type of skill source.
	Type *string
}

ToolboxSkill - A skill source included in a toolbox.

func (*ToolboxSkill) GetToolboxSkill 

func (t *ToolboxSkill) GetToolboxSkill() *ToolboxSkill

GetToolboxSkill implements the ToolboxSkillClassification interface for type ToolboxSkill.

func (ToolboxSkill) MarshalJSON 

func (t ToolboxSkill) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ToolboxSkill.

func (*ToolboxSkill) UnmarshalJSON 

func (t *ToolboxSkill) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ToolboxSkill.

type ToolboxSkillClassification 

type ToolboxSkillClassification interface {
	// GetToolboxSkill returns the ToolboxSkill content of the underlying type.
	GetToolboxSkill() *ToolboxSkill
}

ToolboxSkillClassification provides polymorphic access to related types. Call the interface's GetToolboxSkill() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *ToolboxSkill, *ToolboxSkillReference

type ToolboxSkillReference 

type ToolboxSkillReference struct {
	// REQUIRED; The name of the skill.
	Name *string

	// CONSTANT; The type of skill source.
	// Field has constant value "skill_reference", any specified value is ignored.
	Type *string

	// The version of the skill. If not specified, the skill's default version is used. When a version is specified, the reference
	// is pinned to that immutable version.
	Version *string
}

ToolboxSkillReference - A reference to an existing skill to include in a toolbox.

func (*ToolboxSkillReference) GetToolboxSkill 

func (t *ToolboxSkillReference) GetToolboxSkill() *ToolboxSkill

GetToolboxSkill implements the ToolboxSkillClassification interface for type ToolboxSkillReference.

func (ToolboxSkillReference) MarshalJSON 

func (t ToolboxSkillReference) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ToolboxSkillReference.

func (*ToolboxSkillReference) UnmarshalJSON 

func (t *ToolboxSkillReference) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ToolboxSkillReference.

type ToolboxTool 

type ToolboxTool struct {
	// REQUIRED; The type of tool.
	Type *ToolboxToolType

	// Optional user-defined description for this tool or configuration.
	Description *string

	// Optional user-defined name for this tool or configuration.
	Name *string

	// Per-tool configuration map. Keys are tool names or `*` (catch-all default).
	// Resolution order: exact tool name match takes priority over `*`.
	// Unknown tool names are silently ignored at runtime.
	ToolConfigs map[string]*ToolConfig
}

ToolboxTool - An abstract representation of a tool stored in a toolbox.

func (*ToolboxTool) GetToolboxTool 

func (t *ToolboxTool) GetToolboxTool() *ToolboxTool

GetToolboxTool implements the ToolboxToolClassification interface for type ToolboxTool.

func (ToolboxTool) MarshalJSON 

func (t ToolboxTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ToolboxTool.

func (*ToolboxTool) UnmarshalJSON 

func (t *ToolboxTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ToolboxTool.

type ToolboxToolClassification 

type ToolboxToolClassification interface {
	// GetToolboxTool returns the ToolboxTool content of the underlying type.
	GetToolboxTool() *ToolboxTool
}

ToolboxToolClassification provides polymorphic access to related types. Call the interface's GetToolboxTool() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *A2APreviewToolboxTool, *AzureAISearchToolboxTool, *BrowserAutomationPreviewToolboxTool, *CodeInterpreterToolboxTool, - *FabricIQPreviewToolboxTool, *FileSearchToolboxTool, *MCPToolboxTool, *OpenAPIToolboxTool, *ReminderPreviewToolboxTool, - *ToolboxSearchPreviewToolboxTool, *ToolboxTool, *WebSearchToolboxTool, *WorkIQPreviewToolboxTool

type ToolboxToolType 

type ToolboxToolType string

ToolboxToolType - Supported tool types for tools stored in a toolbox. 

const (
	ToolboxToolTypeA2APreview               ToolboxToolType = "a2a_preview"
	ToolboxToolTypeAzureAiSearch            ToolboxToolType = "azure_ai_search"
	ToolboxToolTypeBrowserAutomationPreview ToolboxToolType = "browser_automation_preview"
	ToolboxToolTypeCodeInterpreter          ToolboxToolType = "code_interpreter"
	ToolboxToolTypeFabricIqPreview          ToolboxToolType = "fabric_iq_preview"
	ToolboxToolTypeFileSearch               ToolboxToolType = "file_search"
	ToolboxToolTypeMcp                      ToolboxToolType = "mcp"
	ToolboxToolTypeOpenapi                  ToolboxToolType = "openapi"
	ToolboxToolTypeReminderPreview          ToolboxToolType = "reminder_preview"
	ToolboxToolTypeToolboxSearchPreview     ToolboxToolType = "toolbox_search_preview"
	ToolboxToolTypeWebSearch                ToolboxToolType = "web_search"
	ToolboxToolTypeWorkIqPreview            ToolboxToolType = "work_iq_preview"
)

func PossibleToolboxToolTypeValues 

func PossibleToolboxToolTypeValues() []ToolboxToolType

PossibleToolboxToolTypeValues returns the possible values for the ToolboxToolType const type.

type ToolboxVersionObject 

type ToolboxVersionObject struct {
	// REQUIRED; The Unix timestamp (seconds) when the toolbox version was created.
	CreatedAt *time.Time

	// REQUIRED; The unique identifier of the toolbox version.
	ID *string

	// REQUIRED; Set of 16 key-value pairs that can be attached to an object. This can be
	// useful for storing additional information about the object in a structured
	// format, and querying for objects via API or the dashboard.
	// Keys are strings with a maximum length of 64 characters. Values are strings
	// with a maximum length of 512 characters.
	Metadata map[string]*string

	// REQUIRED; The name of the toolbox.
	Name *string

	// REQUIRED; The list of tools contained in this toolbox version.
	Tools []ToolboxToolClassification

	// REQUIRED; The version identifier of the toolbox. Toolbox versions are immutable and every update creates a new version.
	Version *string

	// A human-readable description of the toolbox.
	Description *string

	// Policy configuration for the toolbox version.
	Policies *ToolboxPolicies

	// The list of skill sources included in this toolbox version.
	Skills []ToolboxSkillClassification
}

ToolboxVersionObject - A specific version of a toolbox.

func (ToolboxVersionObject) MarshalJSON 

func (t ToolboxVersionObject) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ToolboxVersionObject.

func (*ToolboxVersionObject) UnmarshalJSON 

func (t *ToolboxVersionObject) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ToolboxVersionObject.

type ToolboxesClient 

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

ToolboxesClient contains the methods for the Toolboxes group. Don't use this type directly, use Client.NewToolboxesClient instead.

Generated from API version v1

func (*ToolboxesClient) CreateToolboxVersion 

func (client *ToolboxesClient) CreateToolboxVersion(ctx context.Context, name string, tools []ToolboxToolClassification, options *ToolboxesClientCreateToolboxVersionOptions) (ToolboxesClientCreateToolboxVersionResponse, error)

CreateToolboxVersion - Create a new version of a toolbox

Creates a new toolbox version, provisioning the toolbox itself if it does not already exist. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the toolbox. If the toolbox does not exist, it will be created.
  • tools - The list of tools to include in this version.
  • options - ToolboxesClientCreateToolboxVersionOptions contains the optional parameters for the ToolboxesClient.CreateToolboxVersion method.

func (*ToolboxesClient) DeleteToolbox 

func (client *ToolboxesClient) DeleteToolbox(ctx context.Context, name string, options *ToolboxesClientDeleteToolboxOptions) (ToolboxesClientDeleteToolboxResponse, error)

DeleteToolbox - Delete a toolbox

Removes the specified toolbox along with all of its versions. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the toolbox to delete.
  • options - ToolboxesClientDeleteToolboxOptions contains the optional parameters for the ToolboxesClient.DeleteToolbox method.

func (*ToolboxesClient) DeleteToolboxVersion 

func (client *ToolboxesClient) DeleteToolboxVersion(ctx context.Context, name string, version string, options *ToolboxesClientDeleteToolboxVersionOptions) (ToolboxesClientDeleteToolboxVersionResponse, error)

DeleteToolboxVersion - Delete a specific version of a toolbox

Removes the specified version of a toolbox. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the toolbox.
  • version - The version identifier to delete.
  • options - ToolboxesClientDeleteToolboxVersionOptions contains the optional parameters for the ToolboxesClient.DeleteToolboxVersion method.

func (*ToolboxesClient) GetToolbox 

func (client *ToolboxesClient) GetToolbox(ctx context.Context, name string, options *ToolboxesClientGetToolboxOptions) (ToolboxesClientGetToolboxResponse, error)

GetToolbox - Retrieve a toolbox

Retrieves the specified toolbox and its current configuration. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the toolbox to retrieve.
  • options - ToolboxesClientGetToolboxOptions contains the optional parameters for the ToolboxesClient.GetToolbox method.

func (*ToolboxesClient) GetToolboxVersion 

func (client *ToolboxesClient) GetToolboxVersion(ctx context.Context, name string, version string, options *ToolboxesClientGetToolboxVersionOptions) (ToolboxesClientGetToolboxVersionResponse, error)

GetToolboxVersion - Retrieve a specific version of a toolbox

Retrieves the specified version of a toolbox by name and version identifier. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the toolbox.
  • version - The version identifier to retrieve.
  • options - ToolboxesClientGetToolboxVersionOptions contains the optional parameters for the ToolboxesClient.GetToolboxVersion method.

func (*ToolboxesClient) NewListToolboxVersionsPager 

func (client *ToolboxesClient) NewListToolboxVersionsPager(name string, options *ToolboxesClientListToolboxVersionsOptions) *runtime.Pager[ToolboxesClientListToolboxVersionsResponse]

NewListToolboxVersionsPager - List toolbox versions

Returns the available versions for the specified toolbox.

  • name - The name of the toolbox to list versions for.
  • options - ToolboxesClientListToolboxVersionsOptions contains the optional parameters for the ToolboxesClient.NewListToolboxVersionsPager method.

func (*ToolboxesClient) NewListToolboxesPager 

func (client *ToolboxesClient) NewListToolboxesPager(options *ToolboxesClientListToolboxesOptions) *runtime.Pager[ToolboxesClientListToolboxesResponse]

NewListToolboxesPager - List toolboxes

Returns the toolboxes available in the current project.

  • options - ToolboxesClientListToolboxesOptions contains the optional parameters for the ToolboxesClient.NewListToolboxesPager method.

func (*ToolboxesClient) UpdateToolbox 

func (client *ToolboxesClient) UpdateToolbox(ctx context.Context, name string, defaultVersion string, options *ToolboxesClientUpdateToolboxOptions) (ToolboxesClientUpdateToolboxResponse, error)

UpdateToolbox - Update a toolbox to point to a specific version

Updates the toolbox's default version pointer to the specified version. If the operation fails it returns an *azcore.ResponseError type.

  • name - The name of the toolbox to update.
  • defaultVersion - The version identifier that the toolbox should point to. When set, the toolbox's default version will resolve to this version instead of the latest.
  • options - ToolboxesClientUpdateToolboxOptions contains the optional parameters for the ToolboxesClient.UpdateToolbox method.

type ToolboxesClientCreateToolboxVersionOptions 

type ToolboxesClientCreateToolboxVersionOptions struct {
	// A human-readable description of the toolbox.
	Description *string

	// Arbitrary key-value metadata to associate with the toolbox.
	Metadata map[string]*string

	// Policy configuration for this toolbox version.
	Policies *ToolboxPolicies

	// The list of skill sources to include in this version. A skill reference specifies a skill name and optionally a version.
	// If version is omitted, the skill's default version is used.
	Skills []ToolboxSkillClassification
}

ToolboxesClientCreateToolboxVersionOptions contains the optional parameters for the ToolboxesClient.CreateToolboxVersion method.

type ToolboxesClientCreateToolboxVersionResponse 

type ToolboxesClientCreateToolboxVersionResponse struct {
	// A specific version of a toolbox.
	ToolboxVersionObject
}

ToolboxesClientCreateToolboxVersionResponse contains the response from method ToolboxesClient.CreateToolboxVersion.

type ToolboxesClientDeleteToolboxOptions 

type ToolboxesClientDeleteToolboxOptions struct {
}

ToolboxesClientDeleteToolboxOptions contains the optional parameters for the ToolboxesClient.DeleteToolbox method.

type ToolboxesClientDeleteToolboxResponse 

type ToolboxesClientDeleteToolboxResponse struct {
}

ToolboxesClientDeleteToolboxResponse contains the response from method ToolboxesClient.DeleteToolbox.

type ToolboxesClientDeleteToolboxVersionOptions 

type ToolboxesClientDeleteToolboxVersionOptions struct {
}

ToolboxesClientDeleteToolboxVersionOptions contains the optional parameters for the ToolboxesClient.DeleteToolboxVersion method.

type ToolboxesClientDeleteToolboxVersionResponse 

type ToolboxesClientDeleteToolboxVersionResponse struct {
}

ToolboxesClientDeleteToolboxVersionResponse contains the response from method ToolboxesClient.DeleteToolboxVersion.

type ToolboxesClientGetToolboxOptions 

type ToolboxesClientGetToolboxOptions struct {
}

ToolboxesClientGetToolboxOptions contains the optional parameters for the ToolboxesClient.GetToolbox method.

type ToolboxesClientGetToolboxResponse 

type ToolboxesClientGetToolboxResponse struct {
	// A toolbox that stores reusable tool definitions for agents.
	ToolboxObject
}

ToolboxesClientGetToolboxResponse contains the response from method ToolboxesClient.GetToolbox.

type ToolboxesClientGetToolboxVersionOptions 

type ToolboxesClientGetToolboxVersionOptions struct {
}

ToolboxesClientGetToolboxVersionOptions contains the optional parameters for the ToolboxesClient.GetToolboxVersion method.

type ToolboxesClientGetToolboxVersionResponse 

type ToolboxesClientGetToolboxVersionResponse struct {
	// A specific version of a toolbox.
	ToolboxVersionObject
}

ToolboxesClientGetToolboxVersionResponse contains the response from method ToolboxesClient.GetToolboxVersion.

type ToolboxesClientListToolboxVersionsOptions 

type ToolboxesClientListToolboxVersionsOptions struct {
	// A cursor for use in pagination. `after` is an object ID that defines your place in the list.
	// For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
	// subsequent call can include after=obj_foo in order to fetch the next page of the list.
	After *string

	// A cursor for use in pagination. `before` is an object ID that defines your place in the list.
	// For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
	// subsequent call can include before=obj_foo in order to fetch the previous page of the list.
	Before *string

	// A limit on the number of objects to be returned. Limit can range between 1 and 100, and the
	// default is 20.
	Limit *int32

	// Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`
	// for descending order.
	Order *PageOrder
}

ToolboxesClientListToolboxVersionsOptions contains the optional parameters for the ToolboxesClient.NewListToolboxVersionsPager method.

type ToolboxesClientListToolboxVersionsResponse 

type ToolboxesClientListToolboxVersionsResponse struct {
	// The response data for a requested list of items.
	AgentsPagedResultToolboxVersionObject
}

ToolboxesClientListToolboxVersionsResponse contains the response from method ToolboxesClient.NewListToolboxVersionsPager.

type ToolboxesClientListToolboxesOptions 

type ToolboxesClientListToolboxesOptions struct {
	// A cursor for use in pagination. `after` is an object ID that defines your place in the list.
	// For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
	// subsequent call can include after=obj_foo in order to fetch the next page of the list.
	After *string

	// A cursor for use in pagination. `before` is an object ID that defines your place in the list.
	// For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
	// subsequent call can include before=obj_foo in order to fetch the previous page of the list.
	Before *string

	// A limit on the number of objects to be returned. Limit can range between 1 and 100, and the
	// default is 20.
	Limit *int32

	// Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`
	// for descending order.
	Order *PageOrder
}

ToolboxesClientListToolboxesOptions contains the optional parameters for the ToolboxesClient.NewListToolboxesPager method.

type ToolboxesClientListToolboxesResponse 

type ToolboxesClientListToolboxesResponse struct {
	// The response data for a requested list of items.
	AgentsPagedResultToolboxObject
}

ToolboxesClientListToolboxesResponse contains the response from method ToolboxesClient.NewListToolboxesPager.

type ToolboxesClientUpdateToolboxOptions 

type ToolboxesClientUpdateToolboxOptions struct {
}

ToolboxesClientUpdateToolboxOptions contains the optional parameters for the ToolboxesClient.UpdateToolbox method.

type ToolboxesClientUpdateToolboxResponse 

type ToolboxesClientUpdateToolboxResponse struct {
	// A toolbox that stores reusable tool definitions for agents.
	ToolboxObject
}

ToolboxesClientUpdateToolboxResponse contains the response from method ToolboxesClient.UpdateToolbox.

type TracesEvaluatorGenerationJobSource 

type TracesEvaluatorGenerationJobSource struct {
	// REQUIRED; Start of the time window (Unix timestamp in seconds) for fetching traces.
	StartTime *time.Time

	// CONSTANT; The source type for this source, which is Traces.
	// Field has constant value EvaluatorGenerationJobSourceTypeTraces, any specified value is ignored.
	Type *EvaluatorGenerationJobSourceType

	// The unique agent ID used to filter traces. Provide either `agent_id` or `agent_name` — at least one is required.
	AgentID *string

	// The agent name to fetch traces for. Provide either `agent_id` or `agent_name` — at least one is required.
	AgentName *string

	// The agent version. If not specified, traces for ALL versions of the agent are included within the time window.
	AgentVersion *string

	// Optional description of what this source represents — helps the pipeline interpret its content (e.g., 'Company refund policy
	// document' or 'Describes the agent's core capabilities').
	Description *string

	// End of the time window (Unix timestamp in seconds). Defaults to current time.
	EndTime *time.Time
}

TracesEvaluatorGenerationJobSource - Traces source for evaluator generation jobs — conversation traces from Application Insights.

func (*TracesEvaluatorGenerationJobSource) GetEvaluatorGenerationJobSource 

func (t *TracesEvaluatorGenerationJobSource) GetEvaluatorGenerationJobSource() *EvaluatorGenerationJobSource

GetEvaluatorGenerationJobSource implements the EvaluatorGenerationJobSourceClassification interface for type TracesEvaluatorGenerationJobSource.

func (TracesEvaluatorGenerationJobSource) MarshalJSON 

func (t TracesEvaluatorGenerationJobSource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TracesEvaluatorGenerationJobSource.

func (*TracesEvaluatorGenerationJobSource) UnmarshalJSON 

func (t *TracesEvaluatorGenerationJobSource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TracesEvaluatorGenerationJobSource.

type TreatmentEffectType 

type TreatmentEffectType string

TreatmentEffectType - Treatment Effect Type. 

const (
	// TreatmentEffectTypeChanged - Indicates the metric changed with statistical significance, but the direction is neutral.
	TreatmentEffectTypeChanged TreatmentEffectType = "Changed"
	// TreatmentEffectTypeDegraded - Indicates the treatment significantly degraded the metric compared to baseline.
	TreatmentEffectTypeDegraded TreatmentEffectType = "Degraded"
	// TreatmentEffectTypeImproved - Indicates the treatment significantly improved the metric compared to baseline.
	TreatmentEffectTypeImproved TreatmentEffectType = "Improved"
	// TreatmentEffectTypeInconclusive - No significant difference between treatment and baseline.
	TreatmentEffectTypeInconclusive TreatmentEffectType = "Inconclusive"
	// TreatmentEffectTypeTooFewSamples - Not enough samples to determine treatment effect.
	TreatmentEffectTypeTooFewSamples TreatmentEffectType = "TooFewSamples"
)

func PossibleTreatmentEffectTypeValues 

func PossibleTreatmentEffectTypeValues() []TreatmentEffectType

PossibleTreatmentEffectTypeValues returns the possible values for the TreatmentEffectType const type.

type Trigger 

type Trigger struct {
	// REQUIRED; Type of the trigger.
	Type *TriggerType
}

Trigger - Base model for Trigger of the schedule.

func (*Trigger) GetTrigger 

func (t *Trigger) GetTrigger() *Trigger

GetTrigger implements the TriggerClassification interface for type Trigger.

func (Trigger) MarshalJSON 

func (t Trigger) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Trigger.

func (*Trigger) UnmarshalJSON 

func (t *Trigger) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Trigger.

type TriggerClassification 

type TriggerClassification interface {
	// GetTrigger returns the Trigger content of the underlying type.
	GetTrigger() *Trigger
}

TriggerClassification provides polymorphic access to related types. Call the interface's GetTrigger() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *CronTrigger, *OneTimeTrigger, *RecurrenceTrigger, *Trigger

type TriggerType 

type TriggerType string

TriggerType - Type of the trigger. 

const (
	// TriggerTypeCron - Cron based trigger.
	TriggerTypeCron TriggerType = "Cron"
	// TriggerTypeOneTime - One-time trigger.
	TriggerTypeOneTime TriggerType = "OneTime"
	// TriggerTypeRecurrence - Recurrence based trigger.
	TriggerTypeRecurrence TriggerType = "Recurrence"
)

func PossibleTriggerTypeValues 

func PossibleTriggerTypeValues() []TriggerType

PossibleTriggerTypeValues returns the possible values for the TriggerType const type.

type UpdateToolboxRequest 

type UpdateToolboxRequest struct {
	// REQUIRED; The version identifier that the toolbox should point to. When set, the toolbox's default version will resolve
	// to this version instead of the latest.
	DefaultVersion *string
}

func (UpdateToolboxRequest) MarshalJSON 

func (u UpdateToolboxRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UpdateToolboxRequest.

func (*UpdateToolboxRequest) UnmarshalJSON 

func (u *UpdateToolboxRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateToolboxRequest.

type UserProfileMemoryItem 

type UserProfileMemoryItem struct {
	// REQUIRED; The content of the memory.
	Content *string

	// REQUIRED; The kind of the memory item.
	Kind *MemoryItemKind

	// REQUIRED; The unique ID of the memory item.
	MemoryID *string

	// REQUIRED; The namespace that logically groups and isolates memories, such as a user ID.
	Scope *string

	// REQUIRED; The last update time of the memory item.
	UpdatedAt *time.Time
}

UserProfileMemoryItem - A memory item specifically containing user profile information extracted from conversations, such as preferences, interests, and personal details.

func (*UserProfileMemoryItem) GetMemoryItem 

func (u *UserProfileMemoryItem) GetMemoryItem() *MemoryItem

GetMemoryItem implements the MemoryItemClassification interface for type UserProfileMemoryItem.

func (UserProfileMemoryItem) MarshalJSON 

func (u UserProfileMemoryItem) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserProfileMemoryItem.

func (*UserProfileMemoryItem) UnmarshalJSON 

func (u *UserProfileMemoryItem) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserProfileMemoryItem.

type WebSearchApproximateLocation 

type WebSearchApproximateLocation struct {
	// CONSTANT; The type of location approximation. Always `approximate`.
	// Field has constant value "approximate", any specified value is ignored.
	Type     *string
	City     *string
	Country  *string
	Region   *string
	Timezone *string
}

WebSearchApproximateLocation - Web search approximate location

The approximate location of the user.

func (WebSearchApproximateLocation) MarshalJSON 

func (w WebSearchApproximateLocation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WebSearchApproximateLocation.

func (*WebSearchApproximateLocation) UnmarshalJSON 

func (w *WebSearchApproximateLocation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WebSearchApproximateLocation.

type WebSearchConfiguration 

type WebSearchConfiguration struct {
	// REQUIRED; Name of the custom configuration instance given to config.
	InstanceName *string

	// REQUIRED; Project connection id for grounding with bing custom search
	ProjectConnectionID *string
}

WebSearchConfiguration - A web search configuration for bing custom search

func (WebSearchConfiguration) MarshalJSON 

func (w WebSearchConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WebSearchConfiguration.

func (*WebSearchConfiguration) UnmarshalJSON 

func (w *WebSearchConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WebSearchConfiguration.

type WebSearchPreviewTool 

type WebSearchPreviewTool struct {
	// CONSTANT; The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`.
	// Field has constant value ToolTypeWebSearchPreview, any specified value is ignored.
	Type               *ToolType
	SearchContentTypes []SearchContentType

	// High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium`
	// is the default.
	SearchContextSize *SearchContextSize
	UserLocation      *ApproximateLocation
}

WebSearchPreviewTool - Web search preview

This tool searches the web for relevant results to use in a response. Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search).

func (*WebSearchPreviewTool) GetTool 

func (w *WebSearchPreviewTool) GetTool() *Tool

GetTool implements the ToolClassification interface for type WebSearchPreviewTool.

func (WebSearchPreviewTool) MarshalJSON 

func (w WebSearchPreviewTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WebSearchPreviewTool.

func (*WebSearchPreviewTool) UnmarshalJSON 

func (w *WebSearchPreviewTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WebSearchPreviewTool.

type WebSearchTool 

type WebSearchTool struct {
	// CONSTANT; The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.
	// Field has constant value ToolTypeWebSearch, any specified value is ignored.
	Type *ToolType

	// The project connections attached to this tool. There can be a maximum of 1 connection
	// resource attached to the tool.
	CustomSearchConfiguration *WebSearchConfiguration

	// Deprecated. This property is deprecated and will be removed in a future version.
	Description *string
	Filters     *WebSearchToolFilters

	// Deprecated. This property is deprecated and will be removed in a future version.
	Name *string

	// High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium`
	// is the default.
	SearchContextSize *WebSearchToolSearchContextSize

	// Deprecated. This property is deprecated and will be removed in a future version.
	ToolConfigs  map[string]*ToolConfig
	UserLocation *WebSearchApproximateLocation
}

WebSearchTool - Web search

Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search).

func (*WebSearchTool) GetTool 

func (w *WebSearchTool) GetTool() *Tool

GetTool implements the ToolClassification interface for type WebSearchTool.

func (WebSearchTool) MarshalJSON 

func (w WebSearchTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WebSearchTool.

func (*WebSearchTool) UnmarshalJSON 

func (w *WebSearchTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WebSearchTool.

type WebSearchToolFilters 

type WebSearchToolFilters struct {
	AllowedDomains []string
}

func (WebSearchToolFilters) MarshalJSON 

func (w WebSearchToolFilters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WebSearchToolFilters.

func (*WebSearchToolFilters) UnmarshalJSON 

func (w *WebSearchToolFilters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WebSearchToolFilters.

type WebSearchToolSearchContextSize 

type WebSearchToolSearchContextSize string
const (
	WebSearchToolSearchContextSizeHigh   WebSearchToolSearchContextSize = "high"
	WebSearchToolSearchContextSizeLow    WebSearchToolSearchContextSize = "low"
	WebSearchToolSearchContextSizeMedium WebSearchToolSearchContextSize = "medium"
)

func PossibleWebSearchToolSearchContextSizeValues 

func PossibleWebSearchToolSearchContextSizeValues() []WebSearchToolSearchContextSize

PossibleWebSearchToolSearchContextSizeValues returns the possible values for the WebSearchToolSearchContextSize const type.

type WebSearchToolboxTool 

type WebSearchToolboxTool struct {
	// CONSTANT; Field has constant value ToolboxToolTypeWebSearch, any specified value is ignored.
	Type *ToolboxToolType

	// The project connections attached to this tool. There can be a maximum of 1 connection
	// resource attached to the tool.
	CustomSearchConfiguration *WebSearchConfiguration

	// Optional user-defined description for this tool or configuration.
	Description *string
	Filters     *WebSearchToolFilters

	// Optional user-defined name for this tool or configuration.
	Name *string

	// High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium`
	// is the default.
	SearchContextSize *WebSearchToolSearchContextSize

	// Deprecated. This property is deprecated and will be removed in a future version.
	ToolConfigs  map[string]*ToolConfig
	UserLocation *WebSearchApproximateLocation
}

WebSearchToolboxTool - A web search tool stored in a toolbox.

func (*WebSearchToolboxTool) GetToolboxTool 

func (w *WebSearchToolboxTool) GetToolboxTool() *ToolboxTool

GetToolboxTool implements the ToolboxToolClassification interface for type WebSearchToolboxTool.

func (WebSearchToolboxTool) MarshalJSON 

func (w WebSearchToolboxTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WebSearchToolboxTool.

func (*WebSearchToolboxTool) UnmarshalJSON 

func (w *WebSearchToolboxTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WebSearchToolboxTool.

type WeeklyRecurrenceSchedule 

type WeeklyRecurrenceSchedule struct {
	// REQUIRED; Days of the week for the recurrence schedule.
	DaysOfWeek []DayOfWeek

	// CONSTANT; Weekly recurrence type.
	// Field has constant value RecurrenceTypeWeekly, any specified value is ignored.
	Type *RecurrenceType
}

WeeklyRecurrenceSchedule - Weekly recurrence schedule.

func (*WeeklyRecurrenceSchedule) GetRecurrenceSchedule 

func (w *WeeklyRecurrenceSchedule) GetRecurrenceSchedule() *RecurrenceSchedule

GetRecurrenceSchedule implements the RecurrenceScheduleClassification interface for type WeeklyRecurrenceSchedule.

func (WeeklyRecurrenceSchedule) MarshalJSON 

func (w WeeklyRecurrenceSchedule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WeeklyRecurrenceSchedule.

func (*WeeklyRecurrenceSchedule) UnmarshalJSON 

func (w *WeeklyRecurrenceSchedule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WeeklyRecurrenceSchedule.

type WorkIQPreviewTool 

type WorkIQPreviewTool struct {
	// REQUIRED; The ID of the WorkIQ project connection.
	ProjectConnectionID *string

	// CONSTANT; The object type, which is always 'work_iq_preview'.
	// Field has constant value ToolTypeWorkIqPreview, any specified value is ignored.
	Type *ToolType
}

WorkIQPreviewTool - A WorkIQ server-side tool.

func (*WorkIQPreviewTool) GetTool 

func (w *WorkIQPreviewTool) GetTool() *Tool

GetTool implements the ToolClassification interface for type WorkIQPreviewTool.

func (WorkIQPreviewTool) MarshalJSON 

func (w WorkIQPreviewTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkIQPreviewTool.

func (*WorkIQPreviewTool) UnmarshalJSON 

func (w *WorkIQPreviewTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkIQPreviewTool.

type WorkIQPreviewToolboxTool 

type WorkIQPreviewToolboxTool struct {
	// REQUIRED; The ID of the WorkIQ project connection.
	ProjectConnectionID *string

	// CONSTANT; Field has constant value ToolboxToolTypeWorkIqPreview, any specified value is ignored.
	Type *ToolboxToolType

	// Optional user-defined description for this tool or configuration.
	Description *string

	// Optional user-defined name for this tool or configuration.
	Name *string

	// Per-tool configuration map. Keys are tool names or `*` (catch-all default).
	// Resolution order: exact tool name match takes priority over `*`.
	// Unknown tool names are silently ignored at runtime.
	ToolConfigs map[string]*ToolConfig
}

WorkIQPreviewToolboxTool - A WorkIQ tool stored in a toolbox.

func (*WorkIQPreviewToolboxTool) GetToolboxTool 

func (w *WorkIQPreviewToolboxTool) GetToolboxTool() *ToolboxTool

GetToolboxTool implements the ToolboxToolClassification interface for type WorkIQPreviewToolboxTool.

func (WorkIQPreviewToolboxTool) MarshalJSON 

func (w WorkIQPreviewToolboxTool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkIQPreviewToolboxTool.

func (*WorkIQPreviewToolboxTool) UnmarshalJSON 

func (w *WorkIQPreviewToolboxTool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkIQPreviewToolboxTool.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.