Udostępnij przez


@azure/ai-projects package

Klasy

AIProjectClient

pobiera klienta OpenAI

Interfejsów

@azure/ai-projects.Index
A2APreviewTool

Agent implementujący protokół A2A.

AIProjectClientOptionalParams

Parametry opcjonalne dla klienta.

AISearchIndexResource

Zasób AI Search Index.

Agent

Reprezentuje obiekt agenta. Zawiera unikatowy identyfikator, nazwę i informacje o wersji agenta.

AgentClusterInsightResult

Szczegółowe informacje z analizy skupień agentów.

AgentClusterInsightsRequest

Wgląd w zestaw wyników oceny agenta

AgentDefinition

Podstawowy interfejs definicji dla agentów. Zawiera rodzaj agenta i opcjonalną konfigurację RAI.

AgentId

Identyfikator Agenta interfejsu modelu

AgentReference

interfejs modelu AgentReference

AgentTaxonomyInput

Konfiguracja danych wejściowych dla taksonomii oceny, gdy typ danych wejściowych to agent.

AgentVersion

Reprezentuje określoną wersję agenta. Obejmuje metadane, przechowywanie wersji, czas tworzenia i definicję agenta.

AgenticIdentityCredentials

Definicja poświadczeń tożsamości agenta

AgentsCreateAgentFromManifestOptionalParams

Parametry opcjonalne.

AgentsCreateAgentOptionalParams

Parametry opcjonalne.

AgentsCreateAgentVersionFromManifestOptionalParams

Parametry opcjonalne.

AgentsCreateAgentVersionOptionalParams

Parametry opcjonalne.

AgentsDeleteAgentOptionalParams

Parametry opcjonalne.

AgentsDeleteAgentVersionOptionalParams

Parametry opcjonalne.

AgentsGetAgentOptionalParams

Parametry opcjonalne.

AgentsGetAgentVersionOptionalParams

Parametry opcjonalne.

AgentsListAgentVersionsOptionalParams

Parametry opcjonalne.

AgentsListAgentsOptionalParams

Parametry opcjonalne.

AgentsOperations

Interfejs reprezentujący operacje agentów.

AgentsStreamAgentContainerLogsOptionalParams

Parametry opcjonalne.

AgentsUpdateAgentFromManifestOptionalParams

Parametry opcjonalne.

AgentsUpdateAgentOptionalParams

Parametry opcjonalne.

Annotation

adnotacja interfejsu modelu

ApiError

interfejs modelu ApiError

ApiErrorResponse

Odpowiedź na błąd w przypadku awarii interfejsu API.

ApiKeyCredentials

Definicja poświadczeń klucza interfejsu API

ApplyPatchCreateFileOperationParam

Instrukcja tworzenia nowego pliku za pomocą narzędzia apply_patch.

ApplyPatchDeleteFileOperationParam

Instrukcja usuwania istniejącego pliku za pomocą narzędzia apply_patch.

ApplyPatchOperationParam

Jedną z create_file, delete_file lub update_file operacji dostarczanych do narzędzia apply_patch.

ApplyPatchToolCallItemParam

Wywołanie narzędzia reprezentujące żądanie tworzenia, usuwania lub aktualizacji plików za pomocą łatek różnicowych.

ApplyPatchToolCallOutputItemParam

Strumieniowane wyjście generowane przez wywołanie narzędzia do zastosowania łatki.

ApplyPatchToolParam

Pozwala asystentowi tworzyć, usuwać lub aktualizować pliki za pomocą zunifikowanych różnic różnicowych.

ApplyPatchUpdateFileOperationParam

Instrukcja aktualizacji istniejącego pliku za pomocą narzędzia apply_patch.

ApproximateLocation

interfejs modelu ApproximateLocation

AzureAIAgentTarget

Reprezentuje element docelowy określający agenta sztucznej inteligencji platformy Azure.

AzureAISearchIndex

Definicja indeksu wyszukiwania w usłudze Azure AI

AzureAISearchTool

Informacje o definicji danych wejściowych narzędzia wyszukiwania sztucznej inteligencji platformy Azure używane do konfigurowania agenta.

AzureAISearchToolResource

Zestaw zasobów indeksu używanych przez narzędzie azure_ai_search.

AzureFunctionBinding

Struktura przechowywania nazwy kolejki magazynu i identyfikatora URI.

AzureFunctionDefinition

Definicja funkcji platformy Azure.

AzureFunctionStorageQueue

Struktura przechowywania nazwy kolejki magazynu i identyfikatora URI.

AzureFunctionTool

Informacje o definicji danych wejściowych dla narzędzia funkcji platformy Azure używane do konfigurowania agenta.

AzureOpenAIModelConfiguration

Konfiguracja modelu usługi Azure OpenAI. Wersja interfejsu API zostanie wybrana przez usługę do wykonywania zapytań dotyczących modelu.

BaseCredentials

Klasa bazowa dla poświadczeń połączenia

BingCustomSearchConfiguration

Konfiguracja wyszukiwania niestandardowego Bing.

BingCustomSearchPreviewTool

Informacje o definicji danych wejściowych dla niestandardowego narzędzia wyszukiwania Bing używane do konfigurowania agenta.

BingCustomSearchToolParameters

Parametry narzędzia wyszukiwania niestandardowego Bing.

BingGroundingSearchConfiguration

Wyszukaj konfigurację dla Bing Grounding

BingGroundingSearchToolParameters

Parametry narzędzia wyszukiwania uziemienia Bing.

BingGroundingTool

Informacje o definicji danych wejściowych narzędzia wyszukiwania uziemieniowego bing używane do konfigurowania agenta.

