Skip to content

Commit 7e8721a

Browse files
JuliakoJuliako
authored
Update customize-brands-model-with-api.md
1 parent dab514d commit 7e8721a

File tree

1 file changed

+121
-3
lines changed

1 file changed

+121
-3
lines changed

‎articles/media-services/video-indexer/customize-brands-model-with-api.md

Lines changed: 121 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,41 +33,159 @@ Some other parameters that you can set in the body:
3333
* The **referenceUrl** value can be any reference websites for the brand such as a link to its Wikipedia page.
3434
* The **tags** value is a list of tags for the brand. This shows up in the brand's *Category* field in the Video Indexer website. For example, the brand "Azure" can be tagged or categorized as "Cloud".
3535

36+
### Response
37+
38+
The response provides information on the brand that you just created following the format of the example below.
39+
40+
```json
41+
{
42+
"referenceUrl": "https://en.wikipedia.org/wiki/Example",
43+
"id": 97974,
44+
"name": "Example",
45+
"accountId": "SampleAccountId",
46+
"lastModifierUserName": "SampleUserName",
47+
"created": "2018-04-25T14:59:52.7433333",
48+
"lastModified": "2018-04-25T14:59:52.7433333",
49+
"enabled": true,
50+
"description": "This is an example",
51+
"tags": [
52+
"Tag1",
53+
"Tag2"
54+
]
55+
}
56+
```
57+
3658
## Delete a Brand
3759

3860
The [delete a brand](https://api-portal.videoindexer.ai/docs/services/operations/operations/Delete-Brand?) API removes a brand from the custom Brands model for the specified account. The account is specified in the **accountId** parameter. Once called successfully, the brand will no longer be in the *Include* or *Exclude* brands lists.
3961

62+
### Response
63+
4064
There is no returned content when the brand is deleted successfully.
4165

4266
## Get a specific Brand
4367

4468
The [get a brand](https://api-portal.videoindexer.ai/docs/services/operations/operations/Get-Brand?) API lets you search for the details of a brand in the custom Brands model for the specified account using the brand id.
4569

46-
If the **enabled** flag is **true**, the brand is included in the *Include* list for Video Indexer to detect. If **enabled** is false, the brand is in the *Exclude* list, so Video Indexer cannot detect it.
70+
### Response
71+
72+
The response provides information on the brand that you searched (using brand ID) following the format of the example below.
73+
74+
```json
75+
{
76+
"referenceUrl": "https://en.wikipedia.org/wiki/Example",
77+
"id": 128846,
78+
"name": "Example",
79+
"accountId": "SampleAccountId",
80+
"lastModifierUserName": "SampleUserName",
81+
"created": "2018-01-06T13:51:38.3666667",
82+
"lastModified": "2018-01-11T13:51:38.3666667",
83+
"enabled": true,
84+
"description": "This is an example",
85+
"tags": [
86+
"Tag1",
87+
"Tag2"
88+
]
89+
}
90+
```
91+
92+
> [!NOTE]
93+
> **enabled** being set to **true** signifies that the brand is in the *Include* list for Video Indexer to detect, and **enabled** being false signifies that the brand is in the *Exclude* list, so Video Indexer will not detect it.
4794
4895
## Update a specific brand
4996

5097
The [update a brand](https://api-portal.videoindexer.ai/docs/services/operations/operations/Update-Brand?) API lets you search for the details of a brand in the custom Brands model for the specified account using the brand ID.
5198

52-
If the **enabled** flag is set to **true**, the brand is included in the *Include* list for Video Indexer to detect. If **enabled** is false, the brand is in the *Exclude* list, so Video Indexer cannot detect it.
99+
### Response
100+
101+
The response provides the updated information on the brand that you updated following the format of the example below.
102+
103+
```json
104+
{
105+
"referenceUrl": null,
106+
"id": 97974,
107+
"name": "Example",
108+
"accountId": "SampleAccountId",
109+
"lastModifierUserName": "SampleUserName",
110+
"Created": "2018-04-25T14:59:52.7433333",
111+
"lastModified": "2018-04-25T15:37:50.67",
112+
"enabled": false,
113+
"description": "This is an update example",
114+
"tags": [
115+
"Tag1",
116+
"NewTag2"
117+
]
118+
}
119+
```
53120

54121
## Get all of the Brands
55122

56123
The [get all brands](https://api-portal.videoindexer.ai/docs/services/operations/operations/Get-Brands?) API returns all of the brands in the custom Brands model for the specified account regardless of whether the brand is meant to be in the *Include* or *Exclude* brands list.
57124

125+
### Response
126+
127+
The response provides a list of all of the brands in your account and each of their details following the format of the example below.
128+
129+
```json
130+
[
131+
{
132+
"ReferenceUrl": null,
133+
"id": 97974,
134+
"name": "Example",
135+
"accountId": "AccountId",
136+
"lastModifierUserName": "UserName",
137+
"Created": "2018-04-25T14:59:52.7433333",
138+
"LastModified": "2018-04-25T14:59:52.7433333",
139+
"enabled": true,
140+
"description": "This is an example",
141+
"tags": ["Tag1", "Tag2"]
142+
},
143+
{
144+
"ReferenceUrl": null,
145+
"id": 97975,
146+
"name": "Example2",
147+
"accountId": "AccountId",
148+
"lastModifierUserName": "UserName",
149+
"Created": "2018-04-26T14:59:52.7433333",
150+
"LastModified": "2018-04-26T14:59:52.7433333",
151+
"enabled": false,
152+
"description": "This is another example",
153+
"tags": ["Tag1", "Tag2"]
154+
},
155+
]
156+
```
157+
158+
> [!NOTE]
159+
> The brand named *Example* is in the *Include* list for Video Indexer to detect, and the brand named *Example2* is in the *Exclude* list, so Video Indexer will not detect it.
160+
58161
## Get Brands model settings
59162

60163
The [get brands settings](https://api-portal.videoindexer.ai/docs/services/operations/operations/Get-Brands) API returns the Brands model settings in the specified account. The Brands model settings represent whether detection from the Bing brands database is enabled or not. If Bing brands are not enabled, Video Indexer will only detect brands from the custom Brands model of the specified account.
61164

165+
### Response
166+
167+
The response shows whether Bing brands are enabled following the format of the example below.
168+
169+
```json
170+
{
171+
"state": true,
172+
"useBuiltIn": true
173+
}
174+
```
175+
62176
> [!NOTE]
63-
> The **useBuiltIn** flag set to true represents that Bing brands are enabled. If *useBuiltin* is false, Bing brands are disabled.
177+
> **useBuiltIn** being set to true represents that Bing brands are enabled. If *useBuiltin* is false, Bing brands are disabled. The **state** value can be ignored as it has been deprecated.
64178
65179
## Update Brands model settings
66180

67181
The [update brands](https://api-portal.videoindexer.ai/docs/services/operations/operations/Update-Brands-Model-Settings?) updates the Brands model settings in the specified account. The Brands model settings represent whether detection from the Bing brands database is enabled or not. If Bing brands are not enabled, Video Indexer will only detect brands from the custom Brands model of the specified account.
68182

69183
The **useBuiltIn** flag set to true represents that Bing brands are enabled. If *useBuiltin* is false, Bing brands are disabled.
70184

185+
### Response
186+
187+
There is no returned content when the Brands model setting is updated successfully.
188+
71189
## Next steps
72190

73191
[Customize Brands model using website](customize-brands-model-with-website.md)

0 commit comments

Comments
 (0)