resources/base.ts

Source : sdks/typescript/packages/sdk/src/resources/base.ts. Retour à l'index de la référence du SDK TypeScript.

remarque

Cette page est générée par tools/docs/gen_sdk_reference.py depuis les sources du SDK et les dossiers de textes OpenAPI. Ne la modifiez pas à la main : changez la source et régénérez.

Alias de type CallOptions

Options par appel acceptées par toutes les méthodes du SDK.

Définition : Pick<RequestOptions, "headers" \| "idempotencyKey" \| "signal" \| "traceparent">.

Alias de type PathParams

Valeurs des emplacements {name} d'une route.

Définition : Record<string, string \| number>.

Alias de type Query

Paramètres de requête d'un appel.

Définition : Record<string, QueryValue>.

Classe Resource

Base des sous-clients du Control Plane : utilitaires call, page et iter sur le HttpClient partagé.

Attributs :

Nom	Type	Requis	Description
body	unknown,	non	Corps de l'appel effectué par l'utilitaire protégé call.
method	HttpMethod,	oui	Méthode HTTP de l'appel effectué par call.
opts	CallOptions & Pick<RequestOptions, "responseType">,	non	Options par appel de call : en-têtes, clé d'idempotence, signal, traceparent et type de réponse.
params	PathParams,	non	Valeurs des emplacements du chemin de call.
path	string,	oui	Gabarit de chemin de la route appelée par call.
query	Query,	non	Paramètres de requête de l'appel effectué par call.

Constructeur Resource

new Resource(readonly http: HttpClient)

Conserve le client HTTP partagé avec EnterpriseAI.

Nom	Type	Défaut	Requis	Description
readonly http	HttpClient		oui	Client HTTP du client EnterpriseAI.