@azure-rest/health-insights-cancerprofiling 1.0.0-alpha.20250620.1 → 1.0.0-alpha.20250718.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.20250620.1",
5
+ "version": "1.0.0-alpha.20250718.1",
6
6
  "description": "A generated SDK for Health Insights Cancer Profiling Rest",
7
7
  "keywords": [
8
8
  "node",
@@ -1,272 +1,272 @@
1
- ## API Report File for "@azure-rest/health-insights-cancerprofiling"
2
-
3
- > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
-
5
- ```ts
6
-
7
- import type { Client } from '@azure-rest/core-client';
8
- import type { ClientOptions } from '@azure-rest/core-client';
9
- import type { CreateHttpPollerOptions } from '@azure/core-lro';
10
- import type { ErrorResponse } from '@azure-rest/core-client';
11
- import type { HttpResponse } from '@azure-rest/core-client';
12
- import type { KeyCredential } from '@azure/core-auth';
13
- import type { OperationState } from '@azure/core-lro';
14
- import type { RawHttpHeaders } from '@azure/core-rest-pipeline';
15
- import type { RawHttpHeadersInput } from '@azure/core-rest-pipeline';
16
- import type { RequestParameters } from '@azure-rest/core-client';
17
- import type { SimplePollerLike } from '@azure/core-lro';
18
- import type { StreamableMethod } from '@azure-rest/core-client';
19
-
20
- // @public (undocumented)
21
- export type CancerProfilingRestClient = Client & {
22
- path: Routes;
23
- };
24
-
25
- // @public
26
- export interface ClinicalCodedElement {
27
- code: string;
28
- name?: string;
29
- system: string;
30
- value?: string;
31
- }
32
-
33
- // @public
34
- export interface ClinicalCodedElementOutput {
35
- code: string;
36
- name?: string;
37
- system: string;
38
- value?: string;
39
- }
40
-
41
- // @public
42
- export interface ClinicalNoteEvidenceOutput {
43
- id: string;
44
- length: number;
45
- offset: number;
46
- text?: string;
47
- }
48
-
49
- // @public
50
- function createClient(endpoint: string, credentials: KeyCredential, options?: ClientOptions): CancerProfilingRestClient;
51
- export default createClient;
52
-
53
- // @public (undocumented)
54
- export interface CreateJob {
55
- post(options?: CreateJobParameters): StreamableMethod<CreateJob200Response | CreateJob202Response | CreateJobDefaultResponse>;
56
- }
57
-
58
- // @public
59
- export interface CreateJob200Response extends HttpResponse {
60
- // (undocumented)
61
- body: OncoPhenotypeResultOutput;
62
- // (undocumented)
63
- status: "200";
64
- }
65
-
66
- // @public (undocumented)
67
- export interface CreateJob202Headers {
68
- "operation-location": string;
69
- "repeatability-result"?: "accepted" | "rejected";
70
- "retry-after"?: number;
71
- }
72
-
73
- // @public
74
- export interface CreateJob202Response extends HttpResponse {
75
- // (undocumented)
76
- headers: RawHttpHeaders & CreateJob202Headers;
77
- // (undocumented)
78
- status: "202";
79
- }
80
-
81
- // @public (undocumented)
82
- export interface CreateJobBodyParam {
83
- // (undocumented)
84
- body?: OncoPhenotypeData;
85
- }
86
-
87
- // @public (undocumented)
88
- export interface CreateJobDefaultHeaders {
89
- "x-ms-error-code"?: string;
90
- }
91
-
92
- // @public (undocumented)
93
- export interface CreateJobDefaultResponse extends HttpResponse {
94
- // (undocumented)
95
- body: ErrorResponse;
96
- // (undocumented)
97
- headers: RawHttpHeaders & CreateJobDefaultHeaders;
98
- // (undocumented)
99
- status: string;
100
- }
101
-
102
- // @public (undocumented)
103
- export interface CreateJobHeaderParam {
104
- // (undocumented)
105
- headers?: RawHttpHeadersInput & CreateJobHeaders;
106
- }
107
-
108
- // @public (undocumented)
109
- export interface CreateJobHeaders {
110
- "Repeatability-First-Sent"?: string;
111
- "Repeatability-Request-ID"?: string;
112
- }
113
-
114
- // @public
115
- export interface CreateJobLogicalResponse extends HttpResponse {
116
- // (undocumented)
117
- body: OncoPhenotypeResultOutput;
118
- // (undocumented)
119
- status: "200";
120
- }
121
-
122
- // @public (undocumented)
123
- export type CreateJobParameters = CreateJobHeaderParam & CreateJobBodyParam & RequestParameters;
124
-
125
- // @public
126
- export interface DocumentContent {
127
- sourceType: string;
128
- value: string;
129
- }
130
-
131
- // @public
132
- export interface ErrorModelOutput {
133
- code: string;
134
- details?: Array<ErrorModelOutput>;
135
- innererror?: InnerErrorOutput;
136
- message: string;
137
- target?: string;
138
- }
139
-
140
- // @public (undocumented)
141
- export interface GetJob {
142
- get(options?: GetJobParameters): StreamableMethod<GetJob200Response | GetJobDefaultResponse>;
143
- }
144
-
145
- // @public
146
- export interface GetJob200Response extends HttpResponse {
147
- // (undocumented)
148
- body: OncoPhenotypeResultOutput;
149
- // (undocumented)
150
- status: "200";
151
- }
152
-
153
- // @public (undocumented)
154
- export interface GetJobDefaultHeaders {
155
- "x-ms-error-code"?: string;
156
- }
157
-
158
- // @public (undocumented)
159
- export interface GetJobDefaultResponse extends HttpResponse {
160
- // (undocumented)
161
- body: ErrorResponse;
162
- // (undocumented)
163
- headers: RawHttpHeaders & GetJobDefaultHeaders;
164
- // (undocumented)
165
- status: string;
166
- }
167
-
168
- // @public (undocumented)
169
- export type GetJobParameters = RequestParameters;
170
-
171
- // @public
172
- export function getLongRunningPoller<TResult extends CreateJobLogicalResponse | CreateJobDefaultResponse>(client: Client, initialResponse: CreateJob200Response | CreateJob202Response | CreateJobDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
173
-
174
- // @public
175
- export interface InferenceEvidenceOutput {
176
- importance?: number;
177
- patientDataEvidence?: ClinicalNoteEvidenceOutput;
178
- patientInfoEvidence?: ClinicalCodedElementOutput;
179
- }
180
-
181
- // @public
182
- export interface InnerErrorOutput {
183
- code?: string;
184
- innererror?: InnerErrorOutput;
185
- }
186
-
187
- // @public (undocumented)
188
- export function isUnexpected(response: GetJob200Response | GetJobDefaultResponse): response is GetJobDefaultResponse;
189
-
190
- // @public (undocumented)
191
- export function isUnexpected(response: CreateJob200Response | CreateJob202Response | CreateJobLogicalResponse | CreateJobDefaultResponse): response is CreateJobDefaultResponse;
192
-
193
- // @public
194
- export interface OncoPhenotypeData {
195
- configuration?: OncoPhenotypeModelConfiguration;
196
- patients: Array<PatientRecord>;
197
- }
198
-
199
- // @public
200
- export interface OncoPhenotypeInferenceOutput {
201
- caseId?: string;
202
- confidenceScore?: number;
203
- description?: string;
204
- evidence?: Array<InferenceEvidenceOutput>;
205
- type: string;
206
- value: string;
207
- }
208
-
209
- // @public
210
- export interface OncoPhenotypeModelConfiguration {
211
- checkForCancerCase?: boolean;
212
- includeEvidence?: boolean;
213
- inferenceTypes?: string[];
214
- verbose?: boolean;
215
- }
216
-
217
- // @public
218
- export interface OncoPhenotypePatientResultOutput {
219
- id: string;
220
- inferences: Array<OncoPhenotypeInferenceOutput>;
221
- }
222
-
223
- // @public
224
- export interface OncoPhenotypeResultOutput {
225
- readonly createdDateTime: string;
226
- readonly errors?: Array<ErrorModelOutput>;
227
- readonly expirationDateTime: string;
228
- readonly jobId: string;
229
- readonly lastUpdateDateTime: string;
230
- readonly results?: OncoPhenotypeResultsOutput;
231
- readonly status: string;
232
- }
233
-
234
- // @public
235
- export interface OncoPhenotypeResultsOutput {
236
- modelVersion: string;
237
- patients: Array<OncoPhenotypePatientResultOutput>;
238
- }
239
-
240
- // @public
241
- export interface PatientDocument {
242
- clinicalType?: string;
243
- content: DocumentContent;
244
- createdDateTime?: Date | string;
245
- id: string;
246
- language?: string;
247
- type: string;
248
- }
249
-
250
- // @public
251
- export interface PatientInfo {
252
- birthDate?: Date | string;
253
- clinicalInfo?: Array<ClinicalCodedElement>;
254
- sex?: string;
255
- }
256
-
257
- // @public
258
- export interface PatientRecord {
259
- data?: Array<PatientDocument>;
260
- id: string;
261
- info?: PatientInfo;
262
- }
263
-
264
- // @public (undocumented)
265
- export interface Routes {
266
- (path: "/oncophenotype/jobs/{jobId}", jobId: string): GetJob;
267
- (path: "/oncophenotype/jobs"): CreateJob;
268
- }
269
-
270
- // (No @packageDocumentation comment for this package)
271
-
272
- ```
1
+ ## API Report File for "@azure-rest/health-insights-cancerprofiling"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+
7
+ import type { Client } from '@azure-rest/core-client';
8
+ import type { ClientOptions } from '@azure-rest/core-client';
9
+ import type { CreateHttpPollerOptions } from '@azure/core-lro';
10
+ import type { ErrorResponse } from '@azure-rest/core-client';
11
+ import type { HttpResponse } from '@azure-rest/core-client';
12
+ import type { KeyCredential } from '@azure/core-auth';
13
+ import type { OperationState } from '@azure/core-lro';
14
+ import type { RawHttpHeaders } from '@azure/core-rest-pipeline';
15
+ import type { RawHttpHeadersInput } from '@azure/core-rest-pipeline';
16
+ import type { RequestParameters } from '@azure-rest/core-client';
17
+ import type { SimplePollerLike } from '@azure/core-lro';
18
+ import type { StreamableMethod } from '@azure-rest/core-client';
19
+
20
+ // @public (undocumented)
21
+ export type CancerProfilingRestClient = Client & {
22
+ path: Routes;
23
+ };
24
+
25
+ // @public
26
+ export interface ClinicalCodedElement {
27
+ code: string;
28
+ name?: string;
29
+ system: string;
30
+ value?: string;
31
+ }
32
+
33
+ // @public
34
+ export interface ClinicalCodedElementOutput {
35
+ code: string;
36
+ name?: string;
37
+ system: string;
38
+ value?: string;
39
+ }
40
+
41
+ // @public
42
+ export interface ClinicalNoteEvidenceOutput {
43
+ id: string;
44
+ length: number;
45
+ offset: number;
46
+ text?: string;
47
+ }
48
+
49
+ // @public
50
+ function createClient(endpoint: string, credentials: KeyCredential, options?: ClientOptions): CancerProfilingRestClient;
51
+ export default createClient;
52
+
53
+ // @public (undocumented)
54
+ export interface CreateJob {
55
+ post(options?: CreateJobParameters): StreamableMethod<CreateJob200Response | CreateJob202Response | CreateJobDefaultResponse>;
56
+ }
57
+
58
+ // @public
59
+ export interface CreateJob200Response extends HttpResponse {
60
+ // (undocumented)
61
+ body: OncoPhenotypeResultOutput;
62
+ // (undocumented)
63
+ status: "200";
64
+ }
65
+
66
+ // @public (undocumented)
67
+ export interface CreateJob202Headers {
68
+ "operation-location": string;
69
+ "repeatability-result"?: "accepted" | "rejected";
70
+ "retry-after"?: number;
71
+ }
72
+
73
+ // @public
74
+ export interface CreateJob202Response extends HttpResponse {
75
+ // (undocumented)
76
+ headers: RawHttpHeaders & CreateJob202Headers;
77
+ // (undocumented)
78
+ status: "202";
79
+ }
80
+
81
+ // @public (undocumented)
82
+ export interface CreateJobBodyParam {
83
+ // (undocumented)
84
+ body?: OncoPhenotypeData;
85
+ }
86
+
87
+ // @public (undocumented)
88
+ export interface CreateJobDefaultHeaders {
89
+ "x-ms-error-code"?: string;
90
+ }
91
+
92
+ // @public (undocumented)
93
+ export interface CreateJobDefaultResponse extends HttpResponse {
94
+ // (undocumented)
95
+ body: ErrorResponse;
96
+ // (undocumented)
97
+ headers: RawHttpHeaders & CreateJobDefaultHeaders;
98
+ // (undocumented)
99
+ status: string;
100
+ }
101
+
102
+ // @public (undocumented)
103
+ export interface CreateJobHeaderParam {
104
+ // (undocumented)
105
+ headers?: RawHttpHeadersInput & CreateJobHeaders;
106
+ }
107
+
108
+ // @public (undocumented)
109
+ export interface CreateJobHeaders {
110
+ "Repeatability-First-Sent"?: string;
111
+ "Repeatability-Request-ID"?: string;
112
+ }
113
+
114
+ // @public
115
+ export interface CreateJobLogicalResponse extends HttpResponse {
116
+ // (undocumented)
117
+ body: OncoPhenotypeResultOutput;
118
+ // (undocumented)
119
+ status: "200";
120
+ }
121
+
122
+ // @public (undocumented)
123
+ export type CreateJobParameters = CreateJobHeaderParam & CreateJobBodyParam & RequestParameters;
124
+
125
+ // @public
126
+ export interface DocumentContent {
127
+ sourceType: string;
128
+ value: string;
129
+ }
130
+
131
+ // @public
132
+ export interface ErrorModelOutput {
133
+ code: string;
134
+ details?: Array<ErrorModelOutput>;
135
+ innererror?: InnerErrorOutput;
136
+ message: string;
137
+ target?: string;
138
+ }
139
+
140
+ // @public (undocumented)
141
+ export interface GetJob {
142
+ get(options?: GetJobParameters): StreamableMethod<GetJob200Response | GetJobDefaultResponse>;
143
+ }
144
+
145
+ // @public
146
+ export interface GetJob200Response extends HttpResponse {
147
+ // (undocumented)
148
+ body: OncoPhenotypeResultOutput;
149
+ // (undocumented)
150
+ status: "200";
151
+ }
152
+
153
+ // @public (undocumented)
154
+ export interface GetJobDefaultHeaders {
155
+ "x-ms-error-code"?: string;
156
+ }
157
+
158
+ // @public (undocumented)
159
+ export interface GetJobDefaultResponse extends HttpResponse {
160
+ // (undocumented)
161
+ body: ErrorResponse;
162
+ // (undocumented)
163
+ headers: RawHttpHeaders & GetJobDefaultHeaders;
164
+ // (undocumented)
165
+ status: string;
166
+ }
167
+
168
+ // @public (undocumented)
169
+ export type GetJobParameters = RequestParameters;
170
+
171
+ // @public
172
+ export function getLongRunningPoller<TResult extends CreateJobLogicalResponse | CreateJobDefaultResponse>(client: Client, initialResponse: CreateJob200Response | CreateJob202Response | CreateJobDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
173
+
174
+ // @public
175
+ export interface InferenceEvidenceOutput {
176
+ importance?: number;
177
+ patientDataEvidence?: ClinicalNoteEvidenceOutput;
178
+ patientInfoEvidence?: ClinicalCodedElementOutput;
179
+ }
180
+
181
+ // @public
182
+ export interface InnerErrorOutput {
183
+ code?: string;
184
+ innererror?: InnerErrorOutput;
185
+ }
186
+
187
+ // @public (undocumented)
188
+ export function isUnexpected(response: GetJob200Response | GetJobDefaultResponse): response is GetJobDefaultResponse;
189
+
190
+ // @public (undocumented)
191
+ export function isUnexpected(response: CreateJob200Response | CreateJob202Response | CreateJobLogicalResponse | CreateJobDefaultResponse): response is CreateJobDefaultResponse;
192
+
193
+ // @public
194
+ export interface OncoPhenotypeData {
195
+ configuration?: OncoPhenotypeModelConfiguration;
196
+ patients: Array<PatientRecord>;
197
+ }
198
+
199
+ // @public
200
+ export interface OncoPhenotypeInferenceOutput {
201
+ caseId?: string;
202
+ confidenceScore?: number;
203
+ description?: string;
204
+ evidence?: Array<InferenceEvidenceOutput>;
205
+ type: string;
206
+ value: string;
207
+ }
208
+
209
+ // @public
210
+ export interface OncoPhenotypeModelConfiguration {
211
+ checkForCancerCase?: boolean;
212
+ includeEvidence?: boolean;
213
+ inferenceTypes?: string[];
214
+ verbose?: boolean;
215
+ }
216
+
217
+ // @public
218
+ export interface OncoPhenotypePatientResultOutput {
219
+ id: string;
220
+ inferences: Array<OncoPhenotypeInferenceOutput>;
221
+ }
222
+
223
+ // @public
224
+ export interface OncoPhenotypeResultOutput {
225
+ readonly createdDateTime: string;
226
+ readonly errors?: Array<ErrorModelOutput>;
227
+ readonly expirationDateTime: string;
228
+ readonly jobId: string;
229
+ readonly lastUpdateDateTime: string;
230
+ readonly results?: OncoPhenotypeResultsOutput;
231
+ readonly status: string;
232
+ }
233
+
234
+ // @public
235
+ export interface OncoPhenotypeResultsOutput {
236
+ modelVersion: string;
237
+ patients: Array<OncoPhenotypePatientResultOutput>;
238
+ }
239
+
240
+ // @public
241
+ export interface PatientDocument {
242
+ clinicalType?: string;
243
+ content: DocumentContent;
244
+ createdDateTime?: Date | string;
245
+ id: string;
246
+ language?: string;
247
+ type: string;
248
+ }
249
+
250
+ // @public
251
+ export interface PatientInfo {
252
+ birthDate?: Date | string;
253
+ clinicalInfo?: Array<ClinicalCodedElement>;
254
+ sex?: string;
255
+ }
256
+
257
+ // @public
258
+ export interface PatientRecord {
259
+ data?: Array<PatientDocument>;
260
+ id: string;
261
+ info?: PatientInfo;
262
+ }
263
+
264
+ // @public (undocumented)
265
+ export interface Routes {
266
+ (path: "/oncophenotype/jobs/{jobId}", jobId: string): GetJob;
267
+ (path: "/oncophenotype/jobs"): CreateJob;
268
+ }
269
+
270
+ // (No @packageDocumentation comment for this package)
271
+
272
+ ```