OpenAIToolingConfiguration class

Πακέτο:: @microsoft/agents-a365-tooling-extensions-openai

Ρύθμιση παραμέτρων για το πακέτο επέκτασης εργαλείων OpenAI. Κληρονομεί όλες τις ρυθμίσεις εργαλείων και χρόνου εκτέλεσης.

Γιατί υπάρχει αυτή η κλάση

Παρόλο που αυτή η κλάση δεν προσθέτει προς το παρόν νέες ρυθμίσεις πέρα από αυτές που παρέχει η ToolingConfiguration, υπάρχει για πολλούς σημαντικούς λόγους:

Ασφάλεια τύπου: Επιτρέπει στις υπηρεσίες openAI να δηλώνουν την εξάρτησή τους στο IConfigurationProvider<OpenAIToolingConfiguration>, καθιστώντας τη σύμβαση ρύθμισης παραμέτρων ρητή και ενεργοποιώντας τον έλεγχο χρόνου μεταγλώττισης.
Σημείο επέκτασης: Παρέχει ένα σαφές σημείο για την προσθήκη ρυθμίσεων OpenAI ειδικά (π.χ. χρονικά όρια Agents SDK, διαστήματα ανίχνευσης νήματος, εκτέλεση ορίων) χωρίς διακοπή του υπάρχοντος κώδικα όταν προκύπτουν αυτές οι ανάγκες.
Συνεπές μοτίβο: Διατηρεί τη συμμετρία με άλλα πακέτα επεκτάσεων (Claude, LangChain), διευκολύνοντας την κατανόηση και την περιήγηση στο SDK.
Έγχυση εξάρτησης: Οι υπηρεσίες μπορούν να σχεδιαστούν για να αποδέχονται αυτόν τον συγκεκριμένο τύπο ρύθμισης παραμέτρων, ενεργοποιώντας κατάλληλα μοτίβα IoC και δυνατότητα δοκιμών.

Παράδειγμα

// Service declares explicit dependency on OpenAI configuration
class OpenAIService {
  constructor(private configProvider: IConfigurationProvider<OpenAIToolingConfiguration>) {}
}

// Future: Add OpenAI-specific settings without breaking changes
class OpenAIToolingConfiguration extends ToolingConfiguration {
  get threadPollingInterval(): number { ... }
}

Επεκτείνει: ToolingConfiguration

Κατασκευές

OpenAIToolingConfiguration(ToolingConfigurationOptions)

Ιδιότητες

clusterCategory
isDevelopmentEnvironment	Εάν το σύμπλεγμα είναι περιβάλλον ανάπτυξης (τοπικό ή dev). Βασίζεται σε σύμπλεγμαΚατηγορία.
isNodeEnvDevelopment	Εάν NODE_ENV υποδεικνύει τη λειτουργία ανάπτυξης. Επιστρέφει την τιμή true όταν NODE_ENV είναι "ανάπτυξη" (χωρίς διάκριση πεζών-κεφαλαίων). Αυτός είναι ο τυπικός Node.js τρόπος υπόδειξης της λειτουργίας ανάπτυξης.
mcpPlatformAuthenticationScope	Λαμβάνει την εμβέλεια ελέγχου ταυτότητας της πλατφόρμας MCP. Χρησιμοποιείται από το AgenticAuthenticationService για exchange διακριτικών. Εκτελεί περικοπή κενών διαστημάτων για να αποτρέπονται αποτυχίες ανταλλαγής διακριτικών.
mcpPlatformEndpoint
useToolingManifest	Εάν θα χρησιμοποιείτε το αρχείο ToolingManifest.json αντί τον εντοπισμό πύλης. Επιστρέφει την τιμή true όταν NODE_ENV ορίζεται σε "ανάπτυξη" (χωρίς διάκριση πεζών-κεφαλαίων) ή όταν παρακάμπτεται ρητά μέσω της ρύθμισης παραμέτρων.

Μέθοδοι μεταβίβασης

getBearerTokenForServer(string)	Επιστρέφει το διακριτικό φορέα της λειτουργίας ανάπτυξης για έναν διακομιστή MCP βάσει ονόματος. Ελέγχει πρώτα BEARER_TOKEN_<SERVERNAME_UPPER> και, στη συνέχεια, επιστρέφει στο BEARER_TOKEN. Επιστρέφει μη καθορισμένο όταν η μεταβλητή δεν έχει οριστεί (δεν θα επισυναφθεί κεφαλίδα εξουσιοδότησης).
hasPerServerBearerToken(string)	Επιστρέφει την τιμή true όταν ένα διακριτικό φορέα ανά διακομιστή env var (BEARER_TOKEN_<SERVERNAME_UPPER>) ορίζεται ρητά για τον δεδομένο διακομιστή, false όταν θα χρησιμοποιείται μόνο η κοινόχρηστη BEARER_TOKEN εναλλακτική. Χρησιμοποιείται για τον εντοπισμό διακομιστών V2 που επιστρέφουν χωρίς μηνύματα σε ένα διακριτικό εσφαλμένου ακροατηρίου σε λειτουργία ανάπτυξης.
parseEnvBoolean(undefined \| string)	Ανάλυση μιας μεταβλητής περιβάλλοντος ως δυαδικής τιμής. Αναγνωρίζει τα στοιχεία "true", "1", "ναι", "on" (χωρίς διάκριση πεζών-κεφαλαίων) ως true. όλες οι άλλες τιμές ως false.
parseEnvInt(undefined \| string, number)	Αναλύστε μια μεταβλητή περιβάλλοντος ως ακέραιο, επιστρέφοντας την επιστροφή εάν δεν είναι έγκυρη ή δεν έχει οριστεί.

