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

fix(community): Change airtable API request to use POST #7408

Merged
merged 2 commits into from
Dec 24, 2024
Merged

fix(community): Change airtable API request to use POST #7408

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
71bfe0e
Refactor API request handling to use request body instead of URL para…
eduardconstantin Dec 19, 2024
677926b
Format file
eduardconstantin Dec 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 16 additions & 21 deletions libs/langchain-community/src/document_loaders/web/airtable.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ export interface AirtableRequestParams {
view?: string;
maxRecords?: number;
filterByFormula?: string;
fields?: string[];
}

export interface AirtableLoaderOptions {
Expand Down Expand Up @@ -76,8 +77,8 @@ export class AirtableLoader extends BaseDocumentLoader {

try {
do {
const url = this.constructUrl(offset);
const data = await this.asyncCaller.call(() => this.fetchRecords(url));
const body = this.constructRequestBody(offset);
const data = await this.asyncCaller.call(() => this.fetchRecords(body));
data.records.forEach((record: AirtableRecord) =>
documents.push(this.createDocument(record))
);
Expand All @@ -102,8 +103,8 @@ export class AirtableLoader extends BaseDocumentLoader {
let offset: string | undefined;
try {
do {
const url = this.constructUrl(offset);
const data = await this.asyncCaller.call(() => this.fetchRecords(url));
const body = this.constructRequestBody(offset);
const data = await this.asyncCaller.call(() => this.fetchRecords(body));

for (const record of data.records) {
yield this.createDocument(record);
Expand All @@ -118,37 +119,31 @@ export class AirtableLoader extends BaseDocumentLoader {
}

/**
* Constructs the Airtable API request URL with pagination and query parameters.
* Constructs the request body for an API call.
*
* @param offset - The pagination offset returned by the previous request.
* @returns A fully constructed URL for the API request.
* @param offset - An optional string representing the offset for pagination.
* @returns A record containing the combined properties of `kwargs` and the provided offset.
*/
private constructUrl(offset?: string): string {
const url = new URL(
`${AirtableLoader.BASE_URL}/${this.baseId}/${this.tableId}`
);
if (offset) url.searchParams.append("offset", offset);
if (this.kwargs.view) url.searchParams.append("view", this.kwargs.view);
if (this.kwargs.maxRecords)
url.searchParams.append("maxRecords", this.kwargs.maxRecords.toString());
if (this.kwargs.filterByFormula)
url.searchParams.append("filterByFormula", this.kwargs.filterByFormula);
return url.toString();
}
private constructRequestBody(offset?: string): Record<string, any> { return { ...this.kwargs, offset }; }

/**
* Sends the API request to Airtable and handles the response.
* Includes a timeout to prevent hanging on unresponsive requests.
*
* @param url - The Airtable API request URL.
* @param body - The request payload to be sent to the Airtable API.
* @returns A promise that resolves to an AirtableResponse object.
* @throws Will throw an error if the Airtable API request fails.
*/
private async fetchRecords(url: string): Promise<AirtableResponse> {
private async fetchRecords(body: Record<string, any>): Promise<AirtableResponse> {
const url = `${AirtableLoader.BASE_URL}/${this.baseId}/${this.tableId}`;
try {
const response = await fetch(url, {
method: "POST",
headers: {
Authorization: `Bearer ${this.apiToken}`,
"Content-Type": "application/json"
},
body: JSON.stringify(body)
});

if (!response.ok) {
Expand Down
Loading