Skip to content
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.

Sign up for GitHub

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

Jump to bottom

New command: m365 spp model get #6105

Open
Tracked by #6074
mkm17 opened this issue Jun 28, 2024 · 11 comments · May be fixed by #6409
Open
Tracked by #6074

New command: m365 spp model get #6105

mkm17 opened this issue Jun 28, 2024 · 11 comments · May be fixed by #6409
Assignees
@mkm17
Labels
feature request good first issue hacktoberfest Issue perfect for hacktoberfest work in progress

Comments

@mkm17
Copy link
Contributor

mkm17 commented Jun 28, 2024 •
edited
Loading

Usage

m365 spp model get [options]

Description

Retrieve information about a SharePoint Premium document understanding model

Options

Option Description
-u, --siteUrl <siteUrl> The URL of the content center site.
-i, --id [id] The unique ID of the model to retrieve. Specify id or title but not both.
-t, --title [title] The display name (case-sensitive) of the model to retrieve. Specify id or title but not both.
--listPublications Retrieves information about the library where it has been applied.

Examples

Retrieve information about a SharePoint Premium document understanding model, using model UniqueId

m365 spp model get --siteUrl "https://contoso.sharepoint.com/sites/ContentCenter" --id "7645e69d-21fb-4a24-a17a-9bdfa7cb63dc"

Retrieve information about a SharePoint Premium document understanding model, using model Title

m365 spp model get --siteUrl "https://contoso.sharepoint.com/sites/ContentCenter" --title "climicrosoft365Model"

Additional Info

Endpoints to be used-
https://learn.microsoft.com/en-us/sharepoint/dev/apis/syntex/rest-getbyuniqueid-method
https://learn.microsoft.com/en-us/sharepoint/dev/apis/syntex/rest-getbytitle-method
@mkm17 mkm17 mentioned this issue Jun 28, 2024
Open
11 tasks
@Adam-it Adam-it added needs peer review Needs second pair of eyes to review the spec or PR feature request labels Jul 5, 2024
@Adam-it
Copy link
Contributor

Adam-it commented Jul 5, 2024

I think usually for the get we do not specify the Default properties and just return everything as it returns a single item.
LGTM 👍
@pnp/cli-for-microsoft-365-maintainers anyone? anything? anytime? 😉 before we open it up 😊

@Adam-it
Copy link
Contributor

Adam-it commented Jul 5, 2024

@mkm17 maybe one comment I though of just now. Wont it be more aligned with what we have in CLI to specify the modelUniqueId as id not uniqueId ?

@mkm17
Copy link
Contributor Author

mkm17 commented Jul 5, 2024 •
edited
Loading

@Adam-it
I saw that in results of syntex endpoints there are sometimes both properties provided. I didn't want to make a confusion that in one command you get id and uniqueId and in the second one you have to use uniqueId as id.
But let me double check it because maybe we should simply return only uniqueId as Id in all cases.

@mkm17
Copy link
Contributor Author

mkm17 commented Jul 9, 2024

@Adam-it ok, in this case and others related to Syntex, I will change to id, but in the description, I will leave information that the unique ID is needed. Would that be ok?

@Adam-it
Copy link
Contributor

Adam-it commented Jul 9, 2024

yes that works for me

@mkm17 mkm17 changed the title New command: m365 spo stx model get New command: m365 spo premium model get Jul 9, 2024
@Jwaegebaert
Copy link
Contributor

Another nice job with speccing this out @mkm17! A bit similar to at spo premium contentcenter list, let's replace all the occurrences of Syntex with SharePoint Premium. For the option description at --siteUrl, here we also need to change content centre to content center. This typo also appears in the examples.

On smaller detail, in your examples, there are two spaces between your command and the first option. get --siteUrl

@mkm17
Copy link
Contributor Author

mkm17 commented Jul 12, 2024

@Jwaegebaert same here, all proposed changes applied :)

@Jwaegebaert
Copy link
Contributor

Nice, let's wait a bit regarding the naming for the command and then we can open it up. Do you want to work on this one, or open it up?

@mkm17 mkm17 changed the title New command: m365 spo premium model get New command: m365 spp model get Jul 16, 2024
@Adam-it
Copy link
Contributor

Adam-it commented Jul 23, 2024

@mkm17 awesome work 👏. Lets get this 🚢ed

@Adam-it Adam-it added help wanted good first issue and removed needs peer review Needs second pair of eyes to review the spec or PR labels Jul 23, 2024
@mkm17
Copy link
Contributor Author

mkm17 commented Jul 28, 2024

I can take also this one ;)

@Adam-it Adam-it added the hacktoberfest Issue perfect for hacktoberfest label Sep 24, 2024
@Adam-it
Copy link
Contributor

Adam-it commented Sep 24, 2024

hi @mkm17,
This issue will take part in the Hacktoberfest event which will take part during October.
You may read more about this event here:
#6383

If you want to participate and make this PR count towards this event please be sure to open the PR in October (no sooner and no later 😉)

mkm17 added a commit to mkm17/cli-microsoft365 that referenced this issue Sep 30, 2024
@mkm17
Adds spp model get command closes pnp#6105
67eb28e
mkm17 added a commit to mkm17/cli-microsoft365 that referenced this issue Oct 6, 2024
@mkm17
Adds spp model get command closes pnp#6105
a7569cd
mkm17 added a commit to mkm17/cli-microsoft365 that referenced this issue Oct 6, 2024
@mkm17
Adds spp model get command closes pnp#6105
4e27dc2
@mkm17 mkm17 linked a pull request Oct 6, 2024 that will close this issue
Open
mkm17 added a commit to mkm17/cli-microsoft365 that referenced this issue Oct 13, 2024
@mkm17
Adds spp model get command closes pnp#6105
13ca6fd
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mkm17 mkm17

Labels
feature request good first issue hacktoberfest Issue perfect for hacktoberfest work in progress
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Adds spp model get command Closes #6105 mkm17/cli-microsoft365
3 participants
@mkm17 @Jwaegebaert @Adam-it