AIProjectClient Class

Definition

The AzureAI service client.

public class AIProjectClient : System.ClientModel.Primitives.ClientConnectionProvider
type AIProjectClient = class
    inherit ClientConnectionProvider
Public Class AIProjectClient
Inherits ClientConnectionProvider
Inheritance

Constructors

Name Description
AIProjectClient()

Initializes a new instance of AIProjectClient for mocking.

AIProjectClient(AIProjectClientSettings)

Initializes a new instance of AIProjectClient from a AIProjectClientSettings.

AIProjectClient(Uri, AuthenticationTokenProvider, AIProjectClientOptions)

Initializes a new instance of AIProjectClient.

AIProjectClient(Uri, AuthenticationTokenProvider)

Initializes a new instance of AIProjectClient.

Properties

Name Description
AgentAdministrationClient

Gets the client for administering agents in this project.

Connections

Gets the client for managing connections.

DataGenerationJobs

Gets the client for managing data generation jobs.

Datasets

Gets the client for managing datasets.

Deployments

Gets the client for managing deployments.

EvaluationRules

Gets the client for managing evaluation rules.

EvaluationTaxonomies

Gets the client for managing evaluation taxonomies.

EvaluatorGenerationJobs

Gets the client for managing evaluator generation jobs.

Evaluators

Gets the client for managing project evaluators.

Indexes

Gets the client for managing indexes.

Insights

Gets the client for retrieving project insights.

MemoryStores

Gets the client for managing memory stores.

Models

Gets the client for managing model deployments and capabilities.

Pipeline

The HTTP pipeline for sending and receiving REST requests and responses.

ProjectOpenAIClient

Gets the client for invoking Azure OpenAI operations scoped to this project.

RedTeams

Gets the client for managing red team scans.

Routines

Gets the client for routines operations.

Schedules

Gets the client for managing project schedules.

Telemetry

Gets the client for telemetry operations.

Methods

Name Description
GetAIProjectMemoryStoresClient()

Initializes a new instance of AIProjectMemoryStores.

GetAllConnections()

Retrieves all available client connections managed by this provider.

(Inherited from ClientConnectionProvider)
GetConnection(String)

Retrieves the connection settings associated with a given connection ID.

(Inherited from ClientConnectionProvider)

Extension Methods

Name Description
GetAzureOpenAIChatClient(ClientConnectionProvider, String)

Gets the OpenAI chat client.

GetAzureOpenAIEmbeddingClient(ClientConnectionProvider, String)

Gets the OpenAI embedding client.

GetChatCompletionsClient(ClientConnectionProvider)

Gets the chat completion client.

GetEmbeddingsClient(ClientConnectionProvider)

Gets the embeddings client.

GetPersistentAgentsClient(ClientConnectionProvider)

Gets the agents client.

GetProjectAgentsClient(ClientConnectionProvider, Uri, AgentAdministrationClientOptions)

Builds an AgentAdministrationClient from the connection information surfaced by this ClientConnectionProvider.

GetProjectOpenAIClient(ClientConnectionProvider, ProjectOpenAIClientOptions)

Gets a project OpenAI client from the client connection provider.

GetProjectOpenAIClient(ClientConnectionProvider, ProjectOpenAIClientOptions)
GetSearchClient(ClientConnectionProvider, String)

Gets the search client.

GetSearchIndexClient(ClientConnectionProvider)

Gets the search client.

GetSearchIndexerClient(ClientConnectionProvider)

Gets the search client.

Applies to