Λεπτομέρειες κατασκευής

OpenAIToolingConfiguration(ToolingConfigurationOptions)

new OpenAIToolingConfiguration(overrides?: ToolingConfigurationOptions)

Παράμετροι

overrides: ToolingConfigurationOptions

Λεπτομέρειες ιδιότητας

clusterCategory

ClusterCategory clusterCategory

Τιμή ιδιότητας

ClusterCategory

isDevelopmentEnvironment

Εάν το σύμπλεγμα είναι περιβάλλον ανάπτυξης (τοπικό ή dev). Βασίζεται σε σύμπλεγμαΚατηγορία.

boolean isDevelopmentEnvironment

Τιμή ιδιότητας

boolean

isNodeEnvDevelopment

Εάν NODE_ENV υποδεικνύει τη λειτουργία ανάπτυξης. Επιστρέφει την τιμή true όταν NODE_ENV είναι "ανάπτυξη" (χωρίς διάκριση πεζών-κεφαλαίων). Αυτός είναι ο τυπικός Node.js τρόπος υπόδειξης της λειτουργίας ανάπτυξης.

boolean isNodeEnvDevelopment

Τιμή ιδιότητας

boolean

mcpPlatformAuthenticationScope

Λαμβάνει την εμβέλεια ελέγχου ταυτότητας της πλατφόρμας MCP. Χρησιμοποιείται από το AgenticAuthenticationService για exchange διακριτικών. Εκτελεί περικοπή κενών διαστημάτων για να αποτρέπονται αποτυχίες ανταλλαγής διακριτικών.

string mcpPlatformAuthenticationScope

Τιμή ιδιότητας

string

mcpPlatformEndpoint

string mcpPlatformEndpoint

Τιμή ιδιότητας

string

useToolingManifest

Εάν θα χρησιμοποιείτε το αρχείο ToolingManifest.json αντί τον εντοπισμό πύλης. Επιστρέφει την τιμή true όταν NODE_ENV ορίζεται σε "ανάπτυξη" (χωρίς διάκριση πεζών-κεφαλαίων) ή όταν παρακάμπτεται ρητά μέσω της ρύθμισης παραμέτρων.

boolean useToolingManifest

Τιμή ιδιότητας

boolean

Λεπτομέρειες μεθόδων μεταβίβασης

getBearerTokenForServer(string)

Επιστρέφει το διακριτικό φορέα της λειτουργίας ανάπτυξης για έναν διακομιστή MCP βάσει ονόματος. Ελέγχει πρώτα BEARER_TOKEN_<SERVERNAME_UPPER> και, στη συνέχεια, επιστρέφει στο BEARER_TOKEN. Επιστρέφει μη καθορισμένο όταν η μεταβλητή δεν έχει οριστεί (δεν θα επισυναφθεί κεφαλίδα εξουσιοδότησης).

function getBearerTokenForServer(mcpServerName: string): undefined | string

Παράμετροι

mcpServerName: string

Επιστροφές

undefined | string

Μεταβίβαση από ToolingConfiguration.getBearerTokenForServer

hasPerServerBearerToken(string)

Επιστρέφει την τιμή true όταν ένα διακριτικό φορέα ανά διακομιστή env var (BEARER_TOKEN_<SERVERNAME_UPPER>) ορίζεται ρητά για τον δεδομένο διακομιστή, false όταν θα χρησιμοποιείται μόνο η κοινόχρηστη BEARER_TOKEN εναλλακτική. Χρησιμοποιείται για τον εντοπισμό διακομιστών V2 που επιστρέφουν χωρίς μηνύματα σε ένα διακριτικό εσφαλμένου ακροατηρίου σε λειτουργία ανάπτυξης.

function hasPerServerBearerToken(mcpServerName: string): boolean

Παράμετροι

mcpServerName: string

Επιστροφές

boolean

Μεταβίβαση από ToolingConfiguration.hasPerServerBearerToken

parseEnvBoolean(undefined | string)

Ανάλυση μιας μεταβλητής περιβάλλοντος ως δυαδικής τιμής. Αναγνωρίζει τα στοιχεία "true", "1", "ναι", "on" (χωρίς διάκριση πεζών-κεφαλαίων) ως true. όλες οι άλλες τιμές ως false.

static function parseEnvBoolean(envValue: undefined | string): boolean

Παράμετροι

envValue: undefined | string

Επιστροφές

boolean

Μεταβίβαση από ToolingConfiguration.parseEnvBoolean

parseEnvInt(undefined | string, number)

Αναλύστε μια μεταβλητή περιβάλλοντος ως ακέραιο, επιστρέφοντας την επιστροφή εάν δεν είναι έγκυρη ή δεν έχει οριστεί.

static function parseEnvInt(envValue: undefined | string, fallback: number): number

Παράμετροι

envValue: undefined | string

fallback: number

Επιστροφές

number

Μεταβίβαση από ToolingConfiguration.parseEnvInt