references/api-reference.md · 24000
# AZURE_AI_SEARCH, MANAGED_AZURE_AI_SEARCH, COSMOS_DB
DatasetType # FILE, FOLDER AzureAISearchQueryType # SIMPLE, FULL, SEMANTIC, VECTOR, VECTOR_SIMPLE_HYBRID, ...
### Evaluation Enums
```python
EvaluatorType # GROUNDEDNESS, RELEVANCE, COHERENCE, FLUENCY, etc.
EvaluatorCategory # QUALITY, SAFETY, CUSTOM
EvaluatorDefinitionType # CODE_BASED, PROMPT_BASED
EvaluatorMetricType # NUMERIC, BOOLEAN, STRING
EvaluatorMetricDirection # HIGHER_IS_BETTER, LOWER_IS_BETTER
RiskCategory # HATE_UNFAIRNESS, VIOLENCE, SELF_HARM, SEXUAL, etc.
SampleType # GOOD, BAD, NEUTRAL
Memory Enums
MemoryItemKind # CHAT_SUMMARY, USER_PROFILE
MemoryStoreKind # DEFAULT
MemoryOperationKind # ADD, REMOVE
MemoryStoreUpdateStatus # COMPLETED, PENDING, FAILED
Schedule & Trigger Enums
TriggerType # CRON, RECURRENCE, ONE_TIME
RecurrenceType # HOURLY, DAILY, WEEKLY, MONTHLY
DayOfWeek # MONDAY through SUNDAY
ScheduleTaskType # EVALUATION, INSIGHT
ScheduleProvisioningStatus # PROVISIONING, PROVISIONED, FAILED
Credential Enums
CredentialType # API_KEY, ENTRA_ID, SAS, NO_AUTH, AGENTIC_IDENTITY, CUSTOM
Connection Enums
ConnectionType # AZURE_OPEN_AI, AZURE_AI_SEARCH, AZURE_BLOB, etc.
DeploymentType # MODEL, EMBEDDING, etc.
Annotation Enums
AnnotationType # FILE_CITATION, CONTAINER_FILE_CITATION, URL_CITATION, FILE_PATH
Status Enums
OperationState # PENDING, IN_PROGRESS, COMPLETED, FAILED
FunctionCallItemStatus # IN_PROGRESS, COMPLETED, INCOMPLETE
LocalShellCallStatus # PENDING, COMPLETED, ERROR
ApplyPatchCallStatus # PENDING, COMPLETED, FAILED
Miscellaneous Enums
PageOrder # ASC, DESC
ImageDetail # LOW, HIGH, AUTO
InputFidelity # LOW, MEDIUM, HIGH
SearchContextSize # LOW, MEDIUM, HIGH
RankerVersionType # V1, V2
GrammarSyntax1 # BNF, EBNF
TextResponseFormatConfigurationType # TEXT, JSON_OBJECT, JSON_SCHEMA
ContainerLogKind # STDOUT, STDERR
ContainerMemoryLimit # 256MB, 512MB, 1GB, etc.
DetailEnum # LOW, HIGH, AUTO
AttackStrategy # Various attack strategies for red teaming
TreatmentEffectType # POSITIVE, NEGATIVE, NEUTRAL
Quick Reference: Common Import Patterns
Client Initialization
from azure.ai.projects import AIProjectClient
from azure.identity import DefaultAzureCredential
import os
client = AIProjectClient(
endpoint=os.environ["AZURE_AI_PROJECT_ENDPOINT"],
credential=DefaultAzureCredential(),
)
Agent with Tools
from azure.ai.projects.models import (
PromptAgentDefinition,
CodeInterpreterTool,
FileSearchTool,
FunctionTool,
AzureAISearchTool,
BingGroundingTool,
)
All Tool Imports
from azure.ai.projects.models import (
# Core tools
CodeInterpreterTool,
FileSearchTool,
FunctionTool,
# Azure tools
AzureAISearchTool,
AzureFunctionTool,
BingGroundingTool,
BingCustomSearchPreviewTool,
# External tools
OpenApiTool,
MCPTool,
# Computer use
ComputerUsePreviewTool,
# Web & preview
WebSearchTool,
WebSearchPreviewTool,
A2APreviewTool,
BrowserAutomationPreviewTool,
# Enterprise
MicrosoftFabricPreviewTool,
SharepointPreviewTool,
# Memory
MemorySearchPreviewTool,
# Utility
ImageGenTool,
CaptureStructuredOutputsTool,
LocalShellToolParam,
FunctionShellToolParam,
ApplyPatchToolParam,
CustomToolParam,
)
Document generated from azure-ai-projects v2.0.0b4 source code analysis. Last updated: February 2026