BlobReference

Szczegóły odwołania do obiektu blob.

BrowserAutomationPreviewTool

Informacje o definicji danych wejściowych dla narzędzia Browser Automation Tool, które służy do konfigurowania agenta.

BrowserAutomationToolConnectionParameters

Definicja parametrów wejściowych dla połączenia używanego przez narzędzie Browser Automation Tool.

BrowserAutomationToolParameters

Definicja parametrów wejściowych dla narzędzia Browser Automation Tool.

CaptureStructuredOutputsTool

Narzędzie do przechwytywania ustrukturyzowanych danych wyjściowych

ChartCoordinate

Współrzędne wykresu analizy.

ChatSummaryMemoryItem

Element pamięci zawierający podsumowanie wyodrębnione z konwersacji.

ClickParam

Akcja kliknięcia.

ClusterInsightResult

Wnioski z analizy skupień.

ClusterTokenUsage

Użycie tokenu do analizy skupień

CodeBasedEvaluatorDefinition

Definicja ewaluatora opartego na kodzie przy użyciu kodu w języku Python

CodeInterpreterContainerAuto

Konfiguracja kontenera interpretera kodu. Opcjonalnie określ identyfikatory plików do uruchomienia kodu.

CodeInterpreterOutputImage

Dane wyjściowe obrazu z interpretera kodu.

CodeInterpreterOutputLogs

Dane wyjściowe dzienników z interpretera kodu.

CodeInterpreterTool

Narzędzie, które uruchamia kod języka Python, aby pomóc wygenerować odpowiedź na monit.

CompactionSummaryItemParam

Element kompaktowy generowany przez v1/responses/compact API.

ComparisonFilter

Filtr używany do porównywania określonego klucza atrybutu z daną wartością przy użyciu zdefiniowanej operacji porównania.

CompoundFilter

Połącz wiele filtrów przy użyciu polecenia and lub or.

ComputerAction

model interfejs ComputerAction

ComputerCallOutputItemParam

Dane wyjściowe z wywołania narzędzia komputerowego.

ComputerCallSafetyCheckParam

Zaplanowana kontrola bezpieczeństwa dla komputerowego wezwania.

ComputerScreenshotImage

Obraz zrzutu ekranu komputera używany w narzędziu do obsługi komputera.

ComputerUsePreviewTool

Narzędzie kontrolujące komputer wirtualny. Dowiedz się więcej o narzędziu komputerowym.

Connection

Operacje odpowiedzi z listy i pobierania połączeń

ConnectionsGetOptionalParams

Parametry opcjonalne.

ConnectionsGetWithCredentialsOptionalParams

Parametry opcjonalne.

ConnectionsListOptionalParams

Parametry opcjonalne.

ConnectionsOperations

Interfejs reprezentujący operacje Connections.

ContainerAppAgentDefinition

Definicja agenta aplikacji kontenera.

ContainerFileCitationBody

Cytowanie pliku kontenerowego używanego do generowania odpowiedzi modelu.

ContinuousEvaluationRuleAction

Akcja reguły oceny dla ciągłej oceny.

CosmosDBIndex

Definicja indeksu magazynu wektorów usługi CosmosDB

CronTrigger

Wyzwalacz oparty na Cronie.

CustomCredential

Niestandardowa definicja poświadczeń

CustomGrammarFormatParam

Gramatyka zdefiniowana przez użytkownika.

CustomTextFormatParam

Tekst swobodnej formy.

CustomToolParam

Narzędzie niestandardowe, które przetwarza dane wejściowe w określonym formacie. Dowiedz się więcej o narzędziach niestandardowych

CustomToolParamFormat

Format wejściowy dla narzędzia niestandardowego. Domyślnie jest tekst nieograniczony.

DailyRecurrenceSchedule

Harmonogram codziennych cykli.

DatasetCredential

Reprezentuje odwołanie do obiektu blob do użycia

DatasetUploadOptions

Opcje przekazywania zestawów danych

DatasetVersion

Definicja wersji zestawu danych DatasetVersion

DatasetsCreateOrUpdateOptionalParams

Parametry opcjonalne.

DatasetsDeleteOptionalParams

Parametry opcjonalne.

DatasetsGetCredentialsOptionalParams

Parametry opcjonalne.

DatasetsGetOptionalParams

Parametry opcjonalne.

DatasetsListOptionalParams

Parametry opcjonalne.

DatasetsListVersionsOptionalParams

Parametry opcjonalne.

DatasetsOperations

Interfejs reprezentujący operacje zestawów danych.

DatasetsPendingUploadOptionalParams

Parametry opcjonalne.

DeleteAgentResponse

Usunięty obiekt agenta

DeleteAgentVersionResponse

Usunięta wersja agenta Object

DeleteMemoryStoreResponse

interfejs modelu DeleteMemoryStoreResponse

Deployment

Definicja wdrożenia modelu

DeploymentsGetOptionalParams

Parametry opcjonalne.

DeploymentsListOptionalParams

Parametry opcjonalne.

DeploymentsOperations

Interfejs reprezentujący operacje wdrożeń.

DoubleClickAction

Dwukrotne kliknięcie myszy.

Drag

Czynność przeciągania.

DragPoint

Para współrzędnych x/y, np. { x: 100, y: 200 }.

EmbeddingConfiguration

Klasa konfiguracyjna osadzania

EntraIDCredentials

Definicja poświadczeń identyfikatora Entra

EvalCompareReport

Wnioski z porównania ewaluacji.

EvalResult

Wynik oceny.

EvalRunResultCompareItem

