@azure-rest/health-insights-cancerprofiling 1.0.0-alpha.20241126.1 → 1.0.0-alpha.20241128.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@azure-rest/health-insights-cancerprofiling",
3
3
  "sdk-type": "client",
4
4
  "author": "Microsoft Corporation",
5
- "version": "1.0.0-alpha.20241126.1",
5
+ "version": "1.0.0-alpha.20241128.1",
6
6
  "description": "A generated SDK for Health Insights Cancer Profiling Rest",
7
7
  "keywords": [
8
8
  "node",
@@ -62,7 +62,7 @@
62
62
  "@azure/abort-controller": "^2.1.2",
63
63
  "@azure/core-auth": "^1.9.0",
64
64
  "@azure/core-lro": "^2.7.2",
65
- "@azure/core-rest-pipeline": ">=1.18.0-alpha <1.18.0-alphb",
65
+ "@azure/core-rest-pipeline": "^1.18.0",
66
66
  "@azure/logger": "^1.1.4",
67
67
  "tslib": "^2.8.1"
68
68
  },
@@ -1,346 +0,0 @@
1
- import type { Client } from '@azure-rest/core-client';
2
- import type { ClientOptions } from '@azure-rest/core-client';
3
- import type { CreateHttpPollerOptions } from '@azure/core-lro';
4
- import type { ErrorResponse } from '@azure-rest/core-client';
5
- import type { HttpResponse } from '@azure-rest/core-client';
6
- import type { KeyCredential } from '@azure/core-auth';
7
- import type { OperationState } from '@azure/core-lro';
8
- import type { RawHttpHeaders } from '@azure/core-rest-pipeline';
9
- import type { RawHttpHeadersInput } from '@azure/core-rest-pipeline';
10
- import type { RequestParameters } from '@azure-rest/core-client';
11
- import type { SimplePollerLike } from '@azure/core-lro';
12
- import type { StreamableMethod } from '@azure-rest/core-client';
13
-
14
- export declare type CancerProfilingRestClient = Client & {
15
- path: Routes;
16
- };
17
-
18
- /** A piece of clinical information, expressed as a code in a clinical coding system. */
19
- export declare interface ClinicalCodedElement {
20
- /** The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS. */
21
- system: string;
22
- /** The code within the given clinical coding system. */
23
- code: string;
24
- /** The name of this coded concept in the coding system. */
25
- name?: string;
26
- /** A value associated with the code within the given clinical coding system. */
27
- value?: string;
28
- }
29
-
30
- /** A piece of clinical information, expressed as a code in a clinical coding system. */
31
- export declare interface ClinicalCodedElementOutput {
32
- /** The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS. */
33
- system: string;
34
- /** The code within the given clinical coding system. */
35
- code: string;
36
- /** The name of this coded concept in the coding system. */
37
- name?: string;
38
- /** A value associated with the code within the given clinical coding system. */
39
- value?: string;
40
- }
41
-
42
- /** A piece of evidence from a clinical note (text document). */
43
- export declare interface ClinicalNoteEvidenceOutput {
44
- /** The identifier of the document containing the evidence. */
45
- id: string;
46
- /** The actual text span which is evidence for the inference. */
47
- text?: string;
48
- /** The start index of the evidence text span in the document (0 based). */
49
- offset: number;
50
- /** The length of the evidence text span. */
51
- length: number;
52
- }
53
-
54
- /**
55
- * Initialize a new instance of `CancerProfilingRestClient`
56
- * @param endpoint - Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com).
57
- * @param credentials - uniquely identify client credential
58
- * @param options - the parameter for all optional parameters
59
- */
60
- declare function createClient(endpoint: string, credentials: KeyCredential, options?: ClientOptions): CancerProfilingRestClient;
61
- export default createClient;
62
-
63
- export declare interface CreateJob {
64
- /** Creates an Onco Phenotype job with the given request body. */
65
- post(options?: CreateJobParameters): StreamableMethod<CreateJob200Response | CreateJob202Response | CreateJobDefaultResponse>;
66
- }
67
-
68
- /** The request has succeeded. */
69
- export declare interface CreateJob200Response extends HttpResponse {
70
- status: "200";
71
- body: OncoPhenotypeResultOutput;
72
- }
73
-
74
- export declare interface CreateJob202Headers {
75
- /** The location for monitoring the operation state. */
76
- "operation-location": string;
77
- /** The Retry-After header can indicate how long the client should wait before polling the operation status. */
78
- "retry-after"?: number;
79
- /** Indicates whether the repeatable request was accepted or rejected. */
80
- "repeatability-result"?: "accepted" | "rejected";
81
- }
82
-
83
- /** The request has been accepted for processing, but processing has not yet completed. */
84
- export declare interface CreateJob202Response extends HttpResponse {
85
- status: "202";
86
- headers: RawHttpHeaders & CreateJob202Headers;
87
- }
88
-
89
- export declare interface CreateJobBodyParam {
90
- body?: OncoPhenotypeData;
91
- }
92
-
93
- export declare interface CreateJobDefaultHeaders {
94
- /** String error code indicating what went wrong. */
95
- "x-ms-error-code"?: string;
96
- }
97
-
98
- export declare interface CreateJobDefaultResponse extends HttpResponse {
99
- status: string;
100
- body: ErrorResponse;
101
- headers: RawHttpHeaders & CreateJobDefaultHeaders;
102
- }
103
-
104
- export declare interface CreateJobHeaderParam {
105
- headers?: RawHttpHeadersInput & CreateJobHeaders;
106
- }
107
-
108
- export declare interface CreateJobHeaders {
109
- /** An opaque, globally-unique, client-generated string identifier for the request. */
110
- "Repeatability-Request-ID"?: string;
111
- /** Specifies the date and time at which the request was first created. */
112
- "Repeatability-First-Sent"?: string;
113
- }
114
-
115
- /** The final response for long-running createJob operation */
116
- export declare interface CreateJobLogicalResponse extends HttpResponse {
117
- status: "200";
118
- body: OncoPhenotypeResultOutput;
119
- }
120
-
121
- export declare type CreateJobParameters = CreateJobHeaderParam & CreateJobBodyParam & RequestParameters;
122
-
123
- /** The content of the patient document. */
124
- export declare interface DocumentContent {
125
- /**
126
- * The type of the content's source.
127
- * In case the source type is 'inline', the content is given as a string (for instance, text).
128
- * In case the source type is 'reference', the content is given as a URI.
129
- *
130
- * Possible values: inline, reference
131
- */
132
- sourceType: string;
133
- /** The content of the document, given either inline (as a string) or as a reference (URI). */
134
- value: string;
135
- }
136
-
137
- /** The error object. */
138
- export declare interface ErrorModelOutput {
139
- /** One of a server-defined set of error codes. */
140
- code: string;
141
- /** A human-readable representation of the error. */
142
- message: string;
143
- /** The target of the error. */
144
- target?: string;
145
- /** An array of details about specific errors that led to this reported error. */
146
- details?: Array<ErrorModelOutput>;
147
- /** An object containing more specific information than the current object about the error. */
148
- innererror?: InnerErrorOutput;
149
- }
150
-
151
- export declare interface GetJob {
152
- /** Gets the status and details of the Onco Phenotype job. */
153
- get(options?: GetJobParameters): StreamableMethod<GetJob200Response | GetJobDefaultResponse>;
154
- }
155
-
156
- /** The request has succeeded. */
157
- export declare interface GetJob200Response extends HttpResponse {
158
- status: "200";
159
- body: OncoPhenotypeResultOutput;
160
- }
161
-
162
- export declare interface GetJobDefaultHeaders {
163
- /** String error code indicating what went wrong. */
164
- "x-ms-error-code"?: string;
165
- }
166
-
167
- export declare interface GetJobDefaultResponse extends HttpResponse {
168
- status: string;
169
- body: ErrorResponse;
170
- headers: RawHttpHeaders & GetJobDefaultHeaders;
171
- }
172
-
173
- export declare type GetJobParameters = RequestParameters;
174
-
175
- /**
176
- * Helper function that builds a Poller object to help polling a long running operation.
177
- * @param client - Client to use for sending the request to get additional pages.
178
- * @param initialResponse - The initial response.
179
- * @param options - Options to set a resume state or custom polling interval.
180
- * @returns - A poller object to poll for operation state updates and eventually get the final response.
181
- */
182
- export declare function getLongRunningPoller<TResult extends CreateJobLogicalResponse | CreateJobDefaultResponse>(client: Client, initialResponse: CreateJob200Response | CreateJob202Response | CreateJobDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
183
-
184
- /** A piece of evidence corresponding to an inference. */
185
- export declare interface InferenceEvidenceOutput {
186
- /** A piece of evidence from a clinical note (text document). */
187
- patientDataEvidence?: ClinicalNoteEvidenceOutput;
188
- /**
189
- * A piece of clinical information, expressed as a code in a clinical coding
190
- * system.
191
- */
192
- patientInfoEvidence?: ClinicalCodedElementOutput;
193
- /** A value indicating how important this piece of evidence is for the inference. */
194
- importance?: number;
195
- }
196
-
197
- /** An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. */
198
- export declare interface InnerErrorOutput {
199
- /** One of a server-defined set of error codes. */
200
- code?: string;
201
- /** Inner error. */
202
- innererror?: InnerErrorOutput;
203
- }
204
-
205
- export declare function isUnexpected(response: GetJob200Response | GetJobDefaultResponse): response is GetJobDefaultResponse;
206
-
207
- export declare function isUnexpected(response: CreateJob200Response | CreateJob202Response | CreateJobLogicalResponse | CreateJobDefaultResponse): response is CreateJobDefaultResponse;
208
-
209
- /** The body of the Onco Phenotype request. */
210
- export declare interface OncoPhenotypeData {
211
- /** The list of patients, including their clinical information and data. */
212
- patients: Array<PatientRecord>;
213
- /** Configuration affecting the Onco Phenotype model's inference. */
214
- configuration?: OncoPhenotypeModelConfiguration;
215
- }
216
-
217
- /** An inference made by the Onco Phenotype model regarding a patient. */
218
- export declare interface OncoPhenotypeInferenceOutput {
219
- /**
220
- * The type of the Onco Phenotype inference
221
- *
222
- * Possible values: tumorSite, histology, clinicalStageT, clinicalStageN, clinicalStageM, pathologicStageT, pathologicStageN, pathologicStageM
223
- */
224
- type: string;
225
- /** The value of the inference, as relevant for the given inference type. */
226
- value: string;
227
- /** The description corresponding to the inference value. */
228
- description?: string;
229
- /** Confidence score for this inference. */
230
- confidenceScore?: number;
231
- /** The evidence corresponding to the inference value. */
232
- evidence?: Array<InferenceEvidenceOutput>;
233
- /** An identifier for a clinical case, if there are multiple clinical cases regarding the same patient. */
234
- caseId?: string;
235
- }
236
-
237
- /** Configuration affecting the Onco Phenotype model's inference. */
238
- export declare interface OncoPhenotypeModelConfiguration {
239
- /** An indication whether the model should produce verbose output. */
240
- verbose?: boolean;
241
- /** An indication whether the model's output should include evidence for the inferences. */
242
- includeEvidence?: boolean;
243
- /**
244
- * A list of inference types to be inferred for the current request.
245
- * This could be used if only part of the Onco Phenotype inferences are required.
246
- * If this list is omitted or empty, the model will return all the inference types.
247
- */
248
- inferenceTypes?: string[];
249
- /** An indication whether to perform a preliminary step on the patient's documents to determine whether they relate to a Cancer case. */
250
- checkForCancerCase?: boolean;
251
- }
252
-
253
- /** The results of the model's work for a single patient. */
254
- export declare interface OncoPhenotypePatientResultOutput {
255
- /** The identifier given for the patient in the request. */
256
- id: string;
257
- /** The model's inferences for the given patient. */
258
- inferences: Array<OncoPhenotypeInferenceOutput>;
259
- }
260
-
261
- /** The response for the Onco Phenotype request. */
262
- export declare interface OncoPhenotypeResultOutput {
263
- /** A processing job identifier. */
264
- readonly jobId: string;
265
- /** The date and time when the processing job was created. */
266
- readonly createdDateTime: string;
267
- /** The date and time when the processing job is set to expire. */
268
- readonly expirationDateTime: string;
269
- /** The date and time when the processing job was last updated. */
270
- readonly lastUpdateDateTime: string;
271
- /**
272
- * The status of the processing job.
273
- *
274
- * Possible values: notStarted, running, succeeded, failed, partiallyCompleted
275
- */
276
- readonly status: string;
277
- /** An array of errors, if any errors occurred during the processing job. */
278
- readonly errors?: Array<ErrorModelOutput>;
279
- /** The inference results for the Onco Phenotype request. */
280
- readonly results?: OncoPhenotypeResultsOutput;
281
- }
282
-
283
- /** The inference results for the Onco Phenotype request. */
284
- export declare interface OncoPhenotypeResultsOutput {
285
- /** Results for the patients given in the request. */
286
- patients: Array<OncoPhenotypePatientResultOutput>;
287
- /** The version of the model used for inference, expressed as the model date. */
288
- modelVersion: string;
289
- }
290
-
291
- /** A clinical document related to a patient. Document here is in the wide sense - not just a text document (note). */
292
- export declare interface PatientDocument {
293
- /**
294
- * The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON document).
295
- *
296
- * Possible values: note, fhirBundle, dicom, genomicSequencing
297
- */
298
- type: string;
299
- /**
300
- * The type of the clinical document.
301
- *
302
- * Possible values: consultation, dischargeSummary, historyAndPhysical, procedure, progress, imaging, laboratory, pathology
303
- */
304
- clinicalType?: string;
305
- /** A given identifier for the document. Has to be unique across all documents for a single patient. */
306
- id: string;
307
- /** A 2 letter ISO 639-1 representation of the language of the document. */
308
- language?: string;
309
- /** The date and time when the document was created. */
310
- createdDateTime?: Date | string;
311
- /** The content of the patient document. */
312
- content: DocumentContent;
313
- }
314
-
315
- /** Patient structured information, including demographics and known structured clinical information. */
316
- export declare interface PatientInfo {
317
- /**
318
- * The patient's sex.
319
- *
320
- * Possible values: female, male, unspecified
321
- */
322
- sex?: string;
323
- /** The patient's date of birth. */
324
- birthDate?: Date | string;
325
- /** Known clinical information for the patient, structured. */
326
- clinicalInfo?: Array<ClinicalCodedElement>;
327
- }
328
-
329
- /** A patient record, including their clinical information and data. */
330
- export declare interface PatientRecord {
331
- /** A given identifier for the patient. Has to be unique across all patients in a single request. */
332
- id: string;
333
- /** Patient structured information, including demographics and known structured clinical information. */
334
- info?: PatientInfo;
335
- /** Patient unstructured clinical data, given as documents. */
336
- data?: Array<PatientDocument>;
337
- }
338
-
339
- export declare interface Routes {
340
- /** Resource for '/oncophenotype/jobs/\{jobId\}' has methods for the following verbs: get */
341
- (path: "/oncophenotype/jobs/{jobId}", jobId: string): GetJob;
342
- /** Resource for '/oncophenotype/jobs' has methods for the following verbs: post */
343
- (path: "/oncophenotype/jobs"): CreateJob;
344
- }
345
-
346
- export { }