-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Human Review Client Endpoints #211
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@@ -1,4 +1,4 @@ | ||||||||||||||||||||||||||
import type { TimeDelta } from './types'; | ||||||||||||||||||||||||||
import type { HumanReviewFieldContentType, TimeDelta } from './types'; | ||||||||||||||||||||||||||
import { | ||||||||||||||||||||||||||
convertTimeDeltaToMilliSeconds, | ||||||||||||||||||||||||||
readEnv, | ||||||||||||||||||||||||||
|
@@ -69,6 +69,59 @@ export enum SystemEventFilterKey { | |||||||||||||||||||||||||
LABEL = 'SYSTEM:label', | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
export interface HumanReviewJob { | ||||||||||||||||||||||||||
id: string; | ||||||||||||||||||||||||||
name: string; | ||||||||||||||||||||||||||
reviewer: { id: string; email: string }; | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
export interface HumanReviewJobWithTestCases extends HumanReviewJob { | ||||||||||||||||||||||||||
testCases: { id: string; status: 'Submitted' | 'Pending' }[]; | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
export interface HumanReviewJobTestCaseResult { | ||||||||||||||||||||||||||
id: string; | ||||||||||||||||||||||||||
reviewerEmail: string; | ||||||||||||||||||||||||||
status: 'Submitted' | 'Pending'; | ||||||||||||||||||||||||||
grades: { name: string; grade: number }[]; | ||||||||||||||||||||||||||
automatedEvaluations: { | ||||||||||||||||||||||||||
id: string; | ||||||||||||||||||||||||||
originalScore: number; | ||||||||||||||||||||||||||
overrideScore: number; | ||||||||||||||||||||||||||
overrideReason?: string; | ||||||||||||||||||||||||||
}[]; | ||||||||||||||||||||||||||
inputFields: { | ||||||||||||||||||||||||||
id: string; | ||||||||||||||||||||||||||
name: string; | ||||||||||||||||||||||||||
value: string; | ||||||||||||||||||||||||||
contentType: HumanReviewFieldContentType; | ||||||||||||||||||||||||||
}[]; | ||||||||||||||||||||||||||
outputFields: { | ||||||||||||||||||||||||||
id: string; | ||||||||||||||||||||||||||
name: string; | ||||||||||||||||||||||||||
value: string; | ||||||||||||||||||||||||||
contentType: HumanReviewFieldContentType; | ||||||||||||||||||||||||||
}[]; | ||||||||||||||||||||||||||
fieldComments: { | ||||||||||||||||||||||||||
fieldId: string; | ||||||||||||||||||||||||||
startIdx?: number; | ||||||||||||||||||||||||||
endIdx?: number; | ||||||||||||||||||||||||||
value: string; | ||||||||||||||||||||||||||
inRelationToGradeName?: string; | ||||||||||||||||||||||||||
inRelationToAutomatedEvaluationId?: string; | ||||||||||||||||||||||||||
}[]; | ||||||||||||||||||||||||||
inputComments: { | ||||||||||||||||||||||||||
value: string; | ||||||||||||||||||||||||||
inRelationToGradeName?: string; | ||||||||||||||||||||||||||
inRelationToAutomatedEvaluationId?: string; | ||||||||||||||||||||||||||
}[]; | ||||||||||||||||||||||||||
outputComments: { | ||||||||||||||||||||||||||
value: string; | ||||||||||||||||||||||||||
inRelationToGradeName?: string; | ||||||||||||||||||||||||||
inRelationToAutomatedEvaluationId?: string; | ||||||||||||||||||||||||||
}[]; | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
interface ClientArgs { | ||||||||||||||||||||||||||
apiKey?: string; | ||||||||||||||||||||||||||
timeout?: TimeDelta; | ||||||||||||||||||||||||||
|
@@ -175,4 +228,21 @@ export class AutoblocksAPIClient { | |||||||||||||||||||||||||
}): Promise<{ testCases: ManagedTestCase<T>[] }> { | ||||||||||||||||||||||||||
return this.get(`/test-suites/${args.testSuiteId}/test-cases`); | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
public async getHumanReviewJobs(): Promise<{ jobs: HumanReviewJob[] }> { | ||||||||||||||||||||||||||
return this.get('/human-review/jobs'); | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
Comment on lines
+234
to
+236
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Consider consistent return types for methods The For consistency, consider returning |
||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
public async getHumanReviewJobTestCases( | ||||||||||||||||||||||||||
jobId: string, | ||||||||||||||||||||||||||
): Promise<HumanReviewJobWithTestCases> { | ||||||||||||||||||||||||||
return this.get(`/human-review/jobs/${jobId}/test-cases`); | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ensure proper encoding of When constructing the URL in Apply this diff to encode the - return this.get(`/human-review/jobs/${jobId}/test-cases`);
+ return this.get(`/human-review/jobs/${encodeURIComponent(jobId)}/test-cases`); Committable suggestion
Suggested change
|
||||||||||||||||||||||||||
|
||||||||||||||||||||||||||
public async getHumanReviewJobTestCaseResult( | ||||||||||||||||||||||||||
jobId: string, | ||||||||||||||||||||||||||
testCaseId: string, | ||||||||||||||||||||||||||
): Promise<HumanReviewJobTestCaseResult> { | ||||||||||||||||||||||||||
return this.get(`/human-review/jobs/${jobId}/test-cases/${testCaseId}`); | ||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add unit tests for new API methods Consider adding unit tests for the newly added methods to ensure they function correctly and handle potential errors. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ensure proper encoding of In Apply this diff to encode the parameters: - return this.get(`/human-review/jobs/${jobId}/test-cases/${testCaseId}`);
+ return this.get(`/human-review/jobs/${encodeURIComponent(jobId)}/test-cases/${encodeURIComponent(testCaseId)}`); Committable suggestion
Suggested change
|
||||||||||||||||||||||||||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,12 @@ | ||
export { AutoblocksTracer, flush } from './tracer'; | ||
export { AutoblocksAPIClient, SystemEventFilterKey } from './client'; | ||
export { dedent } from './util'; | ||
export type { View, Event, Trace } from './client'; | ||
export type { TimeDelta } from './types'; | ||
export type { | ||
View, | ||
Event, | ||
Trace, | ||
HumanReviewJob, | ||
HumanReviewJobWithTestCases, | ||
HumanReviewJobTestCaseResult, | ||
} from './client'; | ||
export type { TimeDelta, HumanReviewFieldContentType } from './types'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Inconsistent representation of reviewer information
In
HumanReviewJob
, the reviewer is represented as an object withid
andemail
:However, in
HumanReviewJobTestCaseResult
, the reviewer is represented by a singlereviewerEmail
string property:For consistency and future extensibility, consider representing the reviewer in
HumanReviewJobTestCaseResult
as an object similar toHumanReviewJob
.