Porównanie wskaźników leczenia w stosunku do wartości wyjściowej.

EvalRunResultComparison

Wyniki porównania dla leczenia są sprzeczne z wartością wyjściową.

EvalRunResultSummary

Statystyki podsumowujące metrykę w przebiegu oceny.

EvaluationComparisonRequest

Prośba o porównanie oceny

EvaluationResultSample

Próbka z wyniku oceny.

EvaluationRule

Model reguły oceny.

EvaluationRuleAction

Model działania ewaluacyjnego.

EvaluationRuleFilter

Model filtru oceny.

EvaluationRulesCreateOrUpdateOptionalParams

Parametry opcjonalne.

EvaluationRulesDeleteOptionalParams

Parametry opcjonalne.

EvaluationRulesGetOptionalParams

Parametry opcjonalne.

EvaluationRulesListOptionalParams

Parametry opcjonalne.

EvaluationRulesOperations

Interfejs reprezentujący operacje EvaluationRules.

EvaluationRunClusterInsightResult

Szczegółowe informacje z oceny uruchamiają analizę skupień.

EvaluationRunClusterInsightsRequest

Wgląd w zestaw wyników ewaluacji

EvaluationScheduleTask

Zadanie oceny harmonogramu.

EvaluationTaxonomiesCreateOptionalParams

Parametry opcjonalne.

EvaluationTaxonomiesDeleteOptionalParams

Parametry opcjonalne.

EvaluationTaxonomiesGetOptionalParams

Parametry opcjonalne.

EvaluationTaxonomiesListOptionalParams

Parametry opcjonalne.

EvaluationTaxonomiesOperations

Interfejs reprezentujący operacje EvaluationTaxonomies.

EvaluationTaxonomiesUpdateOptionalParams

Parametry opcjonalne.

EvaluationTaxonomy

Definicja taksonomii oceny

EvaluationTaxonomyInput

Konfiguracja danych wejściowych dla taksonomii oceny.

EvaluatorDefinition

Podstawowa konfiguracja ewaluatora z dyskryminatorem

EvaluatorMetric

Metryka ewaluatora

EvaluatorVersion

Definicja ewaluatora

EvaluatorsCreateVersionOptionalParams

Parametry opcjonalne.

EvaluatorsDeleteVersionOptionalParams

Parametry opcjonalne.

EvaluatorsGetVersionOptionalParams

Parametry opcjonalne.

EvaluatorsListLatestVersionsOptionalParams

Parametry opcjonalne.

EvaluatorsListVersionsOptionalParams

Parametry opcjonalne.

EvaluatorsOperations

Interfejs reprezentujący operacje Ewaluatorów.

EvaluatorsUpdateVersionOptionalParams

Parametry opcjonalne.

FabricDataAgentToolParameters

Parametry narzędzia agenta danych sieci szkieletowej.

FieldMapping

Klasa konfiguracji mapowania pól

FileCitationBody

Cytat do pliku.

FileDatasetVersion

Definicja wersji pliku FileDatasetVersion

FilePath

Ścieżka do pliku.

FileSearchTool

Narzędzie wyszukujące odpowiednią zawartość z przekazanych plików. Dowiedz się więcej o narzędziu do wyszukiwania plików.

FileSearchToolCallResults

interfejs modelu FileSearchToolCallResults

FolderDatasetVersion

Definicja wersji pliku FileDatasetVersion

FunctionAndCustomToolCallOutput

Funkcja interfejsu modeluI NiestandardoweWywołanieNarzędzia

FunctionAndCustomToolCallOutputInputFileContent

Plik wejściowy do modelu.

FunctionAndCustomToolCallOutputInputImageContent

Dane wejściowe obrazu do modelu. Dowiedz się więcej o danych wejściowych obrazu.

FunctionAndCustomToolCallOutputInputTextContent

Wprowadzanie tekstu do modelu.

FunctionCallOutputItemParam

Dane wyjściowe wywołania narzędzia funkcji.

FunctionShellActionParam

Polecenia i ograniczenia opisujące, jak uruchomić wywołanie narzędzia powłoki.

FunctionShellCallItemParam

Narzędzie reprezentujące żądanie wykonania jednego lub więcej poleceń powłoki.

FunctionShellCallOutputContentParam

Zdobyte stdout i stderr dla części wyjścia wywołania narzędzia powłokowego.

FunctionShellCallOutputExitOutcomeParam

Oznacza, że polecenia powłoki zakończyły się i zwróciły kod wyjścia.

FunctionShellCallOutputItemParam

Elementy wyjściowe przesyłane strumieniowo generowane przez wywołanie narzędzia powłoki.

FunctionShellCallOutputOutcomeParam

Wynik wyjścia lub timeoutu związany z tym połączeniem typu shell.

FunctionShellCallOutputTimeoutOutcomeParam

Wskazuje, że wywołanie powłoki przekroczyło skonfigurowany limit czasowy.

FunctionShellToolParam

Narzędzie, które pozwala modelowi na wykonywanie poleceń powłoki.

FunctionTool

Definiuje funkcję w swoim kodzie, którą model może wywołać. Dowiedz się więcej o wywoływaniu funkcji.

HostedAgentDefinition

Definicja hostowanego agenta.

HourlyRecurrenceSchedule

Godzinowy harmonogram cykli.

HumanEvaluationRuleAction

Akcja reguły oceny dla oceny przez człowieka.

HybridSearchOptions

interfejs modelu HybridSearchOptions

ImageBasedHostedAgentDefinition

Definicja wdrożenia opartego na obrazie dla hostowanego agenta.

ImageGenTool

