Skip to content

UPDATE: add reasoning column and update some docs.#39

Merged
JieZhou000 merged 3 commits intoacs-1230-privatefrom
zhojie/hm-2
Dec 20, 2023
Merged

UPDATE: add reasoning column and update some docs.#39
JieZhou000 merged 3 commits intoacs-1230-privatefrom
zhojie/hm-2

Conversation

@JieZhou000
Copy link
Copy Markdown
Collaborator

Choose a PR Template

Switch to "Preview" on this description then select one of the choices below.

Click here to open a PR for a Data Plane API.

Click here to open a PR for a Control Plane (ARM) API.

#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update"
@added(ContentSafety.Versions.v2023_11_30_Preview)
@doc("domain category.")
@doc("Domain category.")
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest remove the "category" wording here even in description, this will cause a lot of confusion.


@doc("The reason or explanation for identifying the text as ungrounded.")
@doc("The explanation for identifying the text as ungrounded.")
reason: string;
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be optional?

@doc("A value indicating if the output includes an explanation for the identified ungroundedness.")
reasoning?: boolean;

@doc("Connection details for the GPT resource.")
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's better to have a detailed description here that this field will be only valid when reasoning set to true.

groundingSources: string[];

@doc("GPT resource connection information.")
@doc("A value indicating if the output includes an explanation for the identified ungroundedness.")
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Better to give default value here.

@JieZhou000 JieZhou000 merged commit 7ed93a1 into acs-1230-private Dec 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants