Skip to content

Commit

Permalink
feat(factchecktools): update the api
Browse files Browse the repository at this point in the history
#### factchecktools:v1alpha1

The following keys were added:
- resources.claims.methods.imageSearch (Total Keys: 18)
- schemas.GoogleFactcheckingFactchecktoolsV1alpha1FactCheckedClaimImageSearchResponse (Total Keys: 8)
  • Loading branch information
yoshi-automation committed Apr 2, 2024
1 parent 22bd656 commit fa34310
Show file tree
Hide file tree
Showing 2 changed files with 135 additions and 1 deletion.
65 changes: 65 additions & 0 deletions docs/dyn/factchecktools_v1alpha1.claims.html
Expand Up @@ -77,6 +77,12 @@ <h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#imageSearch">imageSearch(imageUri=None, languageCode=None, offset=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Search through fact-checked claims using an image as the query.</p>
<p class="toc_element">
<code><a href="#imageSearch_next">imageSearch_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#search">search(languageCode=None, maxAgeDays=None, offset=None, pageSize=None, pageToken=None, query=None, reviewPublisherSiteFilter=None, x__xgafv=None)</a></code></p>
<p class="firstline">Search through fact-checked claims.</p>
Expand All @@ -89,6 +95,65 @@ <h3>Method Details</h3>
<pre>Close httplib2 connections.</pre>
</div>

<div class="method">
<code class="details" id="imageSearch">imageSearch(imageUri=None, languageCode=None, offset=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Search through fact-checked claims using an image as the query.

Args:
imageUri: string, Required. The URI of the source image. This must be a publicly-accessible image HTTP/HTTPS URL. When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DOS prevention), or if Google throttles requests to the site for abuse prevention. You should not depend on externally-hosted images for production applications.
languageCode: string, Optional. The BCP-47 language code, such as &quot;en-US&quot; or &quot;sr-Latn&quot;. Can be used to restrict results by language, though we do not currently consider the region.
offset: integer, Optional. An integer that specifies the current offset (that is, starting result location) in search results. This field is only considered if `page_token` is unset. For example, 0 means to return results starting from the first matching result, and 10 means to return from the 11th result.
pageSize: integer, Optional. The pagination size. We will return up to that many results. Defaults to 10 if not set.
pageToken: string, Optional. The pagination token. You may provide the `next_page_token` returned from a previous List request, if any, in order to get the next page. All other fields must have the same values as in the previous request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response from searching fact-checked claims by image.
&quot;nextPageToken&quot;: &quot;A String&quot;, # The next pagination token in the Search response. It should be used as the `page_token` for the following request. An empty value means no more results.
&quot;results&quot;: [ # The list of claims and all of their associated information.
{ # A claim and its associated information.
&quot;claim&quot;: { # Information about the claim. # A claim which matched the query.
&quot;claimDate&quot;: &quot;A String&quot;, # The date that the claim was made.
&quot;claimReview&quot;: [ # One or more reviews of this claim (namely, a fact-checking article).
{ # Information about a claim review.
&quot;languageCode&quot;: &quot;A String&quot;, # The language this review was written in. For instance, &quot;en&quot; or &quot;de&quot;.
&quot;publisher&quot;: { # Information about the publisher. # The publisher of this claim review.
&quot;name&quot;: &quot;A String&quot;, # The name of this publisher. For instance, &quot;Awesome Fact Checks&quot;.
&quot;site&quot;: &quot;A String&quot;, # Host-level site name, without the protocol or &quot;www&quot; prefix. For instance, &quot;awesomefactchecks.com&quot;. This value of this field is based purely on the claim review URL.
},
&quot;reviewDate&quot;: &quot;A String&quot;, # The date the claim was reviewed.
&quot;textualRating&quot;: &quot;A String&quot;, # Textual rating. For instance, &quot;Mostly false&quot;.
&quot;title&quot;: &quot;A String&quot;, # The title of this claim review, if it can be determined.
&quot;url&quot;: &quot;A String&quot;, # The URL of this claim review.
},
],
&quot;claimant&quot;: &quot;A String&quot;, # A person or organization stating the claim. For instance, &quot;John Doe&quot;.
&quot;text&quot;: &quot;A String&quot;, # The claim text. For instance, &quot;Crime has doubled in the last 2 years.&quot;
},
},
],
}</pre>
</div>

<div class="method">
<code class="details" id="imageSearch_next">imageSearch_next()</code>
<pre>Retrieves the next page of results.

Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)

Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>

<div class="method">
<code class="details" id="search">search(languageCode=None, maxAgeDays=None, offset=None, pageSize=None, pageToken=None, query=None, reviewPublisherSiteFilter=None, x__xgafv=None)</code>
<pre>Search through fact-checked claims.
Expand Down
Expand Up @@ -107,6 +107,46 @@
"resources": {
"claims": {
"methods": {
"imageSearch": {
"description": "Search through fact-checked claims using an image as the query.",
"flatPath": "v1alpha1/claims:imageSearch",
"httpMethod": "GET",
"id": "factchecktools.claims.imageSearch",
"parameterOrder": [],
"parameters": {
"imageUri": {
"description": "Required. The URI of the source image. This must be a publicly-accessible image HTTP/HTTPS URL. When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DOS prevention), or if Google throttles requests to the site for abuse prevention. You should not depend on externally-hosted images for production applications.",
"location": "query",
"type": "string"
},
"languageCode": {
"description": "Optional. The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". Can be used to restrict results by language, though we do not currently consider the region.",
"location": "query",
"type": "string"
},
"offset": {
"description": "Optional. An integer that specifies the current offset (that is, starting result location) in search results. This field is only considered if `page_token` is unset. For example, 0 means to return results starting from the first matching result, and 10 means to return from the 11th result.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageSize": {
"description": "Optional. The pagination size. We will return up to that many results. Defaults to 10 if not set.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The pagination token. You may provide the `next_page_token` returned from a previous List request, if any, in order to get the next page. All other fields must have the same values as in the previous request.",
"location": "query",
"type": "string"
}
},
"path": "v1alpha1/claims:imageSearch",
"response": {
"$ref": "GoogleFactcheckingFactchecktoolsV1alpha1FactCheckedClaimImageSearchResponse"
}
},
"search": {
"description": "Search through fact-checked claims.",
"flatPath": "v1alpha1/claims:search",
Expand Down Expand Up @@ -304,7 +344,7 @@
}
}
},
"revision": "20240324",
"revision": "20240331",
"rootUrl": "https://factchecktools.googleapis.com/",
"schemas": {
"GoogleFactcheckingFactchecktoolsV1alpha1Claim": {
Expand Down Expand Up @@ -514,6 +554,35 @@
},
"type": "object"
},
"GoogleFactcheckingFactchecktoolsV1alpha1FactCheckedClaimImageSearchResponse": {
"description": "Response from searching fact-checked claims by image.",
"id": "GoogleFactcheckingFactchecktoolsV1alpha1FactCheckedClaimImageSearchResponse",
"properties": {
"nextPageToken": {
"description": "The next pagination token in the Search response. It should be used as the `page_token` for the following request. An empty value means no more results.",
"type": "string"
},
"results": {
"description": "The list of claims and all of their associated information.",
"items": {
"$ref": "GoogleFactcheckingFactchecktoolsV1alpha1FactCheckedClaimImageSearchResponseResult"
},
"type": "array"
}
},
"type": "object"
},
"GoogleFactcheckingFactchecktoolsV1alpha1FactCheckedClaimImageSearchResponseResult": {
"description": "A claim and its associated information.",
"id": "GoogleFactcheckingFactchecktoolsV1alpha1FactCheckedClaimImageSearchResponseResult",
"properties": {
"claim": {
"$ref": "GoogleFactcheckingFactchecktoolsV1alpha1Claim",
"description": "A claim which matched the query."
}
},
"type": "object"
},
"GoogleFactcheckingFactchecktoolsV1alpha1FactCheckedClaimSearchResponse": {
"description": "Response from searching fact-checked claims.",
"id": "GoogleFactcheckingFactchecktoolsV1alpha1FactCheckedClaimSearchResponse",
Expand Down

0 comments on commit fa34310

Please sign in to comment.