Narzędzie generujące obrazy z wykorzystaniem modeli obrazów GPT.

ImageGenToolInputImageMask

interfejs modelu ImageGenToolInputImageMask

IndexesCreateOrUpdateOptionalParams

Parametry opcjonalne.

IndexesDeleteOptionalParams

Parametry opcjonalne.

IndexesGetOptionalParams

Parametry opcjonalne.

IndexesListOptionalParams

Parametry opcjonalne.

IndexesListVersionsOptionalParams

Parametry opcjonalne.

IndexesOperations

Interfejs reprezentujący operacje indeksów.

InputContent

interfejs modelu InputContent

InputContentInputFileContent

Plik wejściowy do modelu.

InputContentInputImageContent

Dane wejściowe obrazu do modelu. Dowiedz się więcej o danych wejściowych obrazu.

InputContentInputTextContent

Wprowadzanie tekstu do modelu.

InputFileContentParam

Plik wejściowy do modelu.

InputImageContentParamAutoParam

Dane wejściowe obrazu do modelu. Dowiedz się o wejściach obrazowych

InputMessage

Wiadomość jako wejście do modelu z rolą wskazującą przestrzeganie hierarchii instrukcji. Instrukcje przypisane do roli developer lub system mają pierwszeństwo przed instrukcjami przypisanymi do roli user.

InputTextContentParam

Wprowadzanie tekstu do modelu.

Insight

Treść odpowiedzi dla szczegółowych informacji o klastrze.

InsightCluster

Klaster próbek analitycznych.

InsightModelConfiguration

Konfiguracja modelu używanego w generowaniu wniosków.

InsightRequest

Żądanie raportu szczegółowych informacji.

InsightResult

Wynik spostrzeżeń.

InsightSample

Próbka z analizy.

InsightScheduleTask

Zadanie Wgląd dla harmonogramu.

InsightSummary

Podsumowanie analizy skupień błędów.

InsightsGenerateOptionalParams

Parametry opcjonalne.

InsightsGetOptionalParams

Parametry opcjonalne.

InsightsListOptionalParams

Parametry opcjonalne.

InsightsMetadata

Metadane dotyczące szczegółowych informacji.

InsightsOperations

Interfejs reprezentujący operacje aplikacji Insights.

Item

Element zawartości używany do generowania odpowiedzi.

ItemCodeInterpreterToolCall

Wywołanie narzędzia w celu uruchomienia kodu.

ItemComputerToolCall

Narzędzie wywołujące narzędzie do korzystania z komputera. Więcej informacji można znaleźć w podręczniku użytkowania komputera .

ItemCustomToolCall

Wywołanie do niestandardowego narzędzia stworzonego przez model.

ItemCustomToolCallOutput

Wynik niestandardowego narzędzia wywołany z twojego kodu jest przesyłany z powrotem do modelu.

ItemFileSearchToolCall

Wyniki wywołania narzędzia wyszukiwania plików. Więcej informacji można znaleźć w przewodniku wyszukiwania plików .

ItemFunctionToolCall

Wywołanie narzędzia w celu uruchomienia funkcji. Aby uzyskać więcej informacji, zobacz przewodnik wywoływania funkcji .

ItemImageGenToolCall

Żądanie generowania obrazu wykonane przez model.

ItemLocalShellToolCall

Wywołanie narzędzia w celu uruchomienia polecenia w lokalnej powłoce.

ItemLocalShellToolCallOutput

Dane wyjściowe lokalnego wywołania narzędzia powłoki.

ItemMcpApprovalRequest

Wniosek o zatwierdzenie przez człowieka wywołania narzędzia.

ItemMcpListTools

Lista narzędzi dostępnych na serwerze MCP.

ItemMcpToolCall

Wywołanie narzędzia na serwerze MCP.

ItemOutputMessage

Komunikat wyjściowy z modelu.

ItemReasoningItem

Opis łańcucha myśli używanego przez model rozumowania podczas generowania odpowiedzi. Upewnij się, że uwzględnisz te elementy w API input Responses na potrzeby kolejnych tur rozmowy, jeśli ręcznie zarządzasz kontekstem.

ItemWebSearchToolCall

Wyniki wywołania narzędzia wyszukiwania w sieci. Więcej informacji można znaleźć w przewodniku wyszukiwania w Internecie .

KeyPressAction

Kolekcja naciśnięć klawiszy, które model chciałby wykonać.

LocalShellExecAction

Wykonaj polecenie powłoki na serwerze.

LocalShellToolParam

Narzędzie, które umożliwia modelowi wykonywanie poleceń powłoki w środowisku lokalnym.

LogProb

Prawdopodobieństwo dziennika tokenu.

MCPApprovalResponse

Odpowiedź na żądanie zatwierdzenia MCP.

MCPListToolsTool

Narzędzie dostępne na serwerze MCP.

MCPListToolsToolAnnotations

interfejs modelu MCPListToolsToolAnnotations

MCPListToolsToolInputSchema

interfejs modelu MCPListToolsToolInputSchema

MCPTool

Nadaj modelowi dostęp do dodatkowych narzędzi za pośrednictwem zdalnych serwerów protokołu MCP (Model Context Protocol). Dowiedz się więcej o MCP.

MCPToolFilter

Obiekt filtrujący określający, które narzędzia są dozwolone.

MCPToolRequireApproval

interfejs modelu MCPToolRequireApproval

ManagedAzureAISearchIndex

Definicja indeksu wyszukiwania zarządzanej sztucznej inteligencji platformy Azure

MemoryItem

Pojedynczy element pamięci przechowywany w magazynie pamięci, zawierający zawartość i metadane.

MemoryOperation

Reprezentuje pojedynczą operację pamięci (tworzenie, aktualizowanie lub usuwanie) wykonywaną na elemencie pamięci.

MemorySearchItem

Pobrany element pamięci z wyszukiwania w pamięci.

MemorySearchOptions

Opcje wyszukiwania w pamięci.

MemorySearchTool

Narzędzie do integracji wspomnień z agentem.

MemorySearchToolCallItemParam

interfejs modelu MemorySearchToolCallItemParam

MemoryStore

Magazyn pamięci, który może przechowywać i pobierać wspomnienia użytkownika.

MemoryStoreDefaultDefinition

Domyślna implementacja magazynu pamięci.

MemoryStoreDefaultOptions

Domyślne konfiguracje magazynu pamięci.

MemoryStoreDefinition

Podstawowa definicja konfiguracji magazynu pamięci.

MemoryStoreDeleteScopeResponse

Odpowiedź na usunięcie wspomnień z zakresu.

MemoryStoreOperationUsage

Statystyki użycia operacji składnicy pamięci.

MemoryStoreSearchResponse

Odpowiedź na wyszukiwanie w pamięci.

MemoryStoreUpdateCompletedResult

Wynik aktualizacji pamięci.

MemoryStoreUpdateResponse

Określa stan operacji aktualizacji magazynu pamięci.

MemoryStoresCreateMemoryStoreOptionalParams

Parametry opcjonalne.

MemoryStoresDeleteMemoryStoreOptionalParams

Parametry opcjonalne.

MemoryStoresDeleteScopeOptionalParams

Parametry opcjonalne.

MemoryStoresGetMemoryStoreOptionalParams

Parametry opcjonalne.

MemoryStoresGetUpdateResultOptionalParams

Parametry opcjonalne.

MemoryStoresListMemoryStoresOptionalParams

Parametry opcjonalne.

MemoryStoresOperations

Interfejs reprezentujący operacje MemoryStores.

MemoryStoresSearchMemoriesOptionalParams

Parametry opcjonalne.

MemoryStoresUpdateMemoriesOptionalParams

Parametry opcjonalne.

MemoryStoresUpdateMemoryStoreOptionalParams

Parametry opcjonalne.

MicrosoftFabricPreviewTool

Informacje o definicji danych wejściowych narzędzia Microsoft Fabric używane do konfigurowania agenta.

ModelDeployment

Definicja wdrożenia modelu

ModelDeploymentSku

Informacje o jednostce SKU

MonthlyRecurrenceSchedule

Miesięczny harmonogram cykli.

Move

Akcja ruchu myszy.

NoAuthenticationCredentials

Poświadczenia, które nie wymagają uwierzytelniania

OneTimeTrigger

Jednorazowy spust.

OpenApiAnonymousAuthDetails

Szczegóły zabezpieczeń uwierzytelniania anonimowego openApi

OpenApiAuthDetails

szczegóły uwierzytelniania dla elementu OpenApiFunctionDefinition

OpenApiFunctionDefinition

Informacje o definicji danych wejściowych dla funkcji openapi.

OpenApiManagedAuthDetails

Szczegóły zabezpieczeń uwierzytelniania interfejsu OpenApi managed_identity

OpenApiManagedSecurityScheme

Schemat zabezpieczeń uwierzytelniania interfejsu OpenApi managed_identity

OpenApiProjectConnectionAuthDetails

Szczegóły zabezpieczeń dotyczące uwierzytelniania połączenia projektu OpenApi

OpenApiProjectConnectionSecurityScheme

Schemat zabezpieczeń uwierzytelniania interfejsu OpenApi managed_identity

OpenApiTool

Informacje o definicji danych wejściowych narzędzia OpenAPI używane do konfigurowania agenta.

OutputContent

interfejs modelu WyjścieZawartość

OutputMessageContent

interfejs modelu WyjścieKomunikatZawartość

OutputMessageContentOutputTextContent

Dane wyjściowe tekstowe z modelu.

OutputMessageContentRefusalContent

Odmowa ze strony modelu.

PageSettings

Opcje dla metody byPage

PagedAsyncIterableIterator

Interfejs, który umożliwia iterację asynchronialną zarówno do ukończenia, jak i według strony.

PendingUploadRequest

Reprezentuje prośbę o oczekujące przesłanie.

PendingUploadResponse

Reprezentuje odpowiedź na oczekujące żądanie przesłania

PromptAgentDefinition

Definicja agenta monitu

PromptBasedEvaluatorDefinition

Ewaluator oparty na podpowiedziach

ProtocolVersionRecord

Mapowanie rekordu dla pojedynczego protokołu i jego wersji.

RaiConfig

Konfiguracja filtrowania treści i funkcji bezpieczeństwa Responsible AI (RAI).

RankingOptions

interfejs modelu RankingOptions

Reasoning

Tylko modele GPT-5 i serii O Opcje konfiguracyjne modeli rozumowania.

ReasoningTextContent

Tekst rozumowania od modelki.

RecurrenceSchedule

Model harmonogramu cykli.

RecurrenceTrigger

Wyzwalacz oparty na cyklu.

RedTeam

Szczegóły czerwonej drużyny.

RedTeamsCreateOptionalParams

Parametry opcjonalne.

RedTeamsGetOptionalParams

Parametry opcjonalne.

RedTeamsListOptionalParams

Parametry opcjonalne.

RedTeamsOperations

Interfejs reprezentujący operacje RedTeams.

ResponseUsageInputTokensDetails

Model Interface ResponseUsageInputTokensDetails

ResponseUsageOutputTokensDetails

Model Interface ResponseUsageOutputTokensDetails

RestorePollerOptions

Opcje przywracania odpytnika.

SASTokenCredentials

Definicja poświadczeń sygnatury dostępu współdzielonego (SAS)

SasCredential

Definicja poświadczeń sygnatury dostępu współdzielonego

Schedule

Model harmonogramu.

ScheduleRun

Zaplanuj model uruchamiania.

ScheduleTask

Zaplanuj model zadań.

SchedulesCreateOrUpdateOptionalParams

Parametry opcjonalne.

SchedulesDeleteOptionalParams

Parametry opcjonalne.

SchedulesGetOptionalParams

Parametry opcjonalne.

SchedulesGetRunOptionalParams

Parametry opcjonalne.

SchedulesListOptionalParams

Parametry opcjonalne.

SchedulesListRunsOptionalParams

Parametry opcjonalne.

SchedulesOperations

Interfejs reprezentujący operacje Harmonogramy.

Screenshot

Akcja zrzutu ekranu.

Scroll

Akcja przewijania.

SharepointGroundingToolParameters

Parametry narzędzia do uziemiania programu sharepoint.

SharepointPreviewTool

Informacje o definicji danych wejściowych narzędzia sharepoint używane do konfigurowania agenta.

StructuredInputDefinition

Ustrukturyzowane dane wejściowe, które mogą uczestniczyć w monitujących podstawieniach szablonów i wiązaniu argumentów narzędzia.

StructuredOutputDefinition

Ustrukturyzowane dane wyjściowe, które mogą być generowane przez agenta.

Summary

Podsumowanie tekstu z modelu.

Target

Klasa bazowa dla obiektów docelowych z obsługą dyskryminatora.

TargetConfig

Klasa abstrakcyjna dla konfiguracji docelowej.

TaxonomyCategory

Definicja kategorii taksonomii.

TaxonomySubCategory

Definicja podkategorii taksonomii.

TelemetryOperations

Interfejs reprezentujący operacje telemetryczne

TextResponseFormatConfiguration

Obiekt określający format, który musi zostać wygenerowany przez model. Konfigurowanie { "type": "json_schema" } umożliwia korzystanie ze strukturowych danych wyjściowych, co zapewnia, że model będzie zgodny z podanym schematem JSON. Dowiedz się więcej w przewodniku Dotyczącym danych wyjściowych ze strukturą. Domyślny format to { "type": "text" } bez żadnych dodatkowych opcji. Niezalecane dla gpt-4o i nowszych modeli:* Ustawienie umożliwiające { "type": "json_object" } starszy tryb JSON, który zapewnia, że komunikat generowany przez model jest poprawny JSON. Użycie json_schema jest preferowane w przypadku modeli, które go obsługują.

TextResponseFormatConfigurationResponseFormatJsonObject

Format odpowiedzi obiektu JSON. Starsza metoda generowania odpowiedzi JSON. Użycie json_schema jest zalecane w przypadku modeli, które go obsługują. Należy pamiętać, że model nie wygeneruje kodu JSON bez komunikatu systemu lub użytkownika z instrukcjami, aby to zrobił.

TextResponseFormatConfigurationResponseFormatText

Domyślny format odpowiedzi. Służy do generowania odpowiedzi tekstowych.

TextResponseFormatJsonSchema

Format odpowiedzi schematu JSON. Służy do generowania ustrukturyzowanych odpowiedzi JSON. Dowiedz się więcej o danych wyjściowych ze strukturą.

Tool

Narzędzie, które może służyć do generowania odpowiedzi.

ToolDescription

Opis narzędzia, które może być używane przez agenta.

ToolProjectConnection

Zasób połączenia z projektem.

TopLogProb

Najwyższe prawdopodobieństwo dziennika tokenu.

Trigger

Model podstawowy dla wyzwalacza harmonogramu.

Type

Akcja wpisywania tekstu.

UrlCitationBody

Cytat dotyczący zasobu internetowego używanego do generowania odpowiedzi modelu.

UserProfileMemoryItem

Element pamięci zawierający informacje o profilu użytkownika wyodrębnione z konwersacji, takie jak preferencje, zainteresowania i dane osobowe.

VectorStoreFileAttributes

Zestaw 16 par klucz-wartość, które można dołączyć do obiektu. Może to być przydatne do przechowywania dodatkowych informacji o obiekcie w formacie ustrukturyzowanym i wykonywania zapytań dotyczących obiektów za pośrednictwem interfejsu API lub pulpitu nawigacyjnego. Klucze to ciągi o maksymalnej długości 64 znaków. Wartości to ciągi o maksymalnej długości 512 znaków, wartości logiczne lub liczby.

Wait

Akcja oczekiwania.

WebSearchActionFind

Typ akcji "find": wyszukuje wzorzec na załadowanej stronie.

WebSearchActionOpenPage

Typ akcji "open_page" — otwiera określony adres URL z wyników wyszukiwania.

WebSearchActionSearch

Typ akcji "search" — wykonuje zapytanie wyszukiwania w Internecie.

WebSearchActionSearchSources

model interfejs WebSearchActionSearchSources

WebSearchApproximateLocation

Przybliżona lokalizacja użytkownika.

WebSearchConfiguration

Konfiguracja wyszukiwania internetowego dla niestandardowego wyszukiwania Bing

WebSearchPreviewTool

To narzędzie przeszukuje internet w poszukiwaniu odpowiednich wyników do wykorzystania w odpowiedzi. Dowiedz się więcej o narzędziu wyszukiwania w sieci.

WebSearchTool

Przeszukaj Internet w poszukiwaniu źródeł związanych z tym tematem. Dowiedz się więcej o narzędziu wyszukiwania w sieci.

WebSearchToolFilters

Interfejs modelu WebSearchToolFilters

WeeklyRecurrenceSchedule

Tygodniowy harmonogram nawrotów.

WorkflowAgentDefinition

Definicja agenta przepływu pracy.

Aliasy typu

AgentDefinitionUnion

Typ unii dla wszystkich typów definicji agentów. Obsługuje przepływ pracy, hostowane, aplikacje kontenerów i agentów monitów.

AgentKind

Definiuje typ/rodzaj agenta. Określa, która struktura definicji agenta jest używana.

AgentProtocol

Typ protokołu AgentProtocolType of AgentProtocol

AnnotationType

Typ adnotacji

AnnotationUnion

Alias dla AnnotationUnion

ApplyPatchCallOutputStatusParam

Wartości wyników raportowane dla apply_patch wywołań narzędzi.

ApplyPatchCallStatusParam

Wartości statusu raportowane dla apply_patch wywołań narzędzi.

ApplyPatchOperationParamType

Typ ApplyPatchOperationParamType

ApplyPatchOperationParamUnion

Alias dla ApplyPatchOperationParamUnion

AttackStrategy

Strategie ataków.

AzureAISearchQueryType

Dostępne typy zapytań dla narzędzia Azure AI Search.

BaseCredentialsUnion

Alias dla BaseCredentialsUnion

ClickButtonType

Typ ClickButtonType

ComparisonFilterValueItems

Alias dla ComparisonFilterValueItems

ComputerActionType

Typ ComputerActionType

ComputerActionUnion

Alias dla ComputerActionUnion

ComputerEnvironment

Typ środowiska komputerowego

ConnectionType

Typ (lub kategoria) połączenia

ContainerLogKind

Typ logów, które mają być przesyłane z kontenera.

ContainerMemoryLimit

Typ ContainerMemoryLimit

ContinuablePage

Interfejs opisujący stronę wyników.

CredentialType

Typ poświadczeń używany przez połączenie

CustomToolParamFormatType

Typ CustomToolParamFormatType

CustomToolParamFormatUnion

Alias dla CustomToolParamFormatUnion

DatasetType

Wyliczenie w celu określenia typu danych.

DatasetVersionUnion

Alias dla DatasetVersionUnion

DayOfWeek

Dni tygodnia dla harmonogramu cyklu.

DeploymentType

Typ wdrożeniaType of Deployment Type of Deployment Type of Deployment

DeploymentUnion

Alias dla DeploymentUnion

DetailEnum

Typ DetailEnum

EvaluationRuleActionType

Rodzaj działania w ramach oceny.

EvaluationRuleActionUnion

Alias dla EvaluationRuleActionUnion

EvaluationRuleEventType

Typ zdarzenia reguły oceny.

EvaluationTaxonomyInputType

Rodzaj danych wejściowych oceny taksonomii.

EvaluationTaxonomyInputUnion

Alias dla EvaluationTaxonomyInputUnion

EvaluatorCategory

Kategoria osoby oceniającej

EvaluatorDefinitionType

Definicja rodzaju osoby ewaluującej

EvaluatorDefinitionUnion

Alias dla EvaluatorDefinitionUnion

EvaluatorMetricDirection

Kierunek metryki wskazujący, czy wyższa wartość jest lepsza, niższa wartość jest lepsza, czy neutralna

EvaluatorMetricType

Rodzaj osoby oceniającej

EvaluatorType

Rodzaj osoby oceniającej

Filters

Alias dla filtrów

FunctionAndCustomToolCallOutputType

Typ funkcji i niestandardowegoWywołaniaWyjściaTypu Narzędzia

FunctionAndCustomToolCallOutputUnion

Alias dla FunctionAndCustomToolCallOutputUnion

FunctionCallItemStatus

Typ funkcjiCallItemStatus

FunctionShellCallItemStatus

Wartości statusu zgłaszane dla wywołań narzędzi powłokowych.

FunctionShellCallOutputOutcomeParamType

Typ funkcjiPowłokaWyWyjścieWynikParamTyp

FunctionShellCallOutputOutcomeParamUnion

Alias dla FunctionShellCallOutputParamUnion

GrammarSyntax1

Typ gramatykiSkładnia1

HostedAgentDefinitionUnion

Alias dla HostedAgentDefinitionUnion

ImageDetail

Typ ImageDetail

IndexType

Typ indeksu

IndexUnion

Alias dla IndexUnion

InputContentType

Typ inputContentType

InputContentUnion

Alias dla InputContentUnion

InputFidelity

Kontroluj, ile wysiłku model podejmie, aby dopasować styl i cechy, zwłaszcza cechy twarzy, obrazów wejściowych. Ten parametr jest obsługiwany tylko dla programu gpt-image-1. Nieobsługiwane dla elementu gpt-image-1-mini. Obsługuje high i low. Wartość domyślna to low.

InsightRequestUnion

Alias dla InsightRequestUnion

InsightResultUnion

Alias dla InsightResultUnion

InsightSampleUnion

Alias dla InsightSampleUnion

InsightType

Prośba o wglądy.

ItemType

Typ elementu

ItemUnion

Alias dla ItemUnion

MCPToolCallStatus

Typ MCPToolCallStatus

MemoryItemKind

Rodzaj elementu pamięci.

MemoryItemUnion

Alias dla MemoryItemUnion

MemoryOperationKind

Rodzaj operacji pamięci.

MemoryStoreDefinitionUnion

Alias dla MemoryStoreDefinitionUnion

MemoryStoreKind

Typ implementacji magazynu pamięci, który ma być używany.

MemoryStoreUpdateMemoriesPoller

Niestandardowy LROPoller do operacji aktualizacji Memory Store.

MemoryStoreUpdateOperationState

Operacja aktualizacji stanu pamięci pamięci.

MemoryStoreUpdateStatus

Stan operacji aktualizacji magazynu pamięci.

OpenApiAuthDetailsUnion

Alias dla OpenApiAuthDetailsUnion

OpenApiAuthType

Typ uwierzytelniania dla punktu końcowego OpenAPI. Dozwolone typy to:

  • Anonimowy (uwierzytelnianie nie jest wymagane)
  • Project Connection (wymaga project_connection_id do punktu końcowego, jak skonfigurowano w AI Foundry)
  • Managed_Identity (wymaga odbiorców do uwierzytelniania opartego na tożsamości)
OperationState

Wyliczenie opisujące dozwolone stany operacji.

OutputContentType

Typ wyjściaContentType

OutputContentUnion

Alias dla OutputContentUnion

OutputMessageContentType

Typ wyjściaKomunikatContentType

OutputMessageContentUnion

Alias dla OutputMessageContentUnion

PageOrder

Typ kolejności stron

PendingUploadType

Typ oczekującego przesłania.

RankerVersionType

Typ rankeraWersjaTyp

ReasoningEffort

Ogranicza nakład pracy na rozumowanie modeli rozumowania. Obecnie obsługiwane wartości to none, minimal, low, medium, high, oraz .xhigh Zmniejszenie nakładu pracy w zakresie rozumowania może spowodować szybsze reagowanie i mniej tokenów używanych podczas rozumowania w odpowiedzi.

  • gpt-5.1 domyślnie przyjmuje none, co nie wykonuje rozumowania. Wartości wspieranego rozumowania dla gpt-5.1 to none, low, medium, oraz high. Wywołania narzędzi są obsługiwane dla wszystkich wartości rozumowania w gpt-5.1.
  • Wszystkie modele domyślnie gpt-5.1 polegają na medium wysiłku rozumowania i nie wspierają none.
  • Model domyślnie gpt-5-pro opiera się na (i jedynie wspiera) high wysiłek rozumowania.
  • xhigh jest obsługiwany dla wszystkich modeli po gpt-5.1-codex-max.
RecurrenceScheduleUnion

Alias dla RecurrenceScheduleUnion

RecurrenceType

Typ cyklu.

RiskCategory

Kategoria ryzyka dla celu ataku.

SampleType

Rodzaj próbki użytej w analizie.

ScheduleProvisioningStatus

Zaplanuj stan apryfikacji.

ScheduleTaskType

Typ zadania.

ScheduleTaskUnion

Alias dla ScheduleTaskUnion

SearchContextSize

Typ SearchContextSize

ServiceTier

Określa typ przetwarzania używany do obsługi żądania.

  • Jeśli ustawiono wartość "auto", żądanie zostanie przetworzone przy użyciu warstwy usługi skonfigurowanej w ustawieniach projektu. Jeśli nie skonfigurowano inaczej, projekt będzie używać wartości domyślnej.
  • Jeśli zostanie ustawiona wartość "domyślna", żądanie zostanie przetworzone przy użyciu standardowych cen i wydajności dla wybranego modelu.
  • Jeśli ustawiono na 'flex' lub 'priority', żądanie zostanie przetworzone z odpowiednim poziomem usługi.
  • Jeśli nie zostanie ustawiona, domyślne zachowanie to "auto". Po ustawieniu parametru service_tier treść odpowiedzi będzie zawierać service_tier wartość opartą na trybie przetwarzania używanym do obsługi żądania. Ta wartość odpowiedzi może różnić się od wartości ustawionej w parametrze .
TargetConfigUnion

Alias dla TargetConfigUnion

TargetUnion

Alias dla TargetUnion

TextResponseFormatConfigurationType

Typ tekstuOdpowiedźFormatKonfiguracjaTyp

TextResponseFormatConfigurationUnion

Alias dla TextResponseFormatConfigurationUnion

ToolType

Narzędzie, które może służyć do generowania odpowiedzi.

ToolUnion

Alias dla ToolUnion

TreatmentEffectType

Rodzaj efektu zabiegu.

TriggerType

Typ wyzwalacza.

TriggerUnion

Alias dla TriggerUnion

Verbosity

Ogranicza rozwlekłość odpowiedzi modelu. Niższe wartości skutkują bardziej zwięzłymi odpowiedziami, podczas gdy wyższe będą bardziej rozwlekłe. Obecnie obsługiwane wartości to low, mediumi high.

Enums

KnownApiVersions

Wersje interfejsu API usługi Azure AI Projects

Functions

restorePoller<TResponse, TResult>(AIProjectClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Tworzy poller ze stanu serializowanego innego poller. Może to być przydatne, gdy chcesz utworzyć sondy na innym hoście lub poller musi zostać skonstruowany po tym, jak oryginalny nie znajduje się w zakresie.

Szczegóły funkcji

restorePoller<TResponse, TResult>(AIProjectClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Tworzy poller ze stanu serializowanego innego poller. Może to być przydatne, gdy chcesz utworzyć sondy na innym hoście lub poller musi zostać skonstruowany po tym, jak oryginalny nie znajduje się w zakresie.

function restorePoller<TResponse, TResult>(client: AIProjectClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parametry

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Zwraca

PollerLike<OperationState<TResult>, TResult